Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	DotNode.DereferenceType
public static interface	DotNode.IllegalCollectionDereferenceExceptionBuilder

Field Summary

Modifier and Type	Field and Description
private String[]	columns The column names that this resolves to.
public static final DotNode.IllegalCollectionDereferenceExceptionBuilder	DEF_ILLEGAL_COLL_DEREF_EXCP_BUILDER
private DotNode.DereferenceType	dereferenceType The type of dereference that happened
private boolean	fetch Fetch join or not.
public static DotNode.IllegalCollectionDereferenceExceptionBuilder	ILLEGAL_COLL_DEREF_EXCP_BUILDER
private FromElement	impliedJoin Deprecated as a consequence of `FromElement` being deprecated.
private JoinType	joinType The type of join to create.
private static final CoreMessageLogger	LOG Hides org.hibernate.hql.internal.ast.tree.FromReferenceNode.LOG.
private String	path The full path, to the root alias of this dot node.
private String	propertyName The identifier that is the name of the property.
private String	propertyPath The unresolved property path relative to this dot node.
public static boolean	regressionStyleJoinSuppression
public static boolean	useThetaStyleImplicitJoins

Inherited from org.hibernate.hql.internal.ast.tree.FromReferenceNode:: ROOT_LEVEL

Constructor Summary

Access	Constructor and Description
public	DotNode()

Method Summary

Modifier and Type	Method and Description
private boolean	areSame(String alias1, String alias2)
private boolean	canReuse(String classAlias, FromElement fromElement) Deprecated as a consequence of `FromElement` being deprecated.
private void	checkForCorrelatedSubquery(String methodName)
private void	checkLhsIsNotCollection()
private boolean	checkSubclassOrSuperclassPropertyReference(FromReferenceNode lhs, String propertyName)
private void	dereferenceCollection(CollectionType collectionType, boolean implicitJoin, boolean indexed, String classAlias, AST parent)
private void	dereferenceComponent(AST parent)
private void	dereferenceEntity(EntityType toOneType, boolean implicitJoin, String classAlias, boolean generateJoin, AST parent, AST parentPredicate)
private void	dereferenceEntityIdentifier(String propertyName, DotNode dotParent)
private void	dereferenceEntityJoin(String classAlias, EntityType toOneType, boolean isImpliedJoin, AST parent)
private String[]	getColumns()
public Type	getDataType() Overrides org.hibernate.hql.internal.ast.tree.SqlNode.getDataType. Implements org.hibernate.hql.internal.ast.tree.SelectExpression.getDataType. Returns the data type of the select expression.
public String	getDisplayText() Overrides org.hibernate.hql.internal.ast.tree.FromReferenceNode.getDisplayText. Implements org.hibernate.hql.internal.ast.tree.DisplayableNode.getDisplayText. Returns additional display text for the AST node.
public FromElement	getImpliedJoin() Overrides org.hibernate.hql.internal.ast.tree.FromReferenceNode.getImpliedJoin. Deprecated as a consequence of `FromElement` being deprecated. Sub-classes can override this method if they produce implied joins (e.g. DotNode).
public FromReferenceNode	getLhs()
public String	Returns: the full path of the node. getPath() Overrides org.hibernate.hql.internal.ast.tree.FromReferenceNode.getPath. Implements org.hibernate.hql.internal.ast.tree.PathNode.getPath. Returns the full path of the node.
public String	getPropertyPath()
public String[]	getReferencedTables() Implements org.hibernate.hql.internal.ast.tree.TableReferenceNode.getReferencedTables. Returns table names which are referenced by this node.
private void	initText()
private boolean	isCorrelatedSubselect()
private static boolean	isDotNode(AST n)
private boolean	Returns: True if propertyName references the entity's (owningType->associatedEntity) join key; false otherwise. isPropertyEmbeddedInJoinProperties(String The name of the property to check. propertyName) Is the given property name a reference to the join key of the associated entity constructed by the given entity type?
private Type	prepareLhs()
public void	resolve(boolean generateJoin, boolean implicitJoin, String classAlias, AST parent, AST parentPredicate) Implements org.hibernate.hql.internal.ast.tree.ResolvableNode.resolve. Does the work of resolving an identifier or a dot
public void	resolveFirstChild() Overrides org.hibernate.hql.internal.ast.tree.FromReferenceNode.resolveFirstChild. Resolves the left hand side of the DOT.
public void	resolveIndex(AST parent) Implements org.hibernate.hql.internal.ast.tree.ResolvableNode.resolveIndex. Does the work of resolving an index [].
public void	resolveInFunctionCall(boolean generateJoin, boolean implicitJoin) Overrides org.hibernate.hql.internal.ast.tree.FromReferenceNode.resolveInFunctionCall. Implements org.hibernate.hql.internal.ast.tree.ResolvableNode.resolveInFunctionCall. Does the work of resolving inside of the scope of a function call
public void	resolveSelectExpression() Special method to resolve expressions in the SELECT list.
public void	setFetch(boolean fetch)
private void	setImpliedJoin(FromElement elem) Deprecated as a consequence of `FromElement` being deprecated.
public void	setJoinType(JoinType The type of join to use. joinType) Sets the join type for this '.' node structure.
private void	setPropertyNameAndPath(AST parent)
public void	setPropertyPath(String propertyPath)
public void	setResolvedConstant(String text)
public void	setScalarColumnText(int The index of the select expression in the projection list. i) Implements org.hibernate.hql.internal.ast.tree.SelectExpression.setScalarColumnText. Appends AST nodes that represent the columns after the current AST node.

Inherited from org.hibernate.hql.internal.ast.tree.FromReferenceNode:: getFromElement isFromElementUpdateOrDeleteRoot isResolved isReturnableEntity prepareForDot recursiveResolve recursiveResolve resolve resolve resolve setFromElement setResolved

Field Detail

columns	back to summary
private String[] columns The column names that this resolves to.

DEF_ILLEGAL_COLL_DEREF_EXCP_BUILDER	back to summary
public static final DotNode.IllegalCollectionDereferenceExceptionBuilder DEF_ILLEGAL_COLL_DEREF_EXCP_BUILDER

dereferenceType	back to summary
private DotNode.DereferenceType dereferenceType The type of dereference that happened

fetch	back to summary
private boolean fetch Fetch join or not.

ILLEGAL_COLL_DEREF_EXCP_BUILDER	back to summary
public static DotNode.IllegalCollectionDereferenceExceptionBuilder ILLEGAL_COLL_DEREF_EXCP_BUILDER

impliedJoin	back to summary
private FromElement impliedJoin Deprecated as a consequence of `FromElement` being deprecated. See corresponding docs for further information.

joinType	back to summary
private JoinType joinType The type of join to create. Default is an inner join.

LOG	back to summary
private static final CoreMessageLogger LOG Hides org.hibernate.hql.internal.ast.tree.FromReferenceNode.LOG.

path	back to summary
private String path The full path, to the root alias of this dot node.

propertyName	back to summary
private String propertyName The identifier that is the name of the property.

propertyPath	back to summary
private String propertyPath The unresolved property path relative to this dot node.

regressionStyleJoinSuppression	back to summary
public static boolean regressionStyleJoinSuppression

useThetaStyleImplicitJoins	back to summary
public static boolean useThetaStyleImplicitJoins

Constructor Detail

DotNode	back to summary
public DotNode()

Method Detail

areSame	back to summary
private boolean areSame(String alias1, String alias2)

canReuse	back to summary
private boolean canReuse(String classAlias, FromElement fromElement) Deprecated as a consequence of `FromElement` being deprecated. See corresponding docs for further information.

checkForCorrelatedSubquery	back to summary
private void checkForCorrelatedSubquery(String methodName)

checkLhsIsNotCollection	back to summary
private void checkLhsIsNotCollection() throws SemanticException

checkSubclassOrSuperclassPropertyReference	back to summary
private boolean checkSubclassOrSuperclassPropertyReference(FromReferenceNode lhs, String propertyName)

dereferenceCollection	back to summary
private void dereferenceCollection(CollectionType collectionType, boolean implicitJoin, boolean indexed, String classAlias, AST parent) throws SemanticException

dereferenceComponent	back to summary
private void dereferenceComponent(AST parent)

dereferenceEntity	back to summary
private void dereferenceEntity(EntityType toOneType, boolean implicitJoin, String classAlias, boolean generateJoin, AST parent, AST parentPredicate) throws SemanticException

dereferenceEntityIdentifier	back to summary
private void dereferenceEntityIdentifier(String propertyName, DotNode dotParent)

dereferenceEntityJoin	back to summary
private void dereferenceEntityJoin(String classAlias, EntityType toOneType, boolean isImpliedJoin, AST parent) throws SemanticException

getColumns	back to summary
private String[] getColumns() throws QueryException

getDataType	back to summary
public Type getDataType() Overrides org.hibernate.hql.internal.ast.tree.SqlNode.getDataType. Implements org.hibernate.hql.internal.ast.tree.SelectExpression.getDataType. Doc from org.hibernate.hql.internal.ast.tree.SelectExpression.getDataType. Returns the data type of the select expression. Returns:Type The data type of the select expression. Annotations @Override

getDataType

back to summary

public Type getDataType()

Overrides org.hibernate.hql.internal.ast.tree.SqlNode.getDataType.

Implements org.hibernate.hql.internal.ast.tree.SelectExpression.getDataType.

Doc from org.hibernate.hql.internal.ast.tree.SelectExpression.getDataType.

Returns the data type of the select expression.

Returns:Type

The data type of the select expression.

Annotations

@Override

getDisplayText	back to summary
public String getDisplayText() Overrides org.hibernate.hql.internal.ast.tree.FromReferenceNode.getDisplayText. Implements org.hibernate.hql.internal.ast.tree.DisplayableNode.getDisplayText. Doc from org.hibernate.hql.internal.ast.tree.DisplayableNode.getDisplayText. Returns additional display text for the AST node. Returns:String String - The additional display text. Annotations @Override

getDisplayText

back to summary

public String getDisplayText()

Overrides org.hibernate.hql.internal.ast.tree.FromReferenceNode.getDisplayText.

Implements org.hibernate.hql.internal.ast.tree.DisplayableNode.getDisplayText.

Doc from org.hibernate.hql.internal.ast.tree.DisplayableNode.getDisplayText.

Returns additional display text for the AST node.

Returns:String

String - The additional display text.

Annotations

@Override

getImpliedJoin back to summary

getImpliedJoin	back to summary
public FromElement getImpliedJoin() Overrides org.hibernate.hql.internal.ast.tree.FromReferenceNode.getImpliedJoin. Doc from org.hibernate.hql.internal.ast.tree.FromReferenceNode.getImpliedJoin. Deprecated as a consequence of `FromElement` being deprecated. See corresponding docs for further information. Sub-classes can override this method if they produce implied joins (e.g. DotNode). Returns:FromElement an implied join created by this from reference. Annotations @Override

public FromElement getImpliedJoin()

Overrides org.hibernate.hql.internal.ast.tree.FromReferenceNode.getImpliedJoin.

Doc from org.hibernate.hql.internal.ast.tree.FromReferenceNode.getImpliedJoin.

Deprecated

as a consequence of FromElement being deprecated. See corresponding docs for further information.

Sub-classes can override this method if they produce implied joins (e.g. DotNode).

Returns:FromElement

an implied join created by this from reference.

Annotations

@Override

getLhs	back to summary
public FromReferenceNode getLhs()

getPath	back to summary
public String getPath() Overrides org.hibernate.hql.internal.ast.tree.FromReferenceNode.getPath. Implements org.hibernate.hql.internal.ast.tree.PathNode.getPath. Returns the full path of the node. Returns:String the full path of the node. Annotations @Override

getPath

back to summary

public String getPath()

Overrides org.hibernate.hql.internal.ast.tree.FromReferenceNode.getPath.

Implements org.hibernate.hql.internal.ast.tree.PathNode.getPath.

Returns the full path of the node.

Returns:String

the full path of the node.

Annotations

@Override

getPropertyPath	back to summary
public String getPropertyPath()

getReferencedTables	back to summary
public String[] getReferencedTables() Implements org.hibernate.hql.internal.ast.tree.TableReferenceNode.getReferencedTables. Doc from org.hibernate.hql.internal.ast.tree.TableReferenceNode.getReferencedTables. Returns table names which are referenced by this node. If the tables can not be determined it returns null. Returns:String[] table names or null. Annotations @Override

getReferencedTables

back to summary

public String[] getReferencedTables()

Implements org.hibernate.hql.internal.ast.tree.TableReferenceNode.getReferencedTables.

Doc from org.hibernate.hql.internal.ast.tree.TableReferenceNode.getReferencedTables.

Returns table names which are referenced by this node. If the tables can not be determined it returns null.

Returns:String[]

table names or null.

Annotations

@Override

initText	back to summary
private void initText()

isCorrelatedSubselect	back to summary
private boolean isCorrelatedSubselect()

isDotNode	back to summary
private static boolean isDotNode(AST n)

isPropertyEmbeddedInJoinProperties back to summary

isPropertyEmbeddedInJoinProperties	back to summary
private boolean isPropertyEmbeddedInJoinProperties(String propertyName) Is the given property name a reference to the join key of the associated entity constructed by the given entity type? This method resolves the `propertyName` as a property of the entity type at the `propertyPath` relative to the `FromElement`. The implementation does so by invoking `FromElement#getPropertyType(String, String)`, which will resolve the property path against the entity's `org.hibernate.persister.entity.PropertyMapping`. On initialization of the `EntityPersister`, this `PropertyMapping` is filled with property paths for all the owned properties and associations, and (embedded) identifier or unique key properties for owned associations. Henceforth, whenever a property path is found in the `PropertyMapping` of the `EntityPersister` of the `FromElement`, we know that the property corresponds to a SQL fragment producible from the `FromElement`, and as such the entity property can be dereferenced (optimized) in the final query. For example, consider a fragment like order.customer.id (where order is a from-element alias). Here, we'd have: propertyName = "id" AND propertyPath = "customer" FromElement = Order and are being asked to determine whether "customer.id" is a property path of Order Parameters propertyName:String The name of the property to check. Returns:boolean True if propertyName references the entity's (owningType->associatedEntity) join key; false otherwise.

private boolean isPropertyEmbeddedInJoinProperties(String propertyName)

Is the given property name a reference to the join key of the associated entity constructed by the given entity type?

This method resolves the propertyName as a property of the entity type at the propertyPath relative to the FromElement. The implementation does so by invoking FromElement#getPropertyType(String, String), which will resolve the property path against the entity's org.hibernate.persister.entity.PropertyMapping. On initialization of the EntityPersister, this PropertyMapping is filled with property paths for all the owned properties and associations, and (embedded) identifier or unique key properties for owned associations. Henceforth, whenever a property path is found in the PropertyMapping of the EntityPersister of the FromElement, we know that the property corresponds to a SQL fragment producible from the FromElement, and as such the entity property can be dereferenced (optimized) in the final query.

For example, consider a fragment like order.customer.id (where order is a from-element alias). Here, we'd have: propertyName = "id" AND propertyPath = "customer" FromElement = Order and are being asked to determine whether "customer.id" is a property path of Order

Parameters

propertyName:String: The name of the property to check.

Returns:boolean

True if propertyName references the entity's (owningType->associatedEntity) join key; false otherwise.

prepareLhs	back to summary
private Type prepareLhs() throws SemanticException

resolve	back to summary
public void resolve(boolean generateJoin, boolean implicitJoin, String classAlias, AST parent, AST parentPredicate) throws SemanticException Implements org.hibernate.hql.internal.ast.tree.ResolvableNode.resolve. Doc from org.hibernate.hql.internal.ast.tree.ResolvableNode.resolve. Does the work of resolving an identifier or a dot

resolve

back to summary

public void resolve(boolean generateJoin, boolean implicitJoin, String classAlias, AST parent, AST parentPredicate) throws SemanticException

Implements org.hibernate.hql.internal.ast.tree.ResolvableNode.resolve.

Doc from org.hibernate.hql.internal.ast.tree.ResolvableNode.resolve.

Does the work of resolving an identifier or a dot

resolveFirstChild	back to summary
public void resolveFirstChild() throws SemanticException Overrides org.hibernate.hql.internal.ast.tree.FromReferenceNode.resolveFirstChild. Resolves the left hand side of the DOT. Annotations @Override

resolveFirstChild

back to summary

public void resolveFirstChild() throws SemanticException

Overrides org.hibernate.hql.internal.ast.tree.FromReferenceNode.resolveFirstChild.

Resolves the left hand side of the DOT.

Annotations

@Override

resolveIndex	back to summary
public void resolveIndex(AST parent) throws SemanticException Implements org.hibernate.hql.internal.ast.tree.ResolvableNode.resolveIndex. Doc from org.hibernate.hql.internal.ast.tree.ResolvableNode.resolveIndex. Does the work of resolving an index [].

resolveIndex

back to summary

public void resolveIndex(AST parent) throws SemanticException

Implements org.hibernate.hql.internal.ast.tree.ResolvableNode.resolveIndex.

Doc from org.hibernate.hql.internal.ast.tree.ResolvableNode.resolveIndex.

Does the work of resolving an index [].

resolveInFunctionCall	back to summary
public void resolveInFunctionCall(boolean generateJoin, boolean implicitJoin) throws SemanticException Overrides org.hibernate.hql.internal.ast.tree.FromReferenceNode.resolveInFunctionCall. Implements org.hibernate.hql.internal.ast.tree.ResolvableNode.resolveInFunctionCall. Doc from org.hibernate.hql.internal.ast.tree.ResolvableNode.resolveInFunctionCall. Does the work of resolving inside of the scope of a function call Annotations @Override

resolveInFunctionCall

back to summary

public void resolveInFunctionCall(boolean generateJoin, boolean implicitJoin) throws SemanticException

Overrides org.hibernate.hql.internal.ast.tree.FromReferenceNode.resolveInFunctionCall.

Implements org.hibernate.hql.internal.ast.tree.ResolvableNode.resolveInFunctionCall.

Doc from org.hibernate.hql.internal.ast.tree.ResolvableNode.resolveInFunctionCall.

Does the work of resolving inside of the scope of a function call

Annotations

@Override

resolveSelectExpression	back to summary
public void resolveSelectExpression() throws SemanticException Special method to resolve expressions in the SELECT list. Exceptions SemanticException: if this cannot be resolved.

resolveSelectExpression

back to summary

public void resolveSelectExpression() throws SemanticException

Special method to resolve expressions in the SELECT list.

Exceptions

SemanticException:: if this cannot be resolved.

setFetch	back to summary
public void setFetch(boolean fetch)

setImpliedJoin	back to summary
private void setImpliedJoin(FromElement elem) Deprecated as a consequence of `FromElement` being deprecated. See corresponding docs for further information.

setJoinType back to summary

setJoinType	back to summary
public void setJoinType(JoinType joinType) Sets the join type for this '.' node structure. Parameters joinType:JoinType The type of join to use. See Also `org.hibernate.sql.JoinFragment`

public void setJoinType(JoinType joinType)

Sets the join type for this '.' node structure.

Parameters

joinType:JoinType: The type of join to use.

See Also

org.hibernate.sql.JoinFragment

setPropertyNameAndPath	back to summary
private void setPropertyNameAndPath(AST parent)

setPropertyPath	back to summary
public void setPropertyPath(String propertyPath)

setResolvedConstant	back to summary
public void setResolvedConstant(String text)

setScalarColumnText

back to summary

public void setScalarColumnText(int i) throws SemanticException

Implements org.hibernate.hql.internal.ast.tree.SelectExpression.setScalarColumnText.

Doc from org.hibernate.hql.internal.ast.tree.SelectExpression.setScalarColumnText.

Appends AST nodes that represent the columns after the current AST node. (e.g. 'as col0_O_')

Parameters

i:int: The index of the select expression in the projection list.

Exceptions

SemanticException:: if a semantic error occurs

org.hibernate.hql.internal.ast.tree back to summary

public final Enum DotNode.DereferenceType

Class Inheritance

extends Enum<DotNode.DereferenceType>

java.lang.Object
java.lang.Enum
org.hibernate.hql.internal.ast.tree.DotNode.DereferenceType

Field Summary

Modifier and Type	Field and Description
public static final DotNode.DereferenceType	COLLECTION
public static final DotNode.DereferenceType	COMPONENT
public static final DotNode.DereferenceType	ENTITY
public static final DotNode.DereferenceType	IDENTIFIER
public static final DotNode.DereferenceType	JAVA_CONSTANT
public static final DotNode.DereferenceType	PRIMITIVE
public static final DotNode.DereferenceType	UNKNOWN

Constructor Summary

Access	Constructor and Description
private	DereferenceType()

Method Summary

Modifier and Type	Method and Description
public static DotNode.DereferenceType	valueOf(String name)
public static DotNode.DereferenceType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

COLLECTION	back to summary
public static final DotNode.DereferenceType COLLECTION

COMPONENT	back to summary
public static final DotNode.DereferenceType COMPONENT

ENTITY	back to summary
public static final DotNode.DereferenceType ENTITY

IDENTIFIER	back to summary
public static final DotNode.DereferenceType IDENTIFIER

JAVA_CONSTANT	back to summary
public static final DotNode.DereferenceType JAVA_CONSTANT

PRIMITIVE	back to summary
public static final DotNode.DereferenceType PRIMITIVE

UNKNOWN	back to summary
public static final DotNode.DereferenceType UNKNOWN

Constructor Detail

DereferenceType	back to summary
private DereferenceType()

Method Detail

valueOf	back to summary
public static DotNode.DereferenceType valueOf(String name)

values	back to summary
public static DotNode.DereferenceType[] values()

org.hibernate.hql.internal.ast.tree back to summary

public Interface DotNode.IllegalCollectionDereferenceExceptionBuilder

Method Summary

Modifier and Type	Method and Description
public QueryException	buildIllegalCollectionDereferenceException(String collectionPropertyName, FromReferenceNode lhs)

Method Detail

buildIllegalCollectionDereferenceException	back to summary
public QueryException buildIllegalCollectionDereferenceException(String collectionPropertyName, FromReferenceNode lhs)

public Class DotNode

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum DotNode.DereferenceType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface DotNode.IllegalCollectionDereferenceExceptionBuilder

Method Summary

Method Detail