org.eclipse.persistence.jpa.jpql.tools.resolver

Class FromSubqueryResolver.VirtualMapping

java.lang.Object

org.eclipse.persistence.jpa.jpql.tools.resolver.FromSubqueryResolver.VirtualMapping

All Implemented Interfaces:

java.lang.Comparable<IMapping>, IMapping

Enclosing class:

FromSubqueryResolver

protected class FromSubqueryResolver.VirtualMapping
extends java.lang.Object
implements IMapping

This virtual IMapping wraps one of the select items.

Property Summary

Properties

Type	Property and Description
boolean	is Determines whether this IMapping is a property type mapping.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FromSubqueryResolver.VirtualMapping(IManagedType parent, java.lang.String name, Resolver resolver, org.eclipse.persistence.jpa.jpql.tools.resolver.FromSubqueryResolver.MappingType mappingType)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(IMapping mapping)
int	getMappingType() Returns the type of this mapping.
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	hasAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType) Determines whether the given annotation is present on this type.
boolean	isCollection() Determines whether this IMapping is a collection type mapping.
boolean	isProperty() Determines whether this IMapping is a property type mapping.
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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Property Detail

is

Determines whether this IMapping is a property type mapping.

Specified by:

isProperty in interface IMapping

Returns:

true if this IMapping is a property mapping; false otherwise

Constructor Detail

FromSubqueryResolver.VirtualMapping

protected FromSubqueryResolver.VirtualMapping(IManagedType parent,
                                   java.lang.String name,
                                   Resolver resolver,
                                   org.eclipse.persistence.jpa.jpql.tools.resolver.FromSubqueryResolver.MappingType mappingType)

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

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

hasAnnotation

public boolean hasAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)

Determines whether the given annotation is present on this type.

Specified by:

hasAnnotation in interface IMapping

Parameters:

annotationType - The class of the annotation

Returns:

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

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()

Determines whether this IMapping is a property type mapping.

Specified by:

isProperty in interface IMapping

Returns:

true if this IMapping is a property mapping; false otherwise

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