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

public abstract Class AbstractRestrictableStatement

extends AbstractStatement
implements RestrictableStatement
Class Inheritance
All Implemented Interfaces
org.hibernate.hql.ast.tree.RestrictableStatement, org.hibernate.hql.ast.tree.Statement
Known Direct Subclasses
org.hibernate.hql.ast.tree.QueryNode, org.hibernate.hql.ast.tree.UpdateStatement, org.hibernate.hql.ast.tree.DeleteStatement
Imports
org.hibernate.hql.antlr.HqlSqlTokenTypes, org.hibernate.hql.ast.util.ASTUtil, antlr.collections.AST, org.slf4j.Logger
Convenience implementation of RestrictableStatement to centralize common functionality.
Author
Steve Ebersole

Field Summary

Modifier and TypeField and Description
private FromClause
fromClause

private AST
whereClause

Constructor Summary

AccessConstructor and Description
public
AbstractRestrictableStatement()

Method Summary

Modifier and TypeMethod and Description
public final FromClause
getFromClause()

Implements org.hibernate.hql.ast.tree.RestrictableStatement.getFromClause.

Retreives the from-clause in effect for this statement.
protected abstract Logger
getLog()

public final AST
getWhereClause()

Implements org.hibernate.hql.ast.tree.RestrictableStatement.getWhereClause.

Retreives the where-clause defining the restriction(s) in effect for this statement.
protected abstract int
getWhereClauseParentTokenType()

public final boolean
hasWhereClause()

Implements org.hibernate.hql.ast.tree.RestrictableStatement.hasWhereClause.

Does this statement tree currently contain a where clause?
protected AST
locateWhereClause()

Inherited from org.hibernate.hql.ast.tree.AbstractStatement:
getDisplayText

Field Detail

fromClauseback to summary
private FromClause fromClause
whereClauseback to summary
private AST whereClause

Constructor Detail

AbstractRestrictableStatementback to summary
public AbstractRestrictableStatement()

Method Detail

getFromClauseback to summary
public final FromClause getFromClause()

Implements org.hibernate.hql.ast.tree.RestrictableStatement.getFromClause.

Doc from org.hibernate.hql.ast.tree.RestrictableStatement.getFromClause.

Retreives the from-clause in effect for this statement.

Returns:FromClause

The from-clause for this statement; could be null if the from-clause has not yet been parsed/generated.

See Also
org.hibernate.hql.ast.tree.RestrictableStatement#getFromClause
getLogback to summary
protected abstract Logger getLog()
getWhereClauseback to summary
public final AST getWhereClause()

Implements org.hibernate.hql.ast.tree.RestrictableStatement.getWhereClause.

Doc from org.hibernate.hql.ast.tree.RestrictableStatement.getWhereClause.

Retreives the where-clause defining the restriction(s) in effect for this statement.

Note that this will generate a where-clause if one was not found, so caution needs to taken prior to calling this that restrictions will actually exist in the resulting statement tree (otherwise "unexpected end of subtree" errors might occur during rendering).

Returns:AST

The where clause.

See Also
org.hibernate.hql.ast.tree.RestrictableStatement#getWhereClause
getWhereClauseParentTokenTypeback to summary
protected abstract int getWhereClauseParentTokenType()
hasWhereClauseback to summary
public final boolean hasWhereClause()

Implements org.hibernate.hql.ast.tree.RestrictableStatement.hasWhereClause.

Doc from org.hibernate.hql.ast.tree.RestrictableStatement.hasWhereClause.

Does this statement tree currently contain a where clause?

Returns:boolean

True if a where-clause is found in the statement tree and that where clause actually defines restrictions; false otherwise.

See Also
RestrictableStatement#hasWhereClause
locateWhereClauseback to summary
protected AST locateWhereClause()