org.eclipse.persistence.jpa.jpql.spi.java

Class AbstractMapping

java.lang.Object

org.eclipse.persistence.jpa.jpql.spi.java.AbstractMapping

All Implemented Interfaces:

java.lang.Comparable<IMapping>, IMapping

Direct Known Subclasses:

AbstractFieldMapping, AbstractMethodMapping

public abstract class AbstractMapping
extends java.lang.Object
implements IMapping

The abstract implementation of IMapping that is wrapping the runtime representation of a persistent attribute.

Since:

2.4

Version:

2.4

Author:

Pascal Filion

Property Summary

Type	Property and Description
boolean	is Gets the value of the property property.

Method Summary

Modifier and Type	Method and Description
int	compareTo(IMapping mapping)
int	getMappingType() Returns the type of this mapping.
java.lang.reflect.Member	getMember() Returns the Java Member wrapped by this mapping, which represents a persistent attribute.
java.lang.String	getName() Returns the name of the persistence property represented by this mapping.
IManagedType	getParent() Returns the parent managed type owning this mapping.
IType	getType() Returns the type of this mapping.
ITypeDeclaration	getTypeDeclaration() Returns the declaration of the Java class, which gives the information about type parameters, dimensionality, etc.
boolean	isCollection() Determines whether this IMapping is a collection type mapping.
boolean	isProperty() Gets the value of the property property.
boolean	isRelationship() Determines whether this IMapping is a relationship type mapping.
boolean	isTransient() Determines whether this IMapping is a transient mapping.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.persistence.jpa.jpql.spi.IMapping

hasAnnotation

Property Detail

is

public boolean isProperty

Gets the value of the property property.

Specified by:

isProperty in interface IMapping

Method Detail

compareTo

public int compareTo(IMapping mapping)

Specified by:

compareTo in interface java.lang.Comparable<IMapping>

getMappingType

public int getMappingType()

Returns the type of this mapping.

Specified by:

getMappingType in interface IMapping

Returns:

One of the supported mapping type, which is one of the constants defined in IMappingType when the provider only supports generic JPA

getMember

public java.lang.reflect.Member getMember()

Returns the Java Member wrapped by this mapping, which represents a persistent attribute.

Returns:

The Java Member

getName

public java.lang.String getName()

Returns the name of the persistence property represented by this mapping.

Specified by:

getName in interface IMapping

Returns:

The name of this mapping

getParent

public IManagedType getParent()

Returns the parent managed type owning this mapping.

Specified by:

getParent in interface IMapping

Returns:

The parent of this mapping

getType

public IType getType()

Returns the type of this mapping. If this mapping is a relationship mapping, the parameter type of the collection is returned.

@OneToMany
private Collection<Employee> employees;

"Employee" is the type. To retrieve Collection, IMapping.getTypeDeclaration() needs to be used, its type will be Collection and it's generic type will be Employee.

Specified by:

getType in interface IMapping

Returns:

The external form representing the type of this mapping

getTypeDeclaration

public ITypeDeclaration getTypeDeclaration()

Returns the declaration of the Java class, which gives the information about type parameters, dimensionality, etc.

@OneToMany
private Collection<Employee> employees;

"Collection<Employee>" is the type declaration.

Specified by:

getTypeDeclaration in interface IMapping

Returns:

The external form of the class' type declaration

isCollection

public boolean isCollection()

Determines whether this IMapping is a collection type mapping.

Specified by:

isCollection in interface IMapping

Returns:

true if this IMapping is a collection mapping; false otherwise

isProperty

public boolean isProperty()

Gets the value of the property property.

Specified by:

isProperty in interface IMapping

isRelationship

public boolean isRelationship()

Determines whether this IMapping is a relationship type mapping.

Specified by:

isRelationship in interface IMapping

Returns:

true if this IMapping is a relationship mapping; false otherwise

isTransient

public boolean isTransient()

Determines whether this IMapping is a transient mapping.

Specified by:

isTransient in interface IMapping

Returns:

true if this IMapping is a transient mapping; false otherwise

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object