Class EclipseLinkContentAssistVisitor.UnionClauseStatementHelper
- java.lang.Object
-
- org.eclipse.persistence.jpa.jpql.tools.EclipseLinkContentAssistVisitor.UnionClauseStatementHelper
-
- All Implemented Interfaces:
AbstractContentAssistVisitor.StatementHelper<SelectStatement>
- Enclosing class:
- EclipseLinkContentAssistVisitor
protected class EclipseLinkContentAssistVisitor.UnionClauseStatementHelper extends java.lang.Object implements AbstractContentAssistVisitor.StatementHelper<SelectStatement>
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedUnionClauseStatementHelper()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddClauseProposals()Adds the JPQL identifier of the clause being scanned by this helper.voidaddInternalClauseProposals(SelectStatement expression)Adds the JPQL identifier of the internal clause being scanned by this helper.ExpressiongetClause(SelectStatement expression)Returns the clause being scanned by this helper.AbstractContentAssistVisitor.StatementHelper<? extends SelectStatement>getNextHelper()Returns theAbstractContentAssistVisitor.StatementHelperthat will scan the following clause, which is based on the grammar and not on the actual existence of the clause in the parsed tree.booleanhasClause(SelectStatement expression)Determines whether the clause exists in the parsed tree.booleanhasSpaceAfterClause(SelectStatement expression)Determines whether there is a space (owned by the SELECT statement) after the clause being scanned by this helper.booleanisClauseComplete(SelectStatement expression)Determines whether the clause being scanned is complete or not.booleanisRequired()Determines whether the clause is required in order to make the JPQL query grammatically valid.
-
-
-
Method Detail
-
addClauseProposals
public void addClauseProposals()
Adds the JPQL identifier of the clause being scanned by this helper.Note: The identifier should not be added directly to the list, it needs to be filtered out based on the location of the cursor, it can be within a word.
- Specified by:
addClauseProposalsin interfaceAbstractContentAssistVisitor.StatementHelper<SelectStatement>
-
addInternalClauseProposals
public void addInternalClauseProposals(SelectStatement expression)
Adds the JPQL identifier of the internal clause being scanned by this helper. For instance, theFROMclause could add its own sub-clauses.Note: The identifier should not be added directly to the list, it needs to be filtered out based on the location of the cursor, it can be within a word.
- Specified by:
addInternalClauseProposalsin interfaceAbstractContentAssistVisitor.StatementHelper<SelectStatement>- Parameters:
expression- TheAbstractSelectStatementbeing visited
-
getClause
public Expression getClause(SelectStatement expression)
Returns the clause being scanned by this helper. It is safe to type cast the clause becauseAbstractContentAssistVisitor.StatementHelper.hasClause(Expression)is called before this one.- Specified by:
getClausein interfaceAbstractContentAssistVisitor.StatementHelper<SelectStatement>- Parameters:
expression- TheAbstractSelectStatementbeing visited- Returns:
- The clause being scanned
-
getNextHelper
public AbstractContentAssistVisitor.StatementHelper<? extends SelectStatement> getNextHelper()
Returns theAbstractContentAssistVisitor.StatementHelperthat 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:
getNextHelperin interfaceAbstractContentAssistVisitor.StatementHelper<SelectStatement>- Returns:
- The
AbstractContentAssistVisitor.StatementHelperfor the next clause
-
hasClause
public boolean hasClause(SelectStatement expression)
Determines whether the clause exists in the parsed tree.- Specified by:
hasClausein interfaceAbstractContentAssistVisitor.StatementHelper<SelectStatement>- Parameters:
expression- TheAbstractSelectStatementbeing visited- Returns:
trueif the clause has been parsed;falseotherwise
-
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:
hasSpaceAfterClausein interfaceAbstractContentAssistVisitor.StatementHelper<SelectStatement>- Parameters:
expression- TheAbstractSelectStatementbeing visited- Returns:
trueif a space follows the clause;falseotherwise
-
isClauseComplete
public boolean isClauseComplete(SelectStatement expression)
Determines whether the clause being scanned is complete or not.- Specified by:
isClauseCompletein interfaceAbstractContentAssistVisitor.StatementHelper<SelectStatement>- Parameters:
expression- TheAbstractSelectStatementbeing visited- Returns:
trueif the clause is complete;falseotherwise
-
isRequired
public boolean isRequired()
Determines whether the clause is required in order to make the JPQL query grammatically valid.- Specified by:
isRequiredin interfaceAbstractContentAssistVisitor.StatementHelper<SelectStatement>- Returns:
trueif the clause has to be defined;falseif the clause is optional
-
-