EclipseLink Hermes Parser 4.0.2 · org.eclipse.persistence.jpa.jpql.tools.spi.IMapping

Method Summary

Modifier and Type	Method and Description
public int	Returns: One of the supported mapping type, which is one of the constants defined in `IMappingType` when the provider only supports generic JPA getMappingType() Returns the type of this mapping.
public String	Returns: The name of this mapping getName() Returns the name of the persistence property represented by this mapping.
public IManagedType	Returns: The parent of this mapping getParent() Returns the parent managed type owning this mapping.
public IType	Returns: The external form representing the type of this mapping getType() Returns the type of this mapping.
public ITypeDeclaration	Returns: The external form of the class' type declaration 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.
public boolean	Returns: `true` if the annotation is defined on this type; `false` otherwise hasAnnotation(Class<? extends Annotation> The class of the annotation annotationType) Determines whether the given annotation is present on this type.
public boolean	Returns: `true` if this `IMapping` is a collection mapping; `false` otherwise isCollection() Determines whether this `IMapping` is a collection type mapping.
public boolean	Returns: `true` if this `IMapping` is an embeddable mapping; `false` otherwise isEmbeddable() Determines whether this `IMapping` is an embeddable type mapping.
public boolean	Returns: `true` if this `IMapping` is a property mapping; `false` otherwise isProperty() Determines whether this `IMapping` is a property type mapping.
public boolean	Returns: `true` if this `IMapping` is a relationship mapping; `false` otherwise isRelationship() Determines whether this `IMapping` is a relationship type mapping.
public boolean	Returns: `true` if this `IMapping` is a transient mapping; `false` otherwise isTransient() Determines whether this `IMapping` is a transient mapping.

Inherited from java.lang.Comparable:: compareTo

Method Detail

getMappingType back to summary

getMappingType	back to summary
public int getMappingType() Returns the type of this mapping. Returns:int One of the supported mapping type, which is one of the constants defined in `IMappingType` when the provider only supports generic JPA

public int getMappingType()

Returns the type of this mapping.

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

getName	back to summary
public String getName() Returns the name of the persistence property represented by this mapping. Returns:String The name of this mapping

getName

back to summary

public String getName()

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

Returns:String: The name of this mapping

getParent	back to summary
public IManagedType getParent() Returns the parent managed type owning this mapping. Returns:IManagedType The parent of this mapping

getParent

back to summary

public IManagedType getParent()

Returns the parent managed type owning this mapping.

Returns:IManagedType: The parent of this mapping

getType back to summary

getType	back to summary
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 `java.util.Collection`, `getTypeDeclaration()` needs to be used, its type will be `java.util.Collection` and it's generic type will be `Employee`. Returns:IType The external form representing the type of this mapping

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 java.util.Collection, getTypeDeclaration() needs to be used, its type will be java.util.Collection and it's generic type will be Employee.

Returns:IType: The external form representing the type of this mapping

getTypeDeclaration back to summary

getTypeDeclaration	back to summary
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. Returns:ITypeDeclaration The external form of the class' type declaration

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.

Returns:ITypeDeclaration: The external form of the class' type declaration

hasAnnotation back to summary

hasAnnotation	back to summary
public boolean hasAnnotation(Class<? extends Annotation> annotationType) Determines whether the given annotation is present on this type. Parameters annotationType:Class<? extends Annotation> The class of the annotation Returns:boolean `true` if the annotation is defined on this type; `false` otherwise

public boolean hasAnnotation(Class<? extends Annotation> annotationType)

Determines whether the given annotation is present on this type.

Parameters

annotationType:Class<? extends Annotation>: The class of the annotation

Returns:boolean

true if the annotation is defined on this type; false otherwise

isCollection back to summary

isCollection	back to summary
public boolean isCollection() Determines whether this `IMapping` is a collection type mapping. Returns:boolean `true` if this `IMapping` is a collection mapping; `false` otherwise Since 2.4

public boolean isCollection()

Determines whether this IMapping is a collection type mapping.

Returns:boolean: true if this IMapping is a collection mapping; false otherwise
Since: 2.4

isEmbeddable back to summary

isEmbeddable	back to summary
public boolean isEmbeddable() Determines whether this `IMapping` is an embeddable type mapping. Returns:boolean `true` if this `IMapping` is an embeddable mapping; `false` otherwise Since 2.4

public boolean isEmbeddable()

Determines whether this IMapping is an embeddable type mapping.

Returns:boolean: true if this IMapping is an embeddable mapping; false otherwise
Since: 2.4

isProperty back to summary

isProperty	back to summary
public boolean isProperty() Determines whether this `IMapping` is a property type mapping. Returns:boolean `true` if this `IMapping` is a property mapping; `false` otherwise Since 2.4

public boolean isProperty()

Determines whether this IMapping is a property type mapping.

Returns:boolean: true if this IMapping is a property mapping; false otherwise
Since: 2.4

isRelationship back to summary

isRelationship	back to summary
public boolean isRelationship() Determines whether this `IMapping` is a relationship type mapping. Returns:boolean `true` if this `IMapping` is a relationship mapping; `false` otherwise Since 2.4

public boolean isRelationship()

Determines whether this IMapping is a relationship type mapping.

Returns:boolean: true if this IMapping is a relationship mapping; false otherwise
Since: 2.4

isTransient back to summary

isTransient	back to summary
public boolean isTransient() Determines whether this `IMapping` is a transient mapping. Returns:boolean `true` if this `IMapping` is a transient mapping; `false` otherwise Since 2.4

public boolean isTransient()

Determines whether this IMapping is a transient mapping.

Returns:boolean: true if this IMapping is a transient mapping; false otherwise
Since: 2.4

public Interface IMapping

Method Summary

Method Detail