EclipseLink 2.4.0, build 'v20120608-r11652' API Reference

org.eclipse.persistence.jpa.jpql
Class EclipseLinkContentAssistVisitor.UnionClauseSelectStatementHelper

java.lang.Object
  extended by org.eclipse.persistence.jpa.jpql.EclipseLinkContentAssistVisitor.UnionClauseSelectStatementHelper
All Implemented Interfaces:
AbstractContentAssistVisitor.SelectStatementHelper<SelectStatement,UnionClause>
Enclosing class:
EclipseLinkContentAssistVisitor

protected class EclipseLinkContentAssistVisitor.UnionClauseSelectStatementHelper
extends java.lang.Object
implements AbstractContentAssistVisitor.SelectStatementHelper<SelectStatement,UnionClause>


Constructor Summary
protected EclipseLinkContentAssistVisitor.UnionClauseSelectStatementHelper()
           
 
Method Summary
 void addClauseProposal()
          Adds the JPQL identifier of the clause being scanned by this helper.
 void appendNextClauseProposals(SelectStatement expression, UnionClause 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.
 UnionClause getClause(SelectStatement expression)
          Returns the clause being scanned by this helper.
 Expression getClauseExpression(UnionClause 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.OrderByClauseSelectStatementHelper 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(SelectStatement expression)
          Determines whether the clause exists in the parsed tree.
 boolean hasClauseExpression(UnionClause clause)
          Determines whether the clause's expression exists in the parsed tree.
 boolean hasSpaceAfterClause(SelectStatement expression)
          Determines whether there is a space (owned by the SELECT statement) after the clause being scanned by this helper.
 boolean hasSpaceBeforeClause(SelectStatement 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
 

Constructor Detail

EclipseLinkContentAssistVisitor.UnionClauseSelectStatementHelper

protected EclipseLinkContentAssistVisitor.UnionClauseSelectStatementHelper()
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<SelectStatement,UnionClause>

appendNextClauseProposals

public void appendNextClauseProposals(SelectStatement expression,
                                      UnionClause 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<SelectStatement,UnionClause>
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 UnionClause getClause(SelectStatement 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<SelectStatement,UnionClause>
Parameters:
expression - The AbstractSelectStatement being visited
Returns:
The clause being scanned

getClauseExpression

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

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

getNextHelper

public 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.

Specified by:
getNextHelper in interface AbstractContentAssistVisitor.SelectStatementHelper<SelectStatement,UnionClause>
Returns:
The AbstractContentAssistVisitor.AbstractFromClauseSelectStatementHelper for the next clause

getPreviousHelper

public AbstractContentAssistVisitor.OrderByClauseSelectStatementHelper 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<SelectStatement,UnionClause>
Returns:
The AbstractContentAssistVisitor.AbstractFromClauseSelectStatementHelper for the previous clause

hasClause

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

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

hasClauseExpression

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

Specified by:
hasClauseExpression in interface AbstractContentAssistVisitor.SelectStatementHelper<SelectStatement,UnionClause>
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(SelectStatement 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<SelectStatement,UnionClause>
Parameters:
expression - The AbstractSelectStatement being visited
Returns:
true if a space follows the clause; false otherwise

hasSpaceBeforeClause

public boolean hasSpaceBeforeClause(SelectStatement 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<SelectStatement,UnionClause>
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<SelectStatement,UnionClause>
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