EclipseLink 2.4.1, build 'v20121003-ad44345' API Reference

org.eclipse.persistence.jpa.jpql
Class AbstractContentAssistVisitor.AbstractSelectClauseSelectStatementHelper

java.lang.Object
  extended by org.eclipse.persistence.jpa.jpql.AbstractContentAssistVisitor.AbstractSelectClauseSelectStatementHelper
All Implemented Interfaces:
AbstractContentAssistVisitor.SelectStatementHelper<AbstractSelectStatement,AbstractSelectClause>
Direct Known Subclasses:
AbstractContentAssistVisitor.SelectClauseSelectStatementHelper, AbstractContentAssistVisitor.SimpleSelectClauseSelectStatementHelper
Enclosing class:
AbstractContentAssistVisitor

protected abstract class AbstractContentAssistVisitor.AbstractSelectClauseSelectStatementHelper
extends java.lang.Object
implements AbstractContentAssistVisitor.SelectStatementHelper<AbstractSelectStatement,AbstractSelectClause>


Constructor Summary
protected AbstractContentAssistVisitor.AbstractSelectClauseSelectStatementHelper()
           
 
Method Summary
 void addClauseProposal()
          Adds the JPQL identifier of the clause being scanned by this helper.
 void appendNextClauseProposals(AbstractSelectStatement expression, AbstractSelectClause 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.
 AbstractSelectClause getClause(AbstractSelectStatement expression)
          Returns the clause being scanned by this helper.
 Expression getClauseExpression(AbstractSelectClause clause)
          Returns the clause's expression.
 AbstractContentAssistVisitor.SelectStatementHelper<AbstractSelectStatement,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(AbstractSelectStatement expression)
          Determines whether the clause exists in the parsed tree.
 boolean hasClauseExpression(AbstractSelectClause clause)
          Determines whether the clause's expression exists in the parsed tree.
 boolean hasSpaceAfterClause(AbstractSelectStatement expression)
          Determines whether there is a space (owned by the SELECT statement) after the clause being scanned by this helper.
 boolean hasSpaceBeforeClause(AbstractSelectStatement 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.persistence.jpa.jpql.AbstractContentAssistVisitor.SelectStatementHelper
getNextHelper
 

Constructor Detail

AbstractContentAssistVisitor.AbstractSelectClauseSelectStatementHelper

protected AbstractContentAssistVisitor.AbstractSelectClauseSelectStatementHelper()
Method Detail

addClauseProposal

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

Specified by:
addClauseProposal in interface AbstractContentAssistVisitor.SelectStatementHelper<AbstractSelectStatement,AbstractSelectClause>

appendNextClauseProposals

public void appendNextClauseProposals(AbstractSelectStatement expression,
                                      AbstractSelectClause 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.

Specified by:
appendNextClauseProposals in interface AbstractContentAssistVisitor.SelectStatementHelper<AbstractSelectStatement,AbstractSelectClause>
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

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

Specified by:
getClause in interface AbstractContentAssistVisitor.SelectStatementHelper<AbstractSelectStatement,AbstractSelectClause>
Parameters:
expression - The AbstractSelectStatement being visited
Returns:
The clause being scanned

getClauseExpression

public Expression getClauseExpression(AbstractSelectClause clause)
Returns the clause's expression.

Specified by:
getClauseExpression in interface AbstractContentAssistVisitor.SelectStatementHelper<AbstractSelectStatement,AbstractSelectClause>
Parameters:
clause - The AbstractSelectStatement being visited
Returns:
The clause's expression

getPreviousHelper

public AbstractContentAssistVisitor.SelectStatementHelper<AbstractSelectStatement,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.

Specified by:
getPreviousHelper in interface AbstractContentAssistVisitor.SelectStatementHelper<AbstractSelectStatement,AbstractSelectClause>
Returns:
The AbstractContentAssistVisitor.AbstractFromClauseSelectStatementHelper for the previous clause

hasClause

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

Specified by:
hasClause in interface AbstractContentAssistVisitor.SelectStatementHelper<AbstractSelectStatement,AbstractSelectClause>
Parameters:
expression - The AbstractSelectStatement being visited
Returns:
true if the clause has been parsed; false otherwise

hasClauseExpression

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

Specified by:
hasClauseExpression in interface AbstractContentAssistVisitor.SelectStatementHelper<AbstractSelectStatement,AbstractSelectClause>
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

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

Specified by:
hasSpaceAfterClause in interface AbstractContentAssistVisitor.SelectStatementHelper<AbstractSelectStatement,AbstractSelectClause>
Parameters:
expression - The AbstractSelectStatement being visited
Returns:
true if a space follows the clause; false otherwise

hasSpaceBeforeClause

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

Specified by:
hasSpaceBeforeClause in interface AbstractContentAssistVisitor.SelectStatementHelper<AbstractSelectStatement,AbstractSelectClause>
Parameters:
expression - The AbstractSelectStatement being visited
Returns:
true if a space precedes the clause; false otherwise

isClauseExpressionComplete

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

Specified by:
isClauseExpressionComplete in interface AbstractContentAssistVisitor.SelectStatementHelper<AbstractSelectStatement,AbstractSelectClause>
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.1, build 'v20121003-ad44345' API Reference