Top Description Methods
org.hibernate.sql.ast.tree.from

public Interface TableReference

extends SqlAstNode, ColumnReferenceQualifier
Known Direct Implementers
org.hibernate.sql.model.ast.MutatingTableReference, org.hibernate.sql.ast.tree.from.AbstractTableReference
Imports
java.util.ArrayList, .List, java.util.function.Consumer, .Function, org.hibernate.spi.NavigablePath, org.hibernate.sql.ast.SqlAstWalker, org.hibernate.sql.ast.tree.SqlAstNode
Represents a reference to a table (derived or physical) in a query's from clause.
Author
Steve Ebersole

Method Summary

Modifier and TypeMethod and Description
public void
accept(SqlAstWalker sqlTreeWalker)

Redeclares org.hibernate.sql.ast.tree.SqlAstNode.accept.

public default void
applyAffectedTableNames(Consumer<String> nameCollector)

public default boolean
containsAffectedTableName(String requestedName)

public default List<String>
getAffectedTableNames()

public String
getIdentificationVariable()

public String
getTableId()

An identifier for the table reference.

public TableReference
getTableReference(NavigablePath
The path for which to look up the table reference, may be null
navigablePath, String
The table expression for which to look up the table reference
tableExpression, boolean
Whether to potentially create table reference joins for this table group
resolve)

Redeclares org.hibernate.sql.ast.tree.from.ColumnReferenceQualifier.getTableReference.

Returns the table reference for the table expression, or null if not found.
public boolean
isOptional()

public TableReference
resolveTableReference(NavigablePath
The path for which to look up the table reference, may be null
navigablePath, String
The table expression for which to look up the table reference
tableExpression)

Redeclares as abstract: org.hibernate.sql.ast.tree.from.ColumnReferenceQualifier.resolveTableReference.

Like getTableReference(NavigablePath, String, boolean), but will throw an exception if no table reference can be found, even after resolving possible table reference joins.
public Boolean
visitAffectedTableNames(Function<String, Boolean> nameCollector)

Inherited from org.hibernate.sql.ast.tree.from.ColumnReferenceQualifier:
getTableReferencegetTableReferencegetTableReferenceresolveTableReferenceresolveTableReference

Method Detail

acceptback to summary
public void accept(SqlAstWalker sqlTreeWalker)

Redeclares org.hibernate.sql.ast.tree.SqlAstNode.accept.

Annotations
@Override
applyAffectedTableNamesback to summary
public default void applyAffectedTableNames(Consumer<String> nameCollector)
containsAffectedTableNameback to summary
public default boolean containsAffectedTableName(String requestedName)
getAffectedTableNamesback to summary
public default List<String> getAffectedTableNames()
getIdentificationVariableback to summary
public String getIdentificationVariable()
getTableIdback to summary
public String getTableId()

An identifier for the table reference. May be null if this is not a named table reference.

getTableReferenceback to summary
public TableReference getTableReference(NavigablePath navigablePath, String tableExpression, boolean resolve)

Redeclares org.hibernate.sql.ast.tree.from.ColumnReferenceQualifier.getTableReference.

Doc from org.hibernate.sql.ast.tree.from.ColumnReferenceQualifier.getTableReference.

Returns the table reference for the table expression, or null if not found.

Parameters
navigablePath:NavigablePath

The path for which to look up the table reference, may be null

tableExpression:String

The table expression for which to look up the table reference

resolve:boolean

Whether to potentially create table reference joins for this table group

Annotations
@Override
isOptionalback to summary
public boolean isOptional()
resolveTableReferenceback to summary
public TableReference resolveTableReference(NavigablePath navigablePath, String tableExpression)

Redeclares as abstract: org.hibernate.sql.ast.tree.from.ColumnReferenceQualifier.resolveTableReference.

Doc from org.hibernate.sql.ast.tree.from.ColumnReferenceQualifier.resolveTableReference.

Like getTableReference(NavigablePath, String, boolean), but will throw an exception if no table reference can be found, even after resolving possible table reference joins.

Parameters
navigablePath:NavigablePath

The path for which to look up the table reference, may be null

tableExpression:String

The table expression for which to look up the table reference

Annotations
@Override
visitAffectedTableNamesback to summary
public Boolean visitAffectedTableNames(Function<String, Boolean> nameCollector)