Modifier and Type	Class and Description
public static enum	ContentAssistProposals.ClassType This enumeration determines the type of classes returned by `ContentAssistProposals#classNames()`.
public static interface	ContentAssistProposals.EnumProposals Holds onto the `IType` of the enum type and the list of possible enum constants.

Method Summary

Modifier and Type	Method and Description
public Iterable<IEntity>	Returns: The `entities` defined in the persistence context abstractSchemaTypes() Returns the collection of possible abstract schema types.
public ResultQuery	Returns: The result of inserting the proposal into the query, including the adjust position, if it was required buildEscapedQuery(String The JPQL query to modify with the given proposal jpqlQuery, String The proposal to insert into the query proposal, int The position of insertion position, boolean Flag that determines if the partial word following the cursor should be left intact or should be replaced by the proposal insert) Creates a new JPQL query by inserting the given proposal at the given position.
public ResultQuery	Returns: The result of inserting the proposal into the query, including the adjust position, if it was required buildQuery(String The JPQL query to modify with the given proposal jpqlQuery, String The proposal to insert into the query proposal, int The position of insertion position, boolean Flag that determines if the partial word following the cursor should be left intact or should be replaced by the proposal insert) Creates a new JPQL query by inserting the given proposal at the given position.
public ResultQuery	Returns: The result of inserting the proposal into the query, including the adjust position, if it was required buildXmlQuery(String The JPQL query to modify with the given proposal, which should be the non- converted string, i.e. any escaped characters should not be converted jpqlQuery, String The proposal to insert into the query proposal, int The position of insertion, which was derived from the parsed tree representation of the JPQL query position, boolean Flag that determines if the partial word following the cursor should be left intact or should be replaced by the proposal insert) Creates a new JPQL query by inserting the given proposal at the given position.
public Iterable<String>	Returns: The filtered list of possible class names classNames() Returns the filtered list of possible class names.
public Iterable<String>	Returns: The filtered list of possible column names columnNames() Returns the filtered list of possible column names.
public Iterable<ContentAssistProposals.EnumProposals>	Returns: The filtered list of possible enum constant names associated with its enum type enumConstant() Returns the filtered list of possible enum constant names.
public IEntity	Returns: The abstract schema type mapped with the given identification variable or `null` if the given variable is mapped to something else or not mapped to anything getAbstractSchemaType(String The identification variable that, if defined as a range variable, will be mapped to a managed type identificationVariable) Retrieves the abstract schema type that is mapped with the given identification variable.
public ContentAssistProposals.ClassType	getClassType()
public IdentifierRole	Returns: The `IdentifierRole` for the given JPQL identifier or `null` if no role was defined or if the given string is not a valid JPQL identifier getIdentifierRole(String The JPQL identifier to retrieve its role identifier) Returns the role of the given JPQL identifier.
public boolean	Returns: `true` if there is at least one proposal; otherwise `false` hasProposals() Determines whether there is at least one proposals.
public Iterable<String>	Returns: The list of possible identification variables identificationVariables() Returns the collection of possible identification variables.
public Iterable<String>	Returns: The list of possible JPQL identifiers identifiers() Returns the collection of possible JPQL identifiers.
public Iterable<IMapping>	Returns: The list of possible proposals `mappings` mappings() Returns the collection of possible `mappings`, which can be state fields, association fields and/or collection fields depending on the location used to retrieve the possible proposals.
public Iterable<String>	Returns: The filtered list of possible table names tableNames() Returns the filtered list of possible table names.

Method Detail

abstractSchemaTypes back to summary

abstractSchemaTypes	back to summary
public Iterable<IEntity> abstractSchemaTypes() Returns the collection of possible abstract schema types. Returns:Iterable<IEntity> The `entities` defined in the persistence context

public Iterable<IEntity> abstractSchemaTypes()

Returns the collection of possible abstract schema types.

Returns:Iterable<IEntity>: The entities defined in the persistence context

buildEscapedQuery	back to summary
public ResultQuery buildEscapedQuery(String jpqlQuery, String proposal, int position, boolean insert) Creates a new JPQL query by inserting the given proposal at the given position. The updated JPQL query and position will be adjusted by converting some characters into their corresponding escaped characters, for instance '\r' will be converted to '\\r. The replacement will also handle compound JPQL identifiers when updating the JPQL query. Example: If the cursor is within "IS NOT N\|" and the proposal is "IS NOT NULL", then "IS NOT" will not be added twice. If the word to replace is "IS NULL" and the proposal is "IS NOT NULL", then "NOT" will be inserted between "IS" and "NULL". Parameters jpqlQuery:String The JPQL query to modify with the given proposal proposal:String The proposal to insert into the query position:int The position of insertion insert:boolean Flag that determines if the partial word following the cursor should be left intact or should be replaced by the proposal Returns:ResultQuery The result of inserting the proposal into the query, including the adjust position, if it was required

buildEscapedQuery

back to summary

public ResultQuery buildEscapedQuery(String jpqlQuery, String proposal, int position, boolean insert)

Creates a new JPQL query by inserting the given proposal at the given position. The updated JPQL query and position will be adjusted by converting some characters into their corresponding escaped characters, for instance '\r' will be converted to '\\r.

The replacement will also handle compound JPQL identifiers when updating the JPQL query.

Example: If the cursor is within "IS NOT N|" and the proposal is "IS NOT NULL", then "IS NOT" will not be added twice. If the word to replace is "IS NULL" and the proposal is "IS NOT NULL", then "NOT" will be inserted between "IS" and "NULL".

Parameters

jpqlQuery:String: The JPQL query to modify with the given proposal
proposal:String: The proposal to insert into the query
position:int: The position of insertion
insert:boolean: Flag that determines if the partial word following the cursor should be left intact or should be replaced by the proposal

Returns:ResultQuery

The result of inserting the proposal into the query, including the adjust position, if it was required

buildQuery	back to summary
public ResultQuery buildQuery(String jpqlQuery, String proposal, int position, boolean insert) Creates a new JPQL query by inserting the given proposal at the given position. The replacement will also handle compound JPQL identifiers when updating the JPQL query. Example: If the cursor is within "IS NOT N\|" and the proposal is "IS NOT NULL", then "IS NOT" will not be added twice. If the word to replace is "IS NULL" and the proposal is "IS NOT NULL", then "NOT" will be inserted between "IS" and "NULL". Parameters jpqlQuery:String The JPQL query to modify with the given proposal proposal:String The proposal to insert into the query position:int The position of insertion insert:boolean Flag that determines if the partial word following the cursor should be left intact or should be replaced by the proposal Returns:ResultQuery The result of inserting the proposal into the query, including the adjust position, if it was required

buildQuery

back to summary

public ResultQuery buildQuery(String jpqlQuery, String proposal, int position, boolean insert)

Creates a new JPQL query by inserting the given proposal at the given position.

The replacement will also handle compound JPQL identifiers when updating the JPQL query.

Parameters

jpqlQuery:String: The JPQL query to modify with the given proposal
proposal:String: The proposal to insert into the query
position:int: The position of insertion
insert:boolean: Flag that determines if the partial word following the cursor should be left intact or should be replaced by the proposal

Returns:ResultQuery

The result of inserting the proposal into the query, including the adjust position, if it was required

buildXmlQuery	back to summary
public ResultQuery buildXmlQuery(String jpqlQuery, String proposal, int position, boolean insert) Creates a new JPQL query by inserting the given proposal at the given position. The updated JPQL query and position will be adjusted by converting some characters into their corresponding escaped characters, for instance '>' will be converted to '>'. The replacement will also handle compound JPQL identifiers when updating the JPQL query. Example: If the cursor is within "IS NOT N\|" and the proposal is "IS NOT NULL", then "IS NOT" will not be added twice. If the word to replace is "IS NULL" and the proposal is "IS NOT NULL", then "NOT" will be inserted between "IS" and "NULL". Parameters jpqlQuery:String The JPQL query to modify with the given proposal, which should be the non- converted string, i.e. any escaped characters should not be converted proposal:String The proposal to insert into the query position:int The position of insertion, which was derived from the parsed tree representation of the JPQL query insert:boolean Flag that determines if the partial word following the cursor should be left intact or should be replaced by the proposal Returns:ResultQuery The result of inserting the proposal into the query, including the adjust position, if it was required Since 2.5

buildXmlQuery

back to summary

public ResultQuery buildXmlQuery(String jpqlQuery, String proposal, int position, boolean insert)

The replacement will also handle compound JPQL identifiers when updating the JPQL query.

Parameters

jpqlQuery:String: The JPQL query to modify with the given proposal, which should be the non- converted string, i.e. any escaped characters should not be converted
proposal:String: The proposal to insert into the query
position:int: The position of insertion, which was derived from the parsed tree representation of the JPQL query
insert:boolean: Flag that determines if the partial word following the cursor should be left intact or should be replaced by the proposal

Returns:ResultQuery

The result of inserting the proposal into the query, including the adjust position, if it was required

Since

2.5

classNames back to summary

classNames	back to summary
public Iterable<String> classNames() Returns the filtered list of possible class names. This is usually available when the cursor is within the constructor name of the constructor expression. Returns:Iterable<String> The filtered list of possible class names Since 2.5 See Also `org.eclipse.persistence.jpa.jpql.parser.ConstructorExpression`

public Iterable<String> classNames()

Returns the filtered list of possible class names. This is usually available when the cursor is within the constructor name of the constructor expression.

Returns:Iterable<String>: The filtered list of possible class names
Since: 2.5
See Also: org.eclipse.persistence.jpa.jpql.parser.ConstructorExpression

columnNames	back to summary
public Iterable<String> columnNames() Returns the filtered list of possible column names. Returns:Iterable<String> The filtered list of possible column names Since 2.5

columnNames

back to summary

public Iterable<String> columnNames()

Returns the filtered list of possible column names.

Returns:Iterable<String>: The filtered list of possible column names
Since: 2.5

enumConstant	back to summary
public Iterable<ContentAssistProposals.EnumProposals> enumConstant() Returns the filtered list of possible enum constant names. This is usually available when the cursor is after the dot separating a fully qualified enum type and the enum constant. Returns:Iterable<ContentAssistProposals.EnumProposals> The filtered list of possible enum constant names associated with its enum type Since 2.5

enumConstant

back to summary

public Iterable<ContentAssistProposals.EnumProposals> enumConstant()

Returns the filtered list of possible enum constant names. This is usually available when the cursor is after the dot separating a fully qualified enum type and the enum constant.

Returns:Iterable<ContentAssistProposals.EnumProposals>: The filtered list of possible enum constant names associated with its enum type
Since: 2.5

getAbstractSchemaType back to summary

getAbstractSchemaType	back to summary
public IEntity getAbstractSchemaType(String identificationVariable) Retrieves the abstract schema type that is mapped with the given identification variable. Parameters identificationVariable:String The identification variable that, if defined as a range variable, will be mapped to a managed type Returns:IEntity The abstract schema type mapped with the given identification variable or `null` if the given variable is mapped to something else or not mapped to anything

public IEntity getAbstractSchemaType(String identificationVariable)

Retrieves the abstract schema type that is mapped with the given identification variable.

Parameters

identificationVariable:String: The identification variable that, if defined as a range variable, will be mapped to a managed type

Returns:IEntity

The abstract schema type mapped with the given identification variable or null if the given variable is mapped to something else or not mapped to anything

getClassType	back to summary
public ContentAssistProposals.ClassType getClassType() Since 2.5

getIdentifierRole back to summary

getIdentifierRole	back to summary
public IdentifierRole getIdentifierRole(String identifier) Returns the role of the given JPQL identifier. Parameters identifier:String The JPQL identifier to retrieve its role Returns:IdentifierRole The `IdentifierRole` for the given JPQL identifier or `null` if no role was defined or if the given string is not a valid JPQL identifier Since 2.4

public IdentifierRole getIdentifierRole(String identifier)

Returns the role of the given JPQL identifier.

Parameters

identifier:String: The JPQL identifier to retrieve its role

Returns:IdentifierRole

The IdentifierRole for the given JPQL identifier or null if no role was defined or if the given string is not a valid JPQL identifier

Since

2.4

hasProposals back to summary

hasProposals	back to summary
public boolean hasProposals() Determines whether there is at least one proposals. Returns:boolean `true` if there is at least one proposal; otherwise `false`

public boolean hasProposals()

Determines whether there is at least one proposals.

Returns:boolean: true if there is at least one proposal; otherwise false

identificationVariables	back to summary
public Iterable<String> identificationVariables() Returns the collection of possible identification variables. Returns:Iterable<String> The list of possible identification variables

identificationVariables

back to summary

public Iterable<String> identificationVariables()

Returns the collection of possible identification variables.

Returns:Iterable<String>: The list of possible identification variables

identifiers	back to summary
public Iterable<String> identifiers() Returns the collection of possible JPQL identifiers. Returns:Iterable<String> The list of possible JPQL identifiers

identifiers

back to summary

public Iterable<String> identifiers()

Returns the collection of possible JPQL identifiers.

Returns:Iterable<String>: The list of possible JPQL identifiers

mappings back to summary

mappings	back to summary
public Iterable<IMapping> mappings() Returns the collection of possible `mappings`, which can be state fields, association fields and/or collection fields depending on the location used to retrieve the possible proposals. Returns:Iterable<IMapping> The list of possible proposals `mappings`

public Iterable<IMapping> mappings()

Returns the collection of possible mappings, which can be state fields, association fields and/or collection fields depending on the location used to retrieve the possible proposals.

Returns:Iterable<IMapping>: The list of possible proposals mappings

tableNames	back to summary
public Iterable<String> tableNames() Returns the filtered list of possible table names. Returns:Iterable<String> The filtered list of possible table names Since 2.5

tableNames

back to summary

public Iterable<String> tableNames()

Returns the filtered list of possible table names.

Returns:Iterable<String>: The filtered list of possible table names
Since: 2.5

org.eclipse.persistence.jpa.jpql.tools back to summary

public final Enum ContentAssistProposals.ClassType

Class Inheritance

extends Enum<ContentAssistProposals.ClassType>

java.lang.Object
java.lang.Enum
org.eclipse.persistence.jpa.jpql.tools.ContentAssistProposals.ClassType

This enumeration determines the type of classes returned by ContentAssistProposals#classNames().

Field Summary

Modifier and Type	Field and Description
public static final ContentAssistProposals.ClassType	ENUM Indicates the only class type allowed is an enum type.
public static final ContentAssistProposals.ClassType	INSTANTIABLE Indicates the class has to be instantiable, i.e. anonymous, interfaces, enums, annotations are not allowed.

Constructor Summary

Access	Constructor and Description
private	ClassType()

Method Summary

Modifier and Type	Method and Description
public static ContentAssistProposals.ClassType	valueOf(String name)
public static ContentAssistProposals.ClassType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ENUM	back to summary
public static final ContentAssistProposals.ClassType ENUM Indicates the only class type allowed is an enum type.

INSTANTIABLE	back to summary
public static final ContentAssistProposals.ClassType INSTANTIABLE Indicates the class has to be instantiable, i.e. anonymous, interfaces, enums, annotations are not allowed.

Constructor Detail

ClassType	back to summary
private ClassType()

Method Detail

valueOf	back to summary
public static ContentAssistProposals.ClassType valueOf(String name)

values	back to summary
public static ContentAssistProposals.ClassType[] values()

public Interface ContentAssistProposals

Nested and Inner Type Summary

Method Summary

Method Detail

public final Enum ContentAssistProposals.ClassType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface ContentAssistProposals.EnumProposals

Method Summary

Method Detail

Modifier and Type	Method and Description
public Iterable<String>	enumConstants() Returns the list of enum constants that have been filtered.
public IType	Returns: The `IType` representing the enum type enumType() The `IType` representing the enum type.