EclipseLink 2.4.0, build 'v20120608-r11652' API Reference

org.eclipse.persistence.jpa.jpql
Interface AbstractContentAssistVisitor.SelectStatementHelper<T extends AbstractSelectStatement,C extends Expression>

All Known Implementing Classes:
AbstractContentAssistVisitor.AbstractFromClauseSelectStatementHelper, AbstractContentAssistVisitor.AbstractGroupByClauseSelectStatementHelper, AbstractContentAssistVisitor.AbstractHavingClauseSelectStatementHelper, AbstractContentAssistVisitor.AbstractSelectClauseSelectStatementHelper, AbstractContentAssistVisitor.AbstractWhereClauseSelectStatementHelper, AbstractContentAssistVisitor.FromClauseSelectStatementHelper, AbstractContentAssistVisitor.GroupByClauseSelectStatementHelper, AbstractContentAssistVisitor.HavingClauseSelectStatementHelper, AbstractContentAssistVisitor.OrderByClauseSelectStatementHelper, AbstractContentAssistVisitor.SelectClauseSelectStatementHelper, AbstractContentAssistVisitor.SimpleFromClauseSelectStatementHelper, AbstractContentAssistVisitor.SimpleGroupByClauseSelectStatementHelper, AbstractContentAssistVisitor.SimpleHavingClauseSelectStatementHelper, AbstractContentAssistVisitor.SimpleSelectClauseSelectStatementHelper, AbstractContentAssistVisitor.SimpleWhereClauseSelectStatementHelper, AbstractContentAssistVisitor.WhereClauseSelectStatementHelper, EclipseLinkContentAssistVisitor.FromClauseSelectStatementHelper, EclipseLinkContentAssistVisitor.GroupByClauseSelectStatementHelper, EclipseLinkContentAssistVisitor.HavingClauseSelectStatementHelper, EclipseLinkContentAssistVisitor.OrderByClauseSelectStatementHelper, EclipseLinkContentAssistVisitor.UnionClauseSelectStatementHelper, EclipseLinkContentAssistVisitor.WhereClauseSelectStatementHelper
Enclosing class:
AbstractContentAssistVisitor

protected static interface AbstractContentAssistVisitor.SelectStatementHelper<T extends AbstractSelectStatement,C extends Expression>


Method Summary
 void addClauseProposal()
          Adds the JPQL identifier of the clause being scanned by this helper.
 void appendNextClauseProposals(T expression, C clause, int position, boolean complete)
          The position of the cursor is at the end of the given clause, requests to add the clauses' identifiers that can be added as proposals.
 C getClause(T expression)
          Returns the clause being scanned by this helper.
 Expression getClauseExpression(C clause)
          Returns the clause's expression.
 AbstractContentAssistVisitor.SelectStatementHelper<? extends AbstractSelectStatement,? extends Expression> getNextHelper()
          Returns the AbstractContentAssistVisitor.AbstractFromClauseSelectStatementHelper that will scan the following clause, which is based on the grammar and not on the actual existence of the clause in the parsed tree.
 AbstractContentAssistVisitor.SelectStatementHelper<? extends AbstractSelectStatement,? extends Expression> getPreviousHelper()
          Returns the AbstractContentAssistVisitor.AbstractFromClauseSelectStatementHelper that will scan the previous clause, which is based on the grammar and not on the actual existence of the clause in the parsed tree.
 boolean hasClause(T expression)
          Determines whether the clause exists in the parsed tree.
 boolean hasClauseExpression(C clause)
          Determines whether the clause's expression exists in the parsed tree.
 boolean hasSpaceAfterClause(T expression)
          Determines whether there is a space (owned by the SELECT statement) after the clause being scanned by this helper.
 boolean hasSpaceBeforeClause(T expression)
          Determines whether there is a space (owned by the SELECT statement) before the clause being scanned by this helper.
 boolean isClauseExpressionComplete(Expression expression)
          Determines whether the clause's expression is complete or incomplete.
 

Method Detail

addClauseProposal

void addClauseProposal()
Adds the JPQL identifier of the clause being scanned by this helper.


appendNextClauseProposals

void appendNextClauseProposals(T expression,
                               C clause,
                               int position,
                               boolean complete)
The position of the cursor is at the end of the given clause, requests to add the clauses' identifiers that can be added as proposals.

Parameters:
expression - The AbstractSelectStatement being visited
clause - The clause being scanned
position - The position of the cursor within the AbstractSelectStatement
complete - Determines whether the clause's expression is complete or not

getClause

C getClause(T expression)
Returns the clause being scanned by this helper. It is safe to type cast the clause because hasClause(AbstractSelectStatement) is called before this one.

Parameters:
expression - The AbstractSelectStatement being visited
Returns:
The clause being scanned

getClauseExpression

Expression getClauseExpression(C clause)
Returns the clause's expression.

Parameters:
clause - The AbstractSelectStatement being visited
Returns:
The clause's expression

getNextHelper

AbstractContentAssistVisitor.SelectStatementHelper<? extends AbstractSelectStatement,? extends Expression> getNextHelper()
Returns the AbstractContentAssistVisitor.AbstractFromClauseSelectStatementHelper that will scan the following clause, which is based on the grammar and not on the actual existence of the clause in the parsed tree.

Returns:
The AbstractContentAssistVisitor.AbstractFromClauseSelectStatementHelper for the next clause

getPreviousHelper

AbstractContentAssistVisitor.SelectStatementHelper<? extends AbstractSelectStatement,? extends Expression> getPreviousHelper()
Returns the AbstractContentAssistVisitor.AbstractFromClauseSelectStatementHelper that will scan the previous clause, which is based on the grammar and not on the actual existence of the clause in the parsed tree.

Returns:
The AbstractContentAssistVisitor.AbstractFromClauseSelectStatementHelper for the previous clause

hasClause

boolean hasClause(T expression)
Determines whether the clause exists in the parsed tree.

Parameters:
expression - The AbstractSelectStatement being visited
Returns:
true if the clause has been parsed; false otherwise

hasClauseExpression

boolean hasClauseExpression(C clause)
Determines whether the clause's expression exists in the parsed tree.

Parameters:
clause - The clause being scanned
Returns:
true if the clause has its expression or a portion of it parsed; false if nothing was parsed

hasSpaceAfterClause

boolean hasSpaceAfterClause(T expression)
Determines whether there is a space (owned by the SELECT statement) after the clause being scanned by this helper.

Parameters:
expression - The AbstractSelectStatement being visited
Returns:
true if a space follows the clause; false otherwise

hasSpaceBeforeClause

boolean hasSpaceBeforeClause(T expression)
Determines whether there is a space (owned by the SELECT statement) before the clause being scanned by this helper.

Parameters:
expression - The AbstractSelectStatement being visited
Returns:
true if a space precedes the clause; false otherwise

isClauseExpressionComplete

boolean isClauseExpressionComplete(Expression expression)
Determines whether the clause's expression is complete or incomplete.

Parameters:
expression - The clause's expression to verify its completeness
Returns:
true if the Expression is complete based on its content versus what the grammar expects; false otherwise

EclipseLink 2.4.0, build 'v20120608-r11652' API Reference