EclipseLink 2.4.2, build 'v20130514-5956486' API Reference

org.eclipse.persistence.jpa.jpql
Class AbstractContentAssistVisitor.AbstractHavingClauseStatementHelper<T extends AbstractSelectStatement>

java.lang.Object
  extended by org.eclipse.persistence.jpa.jpql.AbstractContentAssistVisitor.AbstractHavingClauseStatementHelper<T>
All Implemented Interfaces:
AbstractContentAssistVisitor.StatementHelper<T>
Direct Known Subclasses:
AbstractContentAssistVisitor.HavingClauseStatementHelper, AbstractContentAssistVisitor.SimpleHavingClauseStatementHelper
Enclosing class:
AbstractContentAssistVisitor

protected abstract class AbstractContentAssistVisitor.AbstractHavingClauseStatementHelper<T extends AbstractSelectStatement>
extends java.lang.Object
implements AbstractContentAssistVisitor.StatementHelper<T>


Constructor Summary
protected AbstractContentAssistVisitor.AbstractHavingClauseStatementHelper()
           
 
Method Summary
 void addClauseProposals()
          Adds the JPQL identifier of the clause being scanned by this helper.
 void addInternalClauseProposals(T expression)
          Adds the JPQL identifier of the internal clause being scanned by this helper.
 Expression getClause(T expression)
          Returns the clause being scanned by this helper.
 boolean hasClause(T expression)
          Determines whether the clause exists in the parsed tree.
 boolean isClauseComplete(T expression)
          Determines whether the clause being scanned is complete or not.
 boolean isRequired()
          Determines whether the clause is required in order to make the JPQL query grammatically valid.
 
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.StatementHelper
getNextHelper, hasSpaceAfterClause
 

Constructor Detail

AbstractContentAssistVisitor.AbstractHavingClauseStatementHelper

protected AbstractContentAssistVisitor.AbstractHavingClauseStatementHelper()
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:
addClauseProposals in interface AbstractContentAssistVisitor.StatementHelper<T extends AbstractSelectStatement>

addInternalClauseProposals

public void addInternalClauseProposals(T expression)
Adds the JPQL identifier of the internal clause being scanned by this helper. For instance, the FROM clause 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:
addInternalClauseProposals in interface AbstractContentAssistVisitor.StatementHelper<T extends AbstractSelectStatement>
Parameters:
expression - The AbstractSelectStatement being visited

getClause

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

Specified by:
getClause in interface AbstractContentAssistVisitor.StatementHelper<T extends AbstractSelectStatement>
Parameters:
expression - The AbstractSelectStatement being visited
Returns:
The clause being scanned

hasClause

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

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

isClauseComplete

public boolean isClauseComplete(T expression)
Determines whether the clause being scanned is complete or not.

Specified by:
isClauseComplete in interface AbstractContentAssistVisitor.StatementHelper<T extends AbstractSelectStatement>
Parameters:
expression - The AbstractSelectStatement being visited
Returns:
true if the clause is complete; false otherwise

isRequired

public boolean isRequired()
Determines whether the clause is required in order to make the JPQL query grammatically valid.

Specified by:
isRequired in interface AbstractContentAssistVisitor.StatementHelper<T extends AbstractSelectStatement>
Returns:
true if the clause has to be defined; false if the clause is optional

EclipseLink 2.4.2, build 'v20130514-5956486' API Reference