public interface ContentAssistProposals
Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.
Modifier and Type | Method and Description |
---|---|
IterableIterator<IEntity> |
abstractSchemaTypes()
Returns the collection of possible abstract schema types.
|
ResultQuery |
buildEscapedQuery(java.lang.String jpqlQuery,
java.lang.String proposal,
int position,
boolean insert)
Creates a new JPQL query by inserting the given proposal at the given position.
|
ResultQuery |
buildQuery(java.lang.String jpqlQuery,
java.lang.String proposal,
int position,
boolean insert)
Creates a new JPQL query by inserting the given proposal at the given position.
|
IEntity |
getAbstractSchemaType(java.lang.String identificationVariable)
Retrieves the abstract schema type that is mapped with the given identification variable.
|
IdentifierRole |
getIdentifierRole(java.lang.String identifier)
Returns the role of the given JPQL identifier.
|
boolean |
hasProposals()
Determines whether there is at least one proposals.
|
IterableIterator<java.lang.String> |
identificationVariables()
Returns the collection of possible identification variables.
|
IterableIterator<java.lang.String> |
identifiers()
Returns the collection of possible JPQL identifiers.
|
IterableIterator<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. |
IterableIterator<IEntity> abstractSchemaTypes()
entities
defined in the persistence contextResultQuery buildEscapedQuery(java.lang.String jpqlQuery, java.lang.String proposal, int position, boolean insert)
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".
jpqlQuery
- The JPQL query to modify with the given proposalproposal
- The proposal to insert into the queryposition
- The position of insertioninsert
- Flag that determines if the partial word following the cursor should be left
intact or should be replaced by the proposalResultQuery buildQuery(java.lang.String jpqlQuery, java.lang.String proposal, int position, boolean insert)
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".
jpqlQuery
- The JPQL query to modify with the given proposalproposal
- The proposal to insert into the queryposition
- The position of insertioninsert
- Flag that determines if the partial word following the cursor should be left
intact or should be replaced by the proposalIEntity getAbstractSchemaType(java.lang.String identificationVariable)
identificationVariable
- The identification variable that, if defined as a range variable,
will be mapped to a managed typenull
if the given variable is mapped to something else or not mapped to anythingIdentifierRole getIdentifierRole(java.lang.String identifier)
identifier
- The JPQL identifier to retrieve its roleIdentifierRole
for the given JPQL identifier or null
if no
role was defined or if the given string is not a valid JPQL identifierboolean hasProposals()
true
if there is at least one proposal; otherwise false
IterableIterator<java.lang.String> identificationVariables()
IterableIterator<java.lang.String> identifiers()
IterableIterator<IMapping> mappings()
mappings
, which can be state fields,
association fields and/or collection fields depending on the location used to retrieve the
possible proposals.mappings
EclipseLink 2.4.2, "build v20130514-5956486" API Reference