EclipseLink Hermes Parser 4.0.2 · org.eclipse.persistence.jpa.jpql.tools.resolver.Resolver

Modifier and Type	Field and Description
private boolean	nullAllowed This is only applicable to 1:1 relationships, and allows the target of the relationship to be `null` if there is no corresponding relationship in the database.
private final Resolver	parent The parent of this resolver, which is never `null`.
private Map<String, Resolver>	resolvers The cached `Resolvers` mapped with a variable name.
private IType	type The cached `IType` of the value to resolve.
private ITypeDeclaration	typeDeclaration The cached `ITypeDeclaration` of the value to resolve.

Access	Constructor and Description
protected	Resolver(Resolver The parent of this resolver, which is never `null` parent) Creates a new `Resolver`.

Method Summary

Modifier and Type	Method and Description
public final void	addChild(String The key used to cache the given `Resolver` variableName, Resolver The `Resolver` to cache resolver) Caches the given `Resolver`.
protected IType	Returns: Either the `IType` that was resolved by this `Resolver` or the `IType` for `IType#UNRESOLVABLE_TYPE` if it could not be resolved buildType() Resolves the `IType` of the property handled by this `Resolver`.
protected abstract ITypeDeclaration	Returns: Either the `ITypeDeclaration` that was resolved by this `Resolver` or the `ITypeDeclaration` for `IType#UNRESOLVABLE_TYPE` if it could not be resolved buildTypeDeclaration() Resolves the `ITypeDeclaration` of the property handled by this `Resolver`.
protected void	checkParent(Resolver parent)
public final Resolver	Returns: The cached `Resolver` mapped with the given property name; otherwise `null` getChild(String The name of the property that was cached variableName) Retrieves the child of this `Resolver` that has the given variable name.
public IManagedType	Returns: Either the `IManagedType`, if it could be resolved; `null` otherwise getManagedType() Returns the `IManagedType` associated with the field handled by this `Resolver`.
public IMapping	Returns: Either the `IMapping` or `null` if none exists getMapping() Returns the `IMapping` for the wrapped field.
public Resolver	Returns: The parent of this `Resolver` getParent() Returns the parent of this `Resolver`.
public final IManagedType	Returns: The managed type of the parent resolver getParentManagedType() Returns the managed type of the parent resolver.
public final IMapping	Returns: The `IMapping` of the parent resolver getParentMapping() Returns the `IMapping` of the parent resolver.
public final IType	Returns: The type of the parent resolver getParentType() Returns the type of the parent resolver.
public final ITypeDeclaration	Returns: The type declaration of the parent resolver getParentTypeDeclaration() Returns the type declaration of the parent resolver.
public final IManagedTypeProvider	Returns: The container holding the managed types getProvider() Returns the provider of managed types.
public IQuery	Returns: The external form of the JPQL query getQuery() Returns the external form representing the JPQL query.
public final IType	Returns: Either the `IType` that was resolved by this `Resolver` or the `IType` for `IType#UNRESOLVABLE_TYPE` if it could not be resolved getType() Returns the `IType` of the field handled by this `Resolver`.
public final IType	Returns: The `IType` representing the given Java type getType(Class<?> The Java type for which its external form will be returned type) Returns the `IType` of the given Java type.
public final IType	Returns: The external form of the class to retrieve getType(String The fully qualified class name of the class to retrieve typeName) Retrieves the external class for the given fully qualified class name.
public final ITypeDeclaration	Returns: Either the `ITypeDeclaration` that was resolved by this `Resolver` or the `ITypeDeclaration` for `IType#UNRESOLVABLE_TYPE` if it could not be resolved getTypeDeclaration() Returns the `ITypeDeclaration` of the field handled by this `Resolver`.
public final TypeHelper	Returns: A helper containing a collection of methods related to `IType` getTypeHelper() Returns a helper that gives access to the most common `types`.
public final ITypeRepository	Returns: The repository of `ITypes` getTypeRepository() Returns the type repository for the application.
public boolean	Returns: `true` to allow `null` if the corresponding relationship in the database does not exists; `false` otherwise 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.
public void	setNullAllowed(boolean `true` to allow `null` if the corresponding relationship in the database does not exists; `false` otherwise 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.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

nullAllowed	back to summary
private boolean nullAllowed This is only applicable to 1:1 relationships, and allows the target of the relationship to be `null` if there is no corresponding relationship in the database.

parent	back to summary
private final Resolver parent The parent of this resolver, which is never `null`.

resolvers	back to summary
private Map<String, Resolver> resolvers The cached `Resolvers` mapped with a variable name.

type	back to summary
private IType type The cached `IType` of the value to resolve.

typeDeclaration	back to summary
private ITypeDeclaration typeDeclaration The cached `ITypeDeclaration` of the value to resolve.

Resolver	back to summary
protected Resolver(Resolver parent) Creates a new `Resolver`. Parameters parent:Resolver The parent of this resolver, which is never `null` Exceptions NullPointerException: If the parent is `null`

Method Detail

addChild back to summary

addChild	back to summary
public final void addChild(String variableName, Resolver resolver) Caches the given `Resolver`. Parameters variableName:String The key used to cache the given `Resolver` resolver:Resolver The `Resolver` to cache

public final void addChild(String variableName, Resolver resolver)

Caches the given Resolver.

Parameters

variableName:String: The key used to cache the given Resolver
resolver:Resolver: The Resolver to cache

buildType back to summary

buildType	back to summary
protected IType buildType() Resolves the `IType` of the property handled by this `Resolver`. Returns:IType Either the `IType` that was resolved by this `Resolver` or the `IType` for `IType#UNRESOLVABLE_TYPE` if it could not be resolved

protected IType buildType()

Resolves the IType of the property handled by this Resolver.

Returns:IType: Either the IType that was resolved by this Resolver or the IType for IType#UNRESOLVABLE_TYPE if it could not be resolved

buildTypeDeclaration back to summary

buildTypeDeclaration	back to summary
protected abstract ITypeDeclaration buildTypeDeclaration() Resolves the `ITypeDeclaration` of the property handled by this `Resolver`. Returns:ITypeDeclaration Either the `ITypeDeclaration` that was resolved by this `Resolver` or the `ITypeDeclaration` for `IType#UNRESOLVABLE_TYPE` if it could not be resolved

protected abstract ITypeDeclaration buildTypeDeclaration()

Resolves the ITypeDeclaration of the property handled by this Resolver.

Returns:ITypeDeclaration: Either the ITypeDeclaration that was resolved by this Resolver or the ITypeDeclaration for IType#UNRESOLVABLE_TYPE if it could not be resolved

checkParent	back to summary
protected void checkParent(Resolver parent)

getChild back to summary

getChild	back to summary
public final Resolver getChild(String variableName) Retrieves the child of this `Resolver` that has the given variable name. Parameters variableName:String The name of the property that was cached Returns:Resolver The cached `Resolver` mapped with the given property name; otherwise `null`

public final Resolver getChild(String variableName)

Retrieves the child of this Resolver that has the given variable name.

Parameters

variableName:String: The name of the property that was cached

Returns:Resolver

The cached Resolver mapped with the given property name; otherwise null

getManagedType back to summary

getManagedType	back to summary
public IManagedType getManagedType() Returns the `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. Returns:IManagedType Either the `IManagedType`, if it could be resolved; `null` otherwise

public IManagedType getManagedType()

Returns the 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.

Returns:IManagedType: Either the IManagedType, if it could be resolved; null otherwise

getMapping back to summary

getMapping	back to summary
public IMapping getMapping() Returns the `IMapping` for the wrapped field. Returns:IMapping Either the `IMapping` or `null` if none exists

public IMapping getMapping()

Returns the IMapping for the wrapped field.

Returns:IMapping: Either the IMapping or null if none exists

getParent back to summary

getParent	back to summary
public Resolver getParent() Returns the parent of this `Resolver`. Returns:Resolver The parent of this `Resolver`

public Resolver getParent()

Returns the parent of this Resolver.

Returns:Resolver: The parent of this Resolver

getParentManagedType	back to summary
public final IManagedType getParentManagedType() Returns the managed type of the parent resolver. Returns:IManagedType The managed type of the parent resolver

getParentManagedType

back to summary

public final IManagedType getParentManagedType()

Returns the managed type of the parent resolver.

Returns:IManagedType: The managed type of the parent resolver

getParentMapping back to summary

getParentMapping	back to summary
public final IMapping getParentMapping() Returns the `IMapping` of the parent resolver. Returns:IMapping The `IMapping` of the parent resolver

public final IMapping getParentMapping()

Returns the IMapping of the parent resolver.

Returns:IMapping: The IMapping of the parent resolver

getParentType	back to summary
public final IType getParentType() Returns the type of the parent resolver. Returns:IType The type of the parent resolver

getParentType

back to summary

public final IType getParentType()

Returns the type of the parent resolver.

Returns:IType: The type of the parent resolver

getParentTypeDeclaration	back to summary
public final ITypeDeclaration getParentTypeDeclaration() Returns the type declaration of the parent resolver. Returns:ITypeDeclaration The type declaration of the parent resolver

getParentTypeDeclaration

back to summary

public final ITypeDeclaration getParentTypeDeclaration()

Returns the type declaration of the parent resolver.

Returns:ITypeDeclaration: The type declaration of the parent resolver

getProvider	back to summary
public final IManagedTypeProvider getProvider() Returns the provider of managed types. Returns:IManagedTypeProvider The container holding the managed types

getProvider

back to summary

public final IManagedTypeProvider getProvider()

Returns the provider of managed types.

Returns:IManagedTypeProvider: The container holding the managed types

getQuery	back to summary
public IQuery getQuery() Returns the external form representing the JPQL query. Returns:IQuery The external form of the JPQL query

getQuery

back to summary

public IQuery getQuery()

Returns the external form representing the JPQL query.

Returns:IQuery: The external form of the JPQL query

getType back to summary

getType	back to summary
public final IType getType() Returns the `IType` of the field handled by this `Resolver`. Returns:IType Either the `IType` that was resolved by this `Resolver` or the `IType` for `IType#UNRESOLVABLE_TYPE` if it could not be resolved

public final IType getType()

Returns the IType of the field handled by this Resolver.

Returns:IType: Either the IType that was resolved by this Resolver or the IType for IType#UNRESOLVABLE_TYPE if it could not be resolved

getType back to summary

getType	back to summary
public final IType getType(Class<?> type) Returns the `IType` of the given Java type. Parameters type:Class<?> The Java type for which its external form will be returned Returns:IType The `IType` representing the given Java type

public final IType getType(Class<?> type)

Returns the IType of the given Java type.

Parameters

type:Class<?>: The Java type for which its external form will be returned

Returns:IType

The IType representing the given Java type

getType	back to summary
public final IType getType(String typeName) Retrieves the external class for the given fully qualified class name. Parameters typeName:String The fully qualified class name of the class to retrieve Returns:IType The external form of the class to retrieve

getType

back to summary

public final IType getType(String typeName)

Retrieves the external class for the given fully qualified class name.

Parameters

typeName:String: The fully qualified class name of the class to retrieve

Returns:IType

The external form of the class to retrieve

getTypeDeclaration back to summary

getTypeDeclaration	back to summary
public final ITypeDeclaration getTypeDeclaration() Returns the `ITypeDeclaration` of the field handled by this `Resolver`. Returns:ITypeDeclaration Either the `ITypeDeclaration` that was resolved by this `Resolver` or the `ITypeDeclaration` for `IType#UNRESOLVABLE_TYPE` if it could not be resolved

public final ITypeDeclaration getTypeDeclaration()

Returns the ITypeDeclaration of the field handled by this Resolver.

Returns:ITypeDeclaration: Either the ITypeDeclaration that was resolved by this Resolver or the ITypeDeclaration for IType#UNRESOLVABLE_TYPE if it could not be resolved

getTypeHelper back to summary

getTypeHelper	back to summary
public final TypeHelper getTypeHelper() Returns a helper that gives access to the most common `types`. Returns:TypeHelper A helper containing a collection of methods related to `IType`

public final TypeHelper getTypeHelper()

Returns a helper that gives access to the most common types.

Returns:TypeHelper: A helper containing a collection of methods related to IType

getTypeRepository back to summary

getTypeRepository	back to summary
public final ITypeRepository getTypeRepository() Returns the type repository for the application. Returns:ITypeRepository The repository of `ITypes`

public final ITypeRepository getTypeRepository()

Returns the type repository for the application.

Returns:ITypeRepository: The repository of ITypes

isNullAllowed back to summary

isNullAllowed	back to summary
public 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. Returns:boolean `true` to allow `null` if the corresponding relationship in the database does not exists; `false` otherwise

public 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.

Returns:boolean: true to allow null if the corresponding relationship in the database does not exists; false otherwise

setNullAllowed back to summary

setNullAllowed	back to summary
public 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. Parameters nullAllowed:boolean `true` to allow `null` if the corresponding relationship in the database does not exists; `false` otherwise

public 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.

Parameters

nullAllowed:boolean: true to allow null if the corresponding relationship in the database does not exists; false otherwise

public abstract Class Resolver

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail