Top Description Inners Fields Constructors Methods
org.hibernate.hql.internal.ast.tree

public Class FromElement

extends HqlSqlWalkerNode
implements DisplayableNode, ParameterContainer
Class Inheritance
All Implemented Interfaces
org.hibernate.hql.internal.ast.tree.ParameterContainer, org.hibernate.hql.internal.ast.tree.DisplayableNode
Known Direct Subclasses
org.hibernate.hql.internal.ast.tree.ImpliedFromElement, org.hibernate.hql.internal.ast.tree.MapKeyEntityFromElement, org.hibernate.hql.internal.ast.tree.ComponentJoin, org.hibernate.hql.internal.ast.tree.EntityJoinFromElement
Imports
java.util.ArrayList, .Collections, .LinkedList, .List, .Set, java.util.stream.Collectors, antlr.collections.AST, org.hibernate.QueryException, org.hibernate.engine.internal.JoinSequence, org.hibernate.hql.internal.CollectionProperties, org.hibernate.hql.internal.antlr.HqlSqlTokenTypes, .SqlTokenTypes, org.hibernate.hql.internal.ast.TypeDiscriminatorMetadata, org.hibernate.hql.internal.ast.util.ASTUtil, org.hibernate.hql.spi.QueryTranslator, org.hibernate.internal.CoreLogging, .CoreMessageLogger, org.hibernate.internal.util.StringHelper, org.hibernate.param.DynamicFilterParameterSpecification, .ParameterSpecification, org.hibernate.persister.collection.QueryableCollection, org.hibernate.persister.entity.DiscriminatorMetadata, .EntityPersister, .PropertyMapping, .Queryable, org.hibernate.type.EntityType, .Type

Deprecated

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

Represents a single mapped class mentioned in an HQL FROM clause. Each class reference will have the following symbols:
Author
josh

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
FromElement.TypeDiscriminatorMetadataImpl

Field Summary

Modifier and TypeField and Description
private String
classAlias

private String
className

private boolean
collectionJoin

private String
collectionTableAlias

private String[]
columns

private boolean
dereferencedBySubclassProperty

private boolean
dereferencedBySuperclassProperty

private List<FromElement>
destinations

public static final String
DISCRIMINATOR_PROPERTY_NAME

private FromElementType
elementType

private List<ParameterSpecification>
embeddedParameters

private boolean
fetch

private boolean
filter

private FromClause
fromClause

private boolean
includeSubclasses

private boolean
initialized

private boolean
isAllPropertyFetch

private static final CoreMessageLogger
LOG

private boolean
manyToMany

private FromElement
origin

Deprecated as a consequence of FromElement being deprecated.
private String
role

private int
sequence

private String
tableAlias

private TypeDiscriminatorMetadata
typeDiscriminatorMetadata

private boolean
useFromFragment

private boolean
useWhereFragment

private AST
withClauseAst

private String
withClauseFragment

Constructor Summary

AccessConstructor and Description
public
FromElement()

protected
FromElement(FromClause
The FROM clause to which this element belongs
fromClause, FromElement
The origin (LHS) of this element
origin, String
The alias applied to this element
alias)

Deprecated as a consequence of FromElement being deprecated.
Constructor form used to initialize ComponentJoin

Method Summary

Modifier and TypeMethod and Description
private void
addDestination(FromElement fromElement)

Deprecated as a consequence of FromElement being deprecated.
public void
addEmbeddedParameter(ParameterSpecification
The generated specification.
specification)

Implements org.hibernate.hql.internal.ast.tree.ParameterContainer.addEmbeddedParameter.

Adds a parameter specification for a parameter encountered within this node.
protected void
appendDisplayText(StringBuilder buf)

public void
applyTreatAsDeclarations(Set<String> treatAsDeclarationsByPath)

private TypeDiscriminatorMetadata
buildTypeDiscriminatorMetadata()

pack-priv void
checkInitialized()

protected void
doInitialize(FromClause fromClause, String tableAlias, String className, String classAlias, EntityPersister persister, EntityType type)

public boolean
equals(Object
the reference object with which to compare.
obj)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public String
getClassAlias()

public String
getClassName()

public CollectionPropertyReference
getCollectionPropertyReference(String propertyName)

public String
getCollectionSuffix()

public String
getCollectionTableAlias()

public Type
getDataType()

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

public List<FromElement>
getDestinations()

public String

Returns:

String - The additional display text.
getDisplayText()

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

Returns additional display text for the AST node.
public FromElementType
getElementType()

public ParameterSpecification[]
getEmbeddedParameters()

Implements org.hibernate.hql.internal.ast.tree.ParameterContainer.getEmbeddedParameters.

Retrieve all embedded parameter specifications.
public EntityPersister
getEntityPersister()

public FromElement
getFetchOrigin()

Deprecated as a consequence of FromElement being deprecated.
public FromClause
getFromClause()

public String[]
getIdentifierPropertyNames()

public String
getIdentityColumn()

public String[]
getIdentityColumns()

public ParameterSpecification
getIndexCollectionSelectorParamSpec()

public JoinSequence
getJoinSequence()

public FromElement
getOrigin()

Deprecated as a consequence of FromElement being deprecated.
private List<ParameterSpecification>
getParameterSpecification()

public PropertyMapping
getPropertyMapping(String propertyName)

public String
getPropertyTableName(String propertyName)

public Type
getPropertyType(String propertyName, String propertyPath)

public Queryable
getQueryable()

public QueryableCollection
getQueryableCollection()

public FromElement
getRealOrigin()

Deprecated as a consequence of FromElement being deprecated.
public String
getRole()

public Type
getSelectType()

public int
getSequence()

public String
getTableAlias()

public String
getTableName()

public TypeDiscriminatorMetadata
getTypeDiscriminatorMetadata()

public AST
getWithClauseAst()

public String
getWithClauseFragment()

public void
handlePropertyBeingDereferenced(Type propertySource, String propertyName)

public boolean
hasEmbeddedParameters()

Implements org.hibernate.hql.internal.ast.tree.ParameterContainer.hasEmbeddedParameters.

Determine whether this node contains embedded parameters.
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public void
initializeCollection(FromClause fromClause, String classAlias, String tableAlias)

protected void
initializeComponentJoin(FromElementType elementType)

public void
initializeEntity(FromClause fromClause, String className, EntityPersister persister, EntityType type, String classAlias, String tableAlias)

public boolean
inProjectionList()

public boolean
isAllPropertyFetch()

public boolean
isCollectionJoin()

public boolean
isCollectionOfValuesOrComponents()

public boolean
isDereferencedBySubclassProperty()

public boolean
isDereferencedBySuperclassOrSubclassProperty()

public boolean
isDereferencedBySuperclassProperty()

public boolean
isEntity()

public boolean
isFetch()

public boolean
isFilter()

public boolean
isFromOrJoinFragment()

public boolean

Returns:

true if this FromElement was implied by a path, or false if this FROM element is explicitly declared
isImplied()

Returns true if this FromElement was implied by a path, or false if this FROM element is explicitly declared in the FROM clause.

public boolean
isImpliedInFromClause()

public boolean
isIncludeSubclasses()

public boolean
isManyToMany()

public boolean
isNonQualifiedPropertyRef(String identifier)

pack-priv String
renderCollectionSelectFragment(int size, int k)

pack-priv String

Returns:

the identifier select SQL fragment.
renderIdentifierSelect(int
The total number of returned types.
size, int
The sequence of the current returned type.
k)

Returns the identifier select SQL fragment.

public String
renderMapEntryPropertySelectFragment(int size, int k)

public String
renderMapKeyPropertySelectFragment(int size, int k)

pack-priv String

Returns:

the property select SQL fragment.
renderPropertySelect(int
The total number of returned types.
size, int
The sequence of the current returned type.
k)

Returns the property select SQL fragment.

pack-priv String

Returns:

the identifier select with the column alias.
renderScalarIdentifierSelect(int
the sequence of the returned type
i)

Render the identifier select, but in a 'scalar' context (i.e. generate the column alias).

pack-priv String
renderValueCollectionSelectFragment(int size, int k)

public void
setAllPropertyFetch(boolean fetch)

public void
setCollectionJoin(boolean collectionJoin)

public void
setCollectionSuffix(String suffix)

public void
setCollectionTableAlias(String collectionTableAlias)

public void
setColumns(String[] columns)

public void
setFetch(boolean fetch)

public void
setFilter(boolean b)

public void
setImpliedInFromClause(boolean flag)

public void
setIncludeSubclasses(boolean includeSubclasses)

public void
setIndexCollectionSelectorParamSpec(ParameterSpecification indexCollectionSelectorParamSpec)

public void
setInProjectionList(boolean inProjectionList)

public void
setJoinSequence(JoinSequence joinSequence)

public void
setOrigin(FromElement origin, boolean manyToMany)

Deprecated as a consequence of FromElement being deprecated.
public void
setQueryableCollection(QueryableCollection queryableCollection)

public void
setRole(String role)

public void
setUseFromFragment(boolean useFromFragment)

public void
setUseWhereFragment(boolean b)

public void
setWithClauseFragment(AST ast, String withClauseFragment)

public String[]
toColumns(String tableAlias, String path, boolean inSelect)

public String[]
toColumns(String tableAlias, String path, boolean inSelect, boolean forceAlias)

public boolean
useFromFragment()

public boolean
useWhereFragment()

Inherited from org.hibernate.hql.internal.ast.tree.HqlSqlWalkerNode:
getAliasGeneratorgetASTFactorygetSessionFactoryHelpergetWalkerinitialize