|
EclipseLink 2.4.1, build 'v20121003-ad44345' API Reference | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.eclipse.persistence.jpa.jpql.Resolver
public abstract class Resolver
A Resolver is responsible to resolve a property by retrieving either the managed
type, the mapping, the type and the type declaration depending on the type of resolver.
Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.
| Constructor Summary | |
|---|---|
protected |
Resolver(Resolver parent)
Creates a new Resolver. |
| Method Summary | |
|---|---|
abstract void |
accept(ResolverVisitor visitor)
Visits this Resolver by the given visitor. |
protected void |
addChild(java.lang.String variableName,
Resolver resolver)
Caches the given Resolver. |
protected IType |
buildType()
Resolves the IType of the property handled by this Resolver. |
protected abstract ITypeDeclaration |
buildTypeDeclaration()
Resolves the ITypeDeclaration of the property handled by this Resolver. |
protected void |
checkParent(Resolver parent)
|
protected Resolver |
getChild(java.lang.String variableName)
Retrieves the child of this Resolver that has the given variable name. |
IManagedType |
getManagedType()
Returns the IManagedType associated with the field handled by this Resolver. |
IMapping |
getMapping()
Returns the IMapping for the wrapped field. |
Resolver |
getParent()
Returns the parent of this Resolver. |
protected IManagedType |
getParentManagedType()
Returns the managed type of the parent resolver. |
protected IMapping |
getParentMapping()
Returns the IMapping of the parent resolver. |
protected IType |
getParentType()
Returns the type of the parent resolver. |
protected ITypeDeclaration |
getParentTypeDeclaration()
Returns the type declaration of the parent resolver. |
protected IManagedTypeProvider |
getProvider()
Returns the provider of managed types. |
protected IQuery |
getQuery()
Returns the external form representing the JPQL query. |
IType |
getType()
Returns the IType of the field handled by this Resolver. |
protected IType |
getType(java.lang.Class<?> type)
Returns the IType of the given Java type. |
protected IType |
getType(java.lang.String typeName)
Retrieves the external class for the given fully qualified class name. |
protected ITypeDeclaration |
getTypeDeclaration()
Returns the ITypeDeclaration of the field handled by this Resolver. |
protected TypeHelper |
getTypeHelper()
Returns a helper that gives access to the most common types. |
protected ITypeRepository |
getTypeRepository()
Returns the type repository for the application. |
boolean |
isNullAllowed()
Determines whether the Expression
to be created, which wraps the attribute or query key name allows the target of the 1:1
relationship to be null if there is no corresponding relationship in the database. |
void |
setNullAllowed(boolean nullAllowed)
Sets whether the Expression to be
created, which wraps the attribute or query key name allows the target of the 1:1 relationship
to be null if there is no corresponding relationship in the database. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
protected Resolver(Resolver parent)
Resolver.
parent - The parent of this resolver, which is never null
java.lang.NullPointerException - If the parent is null| Method Detail |
|---|
public abstract void accept(ResolverVisitor visitor)
Resolver by the given visitor.
visitor - The visitor to visit this object
protected final void addChild(java.lang.String variableName,
Resolver resolver)
Resolver.
variableName - The key used to cache the given Resolverresolver - The Resolver to cacheprotected IType buildType()
IType of the property handled by this Resolver.
IType that was resolved by this Resolver or the IType for IType.UNRESOLVABLE_TYPE if it could not be resolvedprotected abstract ITypeDeclaration buildTypeDeclaration()
ITypeDeclaration of the property handled by this Resolver.
ITypeDeclaration that was resolved by this Resolver or the
ITypeDeclaration for IType.UNRESOLVABLE_TYPE if it could not be resolvedprotected void checkParent(Resolver parent)
protected final Resolver getChild(java.lang.String variableName)
Resolver that has the given variable name.
variableName - The name of the property that was cached
Resolver mapped with the given property name; otherwise nullpublic IManagedType getManagedType()
IManagedType associated with the field handled by this Resolver.
If this Resolver does not handle a field that has a IManagedType, then
null should be returned.
For example: "SELECT e FROM Employee e", the Resolver for
e would be returning the IManagedType for Employee.
IManagedType, if it could be resolved; null otherwisepublic IMapping getMapping()
IMapping for the wrapped field.
IMapping or null if none existspublic Resolver getParent()
Resolver.
Resolverprotected final IManagedType getParentManagedType()
protected final IMapping getParentMapping()
IMapping of the parent resolver.
IMapping of the parent resolverprotected final IType getParentType()
protected final ITypeDeclaration getParentTypeDeclaration()
protected final IManagedTypeProvider getProvider()
protected IQuery getQuery()
public final IType getType()
IType of the field handled by this Resolver.
IType that was resolved by this Resolver or the IType
for IType.UNRESOLVABLE_TYPE if it could not be resolvedprotected final IType getType(java.lang.Class<?> type)
IType of the given Java type.
type - The Java type for which its external form will be returned
IType representing the given Java typeprotected final IType getType(java.lang.String typeName)
typeName - The fully qualified class name of the class to retrieve
protected final ITypeDeclaration getTypeDeclaration()
ITypeDeclaration of the field handled by this Resolver.
ITypeDeclaration that was resolved by this Resolver or the
ITypeDeclaration for IType.UNRESOLVABLE_TYPE if it could not be resolvedprotected final TypeHelper getTypeHelper()
types.
ITypeprotected final ITypeRepository getTypeRepository()
ITypespublic boolean isNullAllowed()
Expression
to be created, which wraps the attribute or query key name allows the target of the 1:1
relationship to be null if there is no corresponding relationship in the database.
true to allow null if the corresponding relationship in the
database does not exists; false otherwisepublic void setNullAllowed(boolean nullAllowed)
Expression to be
created, which wraps the attribute or query key name allows the target of the 1:1 relationship
to be null if there is no corresponding relationship in the database.
nullAllowed - true to allow null if the corresponding
relationship in the database does not exists; false otherwise
|
EclipseLink 2.4.1, build 'v20121003-ad44345' API Reference | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||