Top Description Constructors Methods
org.eclipse.persistence.jpa.jpql.tools

public Class EclipseLinkBasicRefactoringTool

extends BasicRefactoringTool
Class Inheritance
Imports
org.eclipse.persistence.jpa.jpql.parser.JPQLGrammar, org.eclipse.persistence.jpa.jpql.tools.spi.IManagedTypeProvider

This utility class provides basic refactoring support. This version adds support for EclipseLink specific extension over the default implementation of JPQL defined in the Java Persistence functional specification and it does not changes the StateObject but rather gather the changes in RefactoringDelta and it is the responsibility of the invoker to the actual change.

Provided functionality:

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.

Author
Pascal Filion
Since
2.4
Version
2.4
See Also
DefaultBasicRefactoringTool

Constructor Summary

AccessConstructor and Description
public
EclipseLinkBasicRefactoringTool(CharSequence
The JPQL query to manipulate
jpqlQuery
,
JPQLGrammar
The JPQLGrammar that was used to parse the JPQL query
jpqlGrammar
,
IManagedTypeProvider
The external form of a provider that gives access to the JPA metadata
managedTypeProvider
)

Creates a new EclipseLinkBasicRefactoringTool.

public
EclipseLinkBasicRefactoringTool(CharSequence
The JPQL query to manipulate or a single JPQL fragment, which is parsed using the JPQL query BNF identifier by the given ID
jpqlFragment
,
JPQLGrammar
The JPQLGrammar that was used to parse the JPQL fragment
jpqlGrammar
,
IManagedTypeProvider
The external form of a provider that gives access to the JPA metadata
managedTypeProvider
,
String
The unique identifier of the JPQLQueryBNF that determines how to parse the JPQL fragment
jpqlQueryBNFId
)

Creates a new EclipseLinkBasicRefactoringTool.

Method Summary

Modifier and TypeMethod and Description
protected JPQLQueryContext
buildJPQLQueryContext()

Implements abstract org.eclipse.persistence.jpa.jpql.tools.BasicRefactoringTool.buildJPQLQueryContext.

Creates a new JPQLQueryContext that can retrieve information from the declaration portion of the JPQL query.
Inherited from org.eclipse.persistence.jpa.jpql.tools.BasicRefactoringTool:
buildAttributeNameRenamerbuildClassNameRenamerbuildEntityNameRenamerbuildEnumConstantRenamerbuildResultVariableNameRenamerbuildVariableNameRenamergetDeltagetExpressiongetGrammargetQueryContexthasChangesrenameAttributerenameAttributerenameAttributerenameClassNamerenameEntityNamerenameEnumConstantrenameResultVariablerenameVariabletoActualText

Constructor Detail

EclipseLinkBasicRefactoringToolback to summary
public EclipseLinkBasicRefactoringTool(CharSequence jpqlQuery, JPQLGrammar jpqlGrammar, IManagedTypeProvider managedTypeProvider)

Creates a new EclipseLinkBasicRefactoringTool.

Parameters
jpqlQuery:CharSequence

The JPQL query to manipulate

jpqlGrammar:JPQLGrammar

The JPQLGrammar that was used to parse the JPQL query

managedTypeProvider:IManagedTypeProvider

The external form of a provider that gives access to the JPA metadata

EclipseLinkBasicRefactoringToolback to summary
public EclipseLinkBasicRefactoringTool(CharSequence jpqlFragment, JPQLGrammar jpqlGrammar, IManagedTypeProvider managedTypeProvider, String jpqlQueryBNFId)

Creates a new EclipseLinkBasicRefactoringTool.

Parameters
jpqlFragment:CharSequence

The JPQL query to manipulate or a single JPQL fragment, which is parsed using the JPQL query BNF identifier by the given ID

jpqlGrammar:JPQLGrammar

The JPQLGrammar that was used to parse the JPQL fragment

managedTypeProvider:IManagedTypeProvider

The external form of a provider that gives access to the JPA metadata

jpqlQueryBNFId:String

The unique identifier of the JPQLQueryBNF that determines how to parse the JPQL fragment

Method Detail

buildJPQLQueryContextback to summary
protected JPQLQueryContext buildJPQLQueryContext()

Implements abstract org.eclipse.persistence.jpa.jpql.tools.BasicRefactoringTool.buildJPQLQueryContext.

Doc from org.eclipse.persistence.jpa.jpql.tools.BasicRefactoringTool.buildJPQLQueryContext.

Creates a new JPQLQueryContext that can retrieve information from the declaration portion of the JPQL query.

Returns:JPQLQueryContext

A new concrete instance of JPQLQueryContext

Annotations
@Override