Module org.eclipse.persistence.jpa.jpql

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

Class DefaultRefactoringTool

java.lang.Object

org.eclipse.persistence.jpa.jpql.tools.AbstractRefactoringTool

org.eclipse.persistence.jpa.jpql.tools.RefactoringTool

org.eclipse.persistence.jpa.jpql.tools.DefaultRefactoringTool

public class DefaultRefactoringTool
extends RefactoringTool

This utility class provides basic refactoring support.

Provided functionality:

• Renaming an identification variable;
• Renaming a state field or collection-valued field;
• Renaming an entity name;
• Renaming a Class name (e.g.: in constructor expression);
• Renaming an Enum constant.

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.

Since:

2.4

Version:

2.4

See Also:

• EclipseLinkRefactoringTool

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.persistence.jpa.jpql.tools.RefactoringTool

RefactoringTool.ClassNameRenamer, RefactoringTool.EntityNameRenamer, RefactoringTool.EnumConstantRenamer, RefactoringTool.FieldNameRenamer, RefactoringTool.ResultVariableNameRenamer, RefactoringTool.StateObjectUpdater<T extends StateObject>, RefactoringTool.VariableNameRenamer

Constructor Summary

Constructors

Constructor	Description
DefaultRefactoringTool(IManagedTypeProvider managedTypeProvider, IJPQLQueryBuilder jpqlQueryBuilder, CharSequence jpqlQuery)	Creates a new RefactoringTool.
DefaultRefactoringTool(IManagedTypeProvider managedTypeProvider, IJPQLQueryBuilder jpqlQueryBuilder, CharSequence jpqlFragment, String jpqlQueryBNFId)	Creates a new RefactoringTool.

Method Summary

Modifier and Type	Method	Description
protected IJPQLQueryFormatter	buildFormatter()	Creates a new formatter that will convert the StateObject representation of the JPQL query, once the refactoring occurred into a string.
protected JPQLQueryContext	buildJPQLQueryContext()	Creates a new JPQLQueryContext that can retrieve information from the declaration portion of the JPQL query.

Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.RefactoringTool

buildClassNameRenamer, buildEntityNameRenamer, buildEnumConstantRenamer, buildFieldNameRenamer, buildResultVariableNameRenamer, buildStateObject, buildVariableNameRenamer, getFormatter, getGrammar, getJPQLQueryBuilder, getStateObject, renameClassName, renameEntityName, renameEnumConstant, renameField, renameField, renameField, renameResultVariable, renameVariable, setFormatter, toActualText

Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.AbstractRefactoringTool

getJPQLFragment, getJPQLQueryBNFId, getManagedTypeProvider, isTolerant, setTolerant

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultRefactoringTool

public DefaultRefactoringTool(IManagedTypeProvider managedTypeProvider,
 IJPQLQueryBuilder jpqlQueryBuilder,
 CharSequence jpqlQuery)

Creates a new RefactoringTool.

Parameters:

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

jpqlQueryBuilder - The builder that creates the StateObject representation of the JPQL query

jpqlQuery - The JPQL query to manipulate

DefaultRefactoringTool

public DefaultRefactoringTool(IManagedTypeProvider managedTypeProvider,
 IJPQLQueryBuilder jpqlQueryBuilder,
 CharSequence jpqlFragment,
 String jpqlQueryBNFId)

Creates a new RefactoringTool.

Parameters:

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

jpqlQueryBuilder - The builder that creates the StateObject representation of the JPQL query

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

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

Method Details

buildFormatter

protected IJPQLQueryFormatter buildFormatter()

Description copied from class: RefactoringTool

Creates a new formatter that will convert the StateObject representation of the JPQL query, once the refactoring occurred into a string.

Specified by:

buildFormatter in class RefactoringTool

Returns:

A new concrete instance of IJPQLQueryFormatter

buildJPQLQueryContext

protected JPQLQueryContext buildJPQLQueryContext()

Description copied from class: RefactoringTool

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

NOTE: This is temporary because the StateObject API does not have that knowledge yet.

Specified by:

buildJPQLQueryContext in class RefactoringTool

Returns:

A new concrete instance of JPQLQueryContext