java.lang.Object
- antlr.BaseAST
- - antlr.CommonAST
  - - org.hibernate.hql.internal.ast.tree.Node
    - - org.hibernate.hql.internal.ast.tree.SqlNode
      - org.hibernate.hql.internal.ast.tree.HqlSqlWalkerNode
        
        org.hibernate.hql.internal.ast.tree.FromElement

所有已实现的接口:

antlr.collections.AST, Serializable, DisplayableNode, InitializeableNode, ParameterContainer

直接已知子类:

ComponentJoin, EntityJoinFromElement, ImpliedFromElement, MapKeyEntityFromElement
```
public class FromElement
extends HqlSqlWalkerNode
implements DisplayableNode, ParameterContainer
```
Represents a single mapped class mentioned in an HQL FROM clause. Each class reference will have the following symbols:
- A class name - This is the name of the Java class that is mapped by Hibernate.
- [optional] an HQL alias for the mapped class.
- A table name - The name of the table that is mapped to the Java class.
- A table alias - The alias for the table that will be used in the resulting SQL.
作者:

josh

另请参阅:

序列化表格

字段概要

字段
修饰符和类型字段说明

static String DISCRIMINATOR_PROPERTY_NAME
- 从类继承的字段 antlr.BaseAST
  down, right

构造器概要

构造器
限定符	构造器	说明
	`FromElement()`
`protected`	`FromElement(FromClause fromClause, FromElement origin, String alias)`	Constructor form used to initialize `ComponentJoin`

方法概要

所有方法实例方法具体方法
修饰符和类型	方法	说明
`void`	`addEmbeddedParameter(ParameterSpecification specification)`	Adds a parameter specification for a parameter encountered within this node.
`protected void`	`appendDisplayText(StringBuilder buf)`
`void`	`applyTreatAsDeclarations(Set<String> treatAsDeclarationsByPath)`
`protected void`	`doInitialize(FromClause fromClause, String tableAlias, String className, String classAlias, EntityPersister persister, EntityType type)`
`boolean`	`equals(Object obj)`
`String`	`getClassAlias()`
`String`	`getClassName()`
`CollectionPropertyReference`	`getCollectionPropertyReference(String propertyName)`
`String`	`getCollectionSuffix()`
`String`	`getCollectionTableAlias()`
`Type`	`getDataType()`
`List<FromElement>`	`getDestinations()`
`String`	`getDisplayText()`	Returns additional display text for the AST node.
`ParameterSpecification[]`	`getEmbeddedParameters()`	Retrieve all embedded parameter specifications.
`EntityPersister`	`getEntityPersister()`
`FromElement`	`getFetchOrigin()`
`FromClause`	`getFromClause()`
`String[]`	`getIdentifierPropertyNames()`
`String`	`getIdentityColumn()`
`String[]`	`getIdentityColumns()`
`ParameterSpecification`	`getIndexCollectionSelectorParamSpec()`
`JoinSequence`	`getJoinSequence()`
`FromElement`	`getOrigin()`
`PropertyMapping`	`getPropertyMapping(String propertyName)`
`String`	`getPropertyTableName(String propertyName)`
`Type`	`getPropertyType(String propertyName, String propertyPath)`
`Queryable`	`getQueryable()`
`QueryableCollection`	`getQueryableCollection()`
`FromElement`	`getRealOrigin()`
`String`	`getRole()`
`Type`	`getSelectType()`
`int`	`getSequence()`
`String`	`getTableAlias()`
`String`	`getTableName()`
`TypeDiscriminatorMetadata`	`getTypeDiscriminatorMetadata()`
`antlr.collections.AST`	`getWithClauseAst()`
`String`	`getWithClauseFragment()`
`void`	`handlePropertyBeingDereferenced(Type propertySource, String propertyName)`
`boolean`	`hasEmbeddedParameters()`	Determine whether this node contains embedded parameters.
`int`	`hashCode()`
`void`	`initializeCollection(FromClause fromClause, String classAlias, String tableAlias)`
`protected void`	`initializeComponentJoin(org.hibernate.hql.internal.ast.tree.FromElementType elementType)`
`void`	`initializeEntity(FromClause fromClause, String className, EntityPersister persister, EntityType type, String classAlias, String tableAlias)`
`boolean`	`inProjectionList()`
`boolean`	`isAllPropertyFetch()`
`boolean`	`isCollectionJoin()`
`boolean`	`isCollectionOfValuesOrComponents()`
`boolean`	`isDereferencedBySubclassProperty()`
`boolean`	`isDereferencedBySuperclassOrSubclassProperty()`
`boolean`	`isDereferencedBySuperclassProperty()`
`boolean`	`isEntity()`
`boolean`	`isFetch()`
`boolean`	`isFilter()`
`boolean`	`isFromOrJoinFragment()`
`boolean`	`isImplied()`	Returns true if this FromElement was implied by a path, or false if this FROM element is explicitly declared in the FROM clause.
`boolean`	`isImpliedInFromClause()`
`boolean`	`isIncludeSubclasses()`
`boolean`	`isManyToMany()`
`String`	`renderMapEntryPropertySelectFragment(int size, int k)`
`String`	`renderMapKeyPropertySelectFragment(int size, int k)`
`void`	`setAllPropertyFetch(boolean fetch)`
`void`	`setCollectionJoin(boolean collectionJoin)`
`void`	`setCollectionSuffix(String suffix)`
`void`	`setCollectionTableAlias(String collectionTableAlias)`
`void`	`setColumns(String[] columns)`
`void`	`setFetch(boolean fetch)`
`void`	`setFilter(boolean b)`
`void`	`setImpliedInFromClause(boolean flag)`
`void`	`setIncludeSubclasses(boolean includeSubclasses)`
`void`	`setIndexCollectionSelectorParamSpec(ParameterSpecification indexCollectionSelectorParamSpec)`
`void`	`setInProjectionList(boolean inProjectionList)`
`void`	`setJoinSequence(JoinSequence joinSequence)`
`void`	`setOrigin(FromElement origin, boolean manyToMany)`
`void`	`setQueryableCollection(QueryableCollection queryableCollection)`
`void`	`setRole(String role)`
`void`	`setUseFromFragment(boolean useFromFragment)`
`void`	`setUseWhereFragment(boolean b)`
`void`	`setWithClauseFragment(antlr.collections.AST ast, String withClauseFragment)`
`String[]`	`toColumns(String tableAlias, String path, boolean inSelect)`
`String[]`	`toColumns(String tableAlias, String path, boolean inSelect, boolean forceAlias)`
`boolean`	`useFromFragment()`
`boolean`	`useWhereFragment()`

从类继承的方法 org.hibernate.hql.internal.ast.tree.HqlSqlWalkerNode
getAliasGenerator, getASTFactory, getSessionFactoryHelper, getWalker, initialize

从类继承的方法 org.hibernate.hql.internal.ast.tree.SqlNode
getOriginalText, setDataType, setText

从类继承的方法 org.hibernate.hql.internal.ast.tree.Node
getColumn, getFilename, getLine, getRenderText, getTextLength, initialize, initialize

从类继承的方法 antlr.CommonAST
getText, getType, initialize, setType

从类继承的方法 antlr.BaseAST
addChild, decode, encode, equals, equalsList, equalsListPartial, equalsTree, equalsTreePartial, findAll, findAllPartial, getFirstChild, getNextSibling, getNumberOfChildren, getTokenNames, removeChildren, setFirstChild, setNextSibling, setVerboseStringConversion, toString, toStringList, toStringTree, xmlSerialize, xmlSerializeNode, xmlSerializeRootClose, xmlSerializeRootOpen

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

从接口继承的方法 org.hibernate.hql.internal.ast.tree.ParameterContainer
setText

字段详细资料
- DISCRIMINATOR_PROPERTY_NAME
```
public static final String DISCRIMINATOR_PROPERTY_NAME
```
  另请参阅:
  
  常量字段值

构造器详细资料
- FromElement
```
public FromElement()
```
- FromElement
```
protected FromElement(FromClause fromClause,
                      FromElement origin,
                      String alias)
```
  Constructor form used to initialize ComponentJoin
  
  参数:
  
  fromClause - The FROM clause to which this element belongs
  
  origin - The origin (LHS) of this element
  
  alias - The alias applied to this element

方法详细资料

initializeComponentJoin

protected void initializeComponentJoin(org.hibernate.hql.internal.ast.tree.FromElementType elementType)

getCollectionSuffix
```
public String getCollectionSuffix()
```

setCollectionSuffix

public void setCollectionSuffix(String suffix)

initializeCollection

public void initializeCollection(FromClause fromClause,
                                 String classAlias,
                                 String tableAlias)

initializeEntity

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

doInitialize

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

getEntityPersister

public EntityPersister getEntityPersister()

getDataType
```
public Type getDataType()
```
覆盖:

getDataType 在类中 SqlNode

getSelectType
```
public Type getSelectType()
```

getQueryable
```
public Queryable getQueryable()
```

getClassName
```
public String getClassName()
```

getClassAlias
```
public String getClassAlias()
```

getTableName
```
public String getTableName()
```

getTableAlias
```
public String getTableAlias()
```

renderMapKeyPropertySelectFragment

public String renderMapKeyPropertySelectFragment(int size,
                                                 int k)

renderMapEntryPropertySelectFragment

public String renderMapEntryPropertySelectFragment(int size,
                                                   int k)

getFromClause
```
public FromClause getFromClause()
```

isImplied
```
public boolean isImplied()
```
Returns true if this FromElement was implied by a path, or false if this FROM element is explicitly declared in the FROM clause.

返回:

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

getDisplayText
```
public String getDisplayText()
```
Returns additional display text for the AST node.

指定者:

getDisplayText 在接口中 DisplayableNode

返回:

String - The additional display text.

appendDisplayText

protected void appendDisplayText(StringBuilder buf)

hashCode
```
public int hashCode()
```
覆盖:

hashCode 在类中 Object

equals
```
public boolean equals(Object obj)
```
覆盖:

equals 在类中 Object

setJoinSequence

public void setJoinSequence(JoinSequence joinSequence)

getJoinSequence
```
public JoinSequence getJoinSequence()
```

setIncludeSubclasses

public void setIncludeSubclasses(boolean includeSubclasses)

isIncludeSubclasses
```
public boolean isIncludeSubclasses()
```

isDereferencedBySuperclassOrSubclassProperty

public boolean isDereferencedBySuperclassOrSubclassProperty()

getIdentityColumn
```
public String getIdentityColumn()
```

getIdentityColumns
```
public String[] getIdentityColumns()
```

setCollectionJoin

public void setCollectionJoin(boolean collectionJoin)

isCollectionJoin
```
public boolean isCollectionJoin()
```

setRole
```
public void setRole(String role)
```

applyTreatAsDeclarations

public void applyTreatAsDeclarations(Set<String> treatAsDeclarationsByPath)

getRole
```
public String getRole()
```

setQueryableCollection

public void setQueryableCollection(QueryableCollection queryableCollection)

getQueryableCollection

public QueryableCollection getQueryableCollection()

setColumns

public void setColumns(String[] columns)

setOrigin

public void setOrigin(FromElement origin,
                      boolean manyToMany)

isManyToMany
```
public boolean isManyToMany()
```

getDestinations

public List<FromElement> getDestinations()

getOrigin
```
public FromElement getOrigin()
```

getRealOrigin
```
public FromElement getRealOrigin()
```

getFetchOrigin
```
public FromElement getFetchOrigin()
```

getTypeDiscriminatorMetadata

public TypeDiscriminatorMetadata getTypeDiscriminatorMetadata()

getPropertyType

public Type getPropertyType(String propertyName,
                            String propertyPath)

getPropertyTableName

public String getPropertyTableName(String propertyName)

toColumns

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

toColumns

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

getPropertyMapping

public PropertyMapping getPropertyMapping(String propertyName)

getCollectionPropertyReference

public CollectionPropertyReference getCollectionPropertyReference(String propertyName)

getIdentifierPropertyNames

public String[] getIdentifierPropertyNames()

setFetch

public void setFetch(boolean fetch)

isFetch
```
public boolean isFetch()
```

getSequence
```
public int getSequence()
```

setFilter
```
public void setFilter(boolean b)
```

isFilter
```
public boolean isFilter()
```

useFromFragment
```
public boolean useFromFragment()
```

setUseFromFragment

public void setUseFromFragment(boolean useFromFragment)

useWhereFragment
```
public boolean useWhereFragment()
```

setUseWhereFragment

public void setUseWhereFragment(boolean b)

setCollectionTableAlias

public void setCollectionTableAlias(String collectionTableAlias)

getCollectionTableAlias

public String getCollectionTableAlias()

isCollectionOfValuesOrComponents

public boolean isCollectionOfValuesOrComponents()

isEntity
```
public boolean isEntity()
```

setImpliedInFromClause

public void setImpliedInFromClause(boolean flag)

isImpliedInFromClause

public boolean isImpliedInFromClause()

setInProjectionList

public void setInProjectionList(boolean inProjectionList)

inProjectionList
```
public boolean inProjectionList()
```

isFromOrJoinFragment
```
public boolean isFromOrJoinFragment()
```

isAllPropertyFetch
```
public boolean isAllPropertyFetch()
```

setAllPropertyFetch

public void setAllPropertyFetch(boolean fetch)

getWithClauseAst

public antlr.collections.AST getWithClauseAst()

getWithClauseFragment
```
public String getWithClauseFragment()
```

setWithClauseFragment

public void setWithClauseFragment(antlr.collections.AST ast,
                                  String withClauseFragment)

handlePropertyBeingDereferenced

public void handlePropertyBeingDereferenced(Type propertySource,
                                            String propertyName)

isDereferencedBySuperclassProperty

public boolean isDereferencedBySuperclassProperty()

isDereferencedBySubclassProperty

public boolean isDereferencedBySubclassProperty()

addEmbeddedParameter
```
public void addEmbeddedParameter(ParameterSpecification specification)
```
从接口复制的说明: ParameterContainer

Adds a parameter specification for a parameter encountered within this node. We use the term 'embedded' here because of the fact that the parameter was simply encountered as part of the node's text; it does not exist as part of a subtree as it might in a true AST.

指定者:

addEmbeddedParameter 在接口中 ParameterContainer

参数:

specification - The generated specification.

hasEmbeddedParameters
```
public boolean hasEmbeddedParameters()
```
从接口复制的说明: ParameterContainer

Determine whether this node contains embedded parameters. The implication is that ParameterContainer.getEmbeddedParameters() is allowed to return null if this method returns false.

指定者:

hasEmbeddedParameters 在接口中 ParameterContainer

返回:

True if this node contains embedded parameters; false otherwise.

getEmbeddedParameters
```
public ParameterSpecification[] getEmbeddedParameters()
```
从接口复制的说明: ParameterContainer

Retrieve all embedded parameter specifications.

指定者:

getEmbeddedParameters 在接口中 ParameterContainer

返回:

All embedded parameter specifications; may return null.

另请参阅:

ParameterContainer.hasEmbeddedParameters()

getIndexCollectionSelectorParamSpec

public ParameterSpecification getIndexCollectionSelectorParamSpec()

setIndexCollectionSelectorParamSpec

public void setIndexCollectionSelectorParamSpec(ParameterSpecification indexCollectionSelectorParamSpec)

类 FromElement

字段概要

从类继承的字段 antlr.BaseAST

构造器概要

方法概要

从类继承的方法 org.hibernate.hql.internal.ast.tree.HqlSqlWalkerNode

从类继承的方法 org.hibernate.hql.internal.ast.tree.SqlNode

从类继承的方法 org.hibernate.hql.internal.ast.tree.Node

从类继承的方法 antlr.CommonAST

从类继承的方法 antlr.BaseAST

从类继承的方法 java.lang.Object

从接口继承的方法 org.hibernate.hql.internal.ast.tree.ParameterContainer

字段详细资料

DISCRIMINATOR_PROPERTY_NAME

构造器详细资料

FromElement

FromElement

方法详细资料

initializeComponentJoin

getCollectionSuffix

setCollectionSuffix

initializeCollection

initializeEntity

doInitialize

getEntityPersister

getDataType

getSelectType

getQueryable

getClassName

getClassAlias

getTableName

getTableAlias

renderMapKeyPropertySelectFragment

renderMapEntryPropertySelectFragment

getFromClause

isImplied

getDisplayText

appendDisplayText

hashCode

equals

setJoinSequence

getJoinSequence

setIncludeSubclasses

isIncludeSubclasses

isDereferencedBySuperclassOrSubclassProperty

getIdentityColumn

getIdentityColumns

setCollectionJoin

isCollectionJoin

setRole

applyTreatAsDeclarations

getRole

setQueryableCollection

getQueryableCollection

setColumns

setOrigin

isManyToMany

getDestinations

getOrigin

getRealOrigin

getFetchOrigin

getTypeDiscriminatorMetadata

getPropertyType

getPropertyTableName

toColumns

toColumns

getPropertyMapping

getCollectionPropertyReference

getIdentifierPropertyNames

setFetch

isFetch

getSequence

setFilter

isFilter

useFromFragment

setUseFromFragment

useWhereFragment

setUseWhereFragment

setCollectionTableAlias

getCollectionTableAlias