Module org.eclipse.persistence.jpa.jpql

Package org.eclipse.persistence.jpa.jpql.tools

Class AbstractContentAssistVisitor.AbstractFromClauseStatementHelper<T extends AbstractSelectStatement>

java.lang.Object

org.eclipse.persistence.jpa.jpql.tools.AbstractContentAssistVisitor.AbstractFromClauseStatementHelper<T>

All Implemented Interfaces:

AbstractContentAssistVisitor.StatementHelper<T>

Direct Known Subclasses:

AbstractContentAssistVisitor.FromClauseStatementHelper, AbstractContentAssistVisitor.SimpleFromClauseStatementHelper

Enclosing class:

AbstractContentAssistVisitor

protected abstract static class AbstractContentAssistVisitor.AbstractFromClauseStatementHelper<T extends AbstractSelectStatement>
extends Object
implements AbstractContentAssistVisitor.StatementHelper<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected final AbstractContentAssistVisitor	visitor	Enclosing visitor instance.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractFromClauseStatementHelper(AbstractContentAssistVisitor visitor)

Method Summary

Modifier and Type	Method	Description
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	hasSpaceAfterClause(T expression)	Determines whether there is a space (owned by the SELECT statement) after the clause being scanned by this helper.
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.tools.AbstractContentAssistVisitor.StatementHelper

getNextHelper

Field Details

visitor

protected final AbstractContentAssistVisitor visitor

Enclosing visitor instance.

Constructor Details

AbstractFromClauseStatementHelper

protected AbstractFromClauseStatementHelper(AbstractContentAssistVisitor visitor)

Method Details

addClauseProposals

public void addClauseProposals()

Description copied from interface: AbstractContentAssistVisitor.StatementHelper

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)

Description copied from interface: AbstractContentAssistVisitor.StatementHelper

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)

Description copied from interface: AbstractContentAssistVisitor.StatementHelper

Returns the clause being scanned by this helper. It is safe to type cast the clause because AbstractContentAssistVisitor.StatementHelper.hasClause(Expression) 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)

Description copied from interface: AbstractContentAssistVisitor.StatementHelper

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

hasSpaceAfterClause

public boolean hasSpaceAfterClause(T expression)

Description copied from interface: AbstractContentAssistVisitor.StatementHelper

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.StatementHelper<T extends AbstractSelectStatement>

Parameters:

expression - The AbstractSelectStatement being visited

Returns:

true if a space follows the clause; false otherwise

isClauseComplete

public boolean isClauseComplete(T expression)

Description copied from interface: AbstractContentAssistVisitor.StatementHelper

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()

Description copied from interface: AbstractContentAssistVisitor.StatementHelper

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