org.eclipse.persistence.jpa.jpql.tools

Class EclipseLinkRefactoringTool

java.lang.Object

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

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

org.eclipse.persistence.jpa.jpql.tools.EclipseLinkRefactoringTool

public class EclipseLinkRefactoringTool
extends RefactoringTool

This refactoring tool add support for EclipseLink specific extension over the default implementation of JPQL defined in the Java Persistence functional specification.

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

Author:

Pascal Filion

See Also:

DefaultRefactoringTool

Constructor Summary

Constructors

Constructor and Description
EclipseLinkRefactoringTool(IManagedTypeProvider managedTypeProvider, IJPQLQueryBuilder jpqlQueryBuilder, java.lang.CharSequence jpqlQuery) Creates a new EclipseLinkRefactoringTool.
EclipseLinkRefactoringTool(IManagedTypeProvider managedTypeProvider, IJPQLQueryBuilder jpqlQueryBuilder, java.lang.CharSequence jpqlFragment, java.lang.String jpqlQueryBNFId) Creates a new EclipseLinkRefactoringTool.

Method Summary

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

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

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

Constructor Detail

EclipseLinkRefactoringTool

public EclipseLinkRefactoringTool(IManagedTypeProvider managedTypeProvider,
                                  IJPQLQueryBuilder jpqlQueryBuilder,
                                  java.lang.CharSequence jpqlQuery)

Creates a new EclipseLinkRefactoringTool.

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

EclipseLinkRefactoringTool

public EclipseLinkRefactoringTool(IManagedTypeProvider managedTypeProvider,
                                  IJPQLQueryBuilder jpqlQueryBuilder,
                                  java.lang.CharSequence jpqlFragment,
                                  java.lang.String jpqlQueryBNFId)

Creates a new EclipseLinkRefactoringTool.

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