Class RefactoringTool
- java.lang.Object
-
- org.eclipse.persistence.jpa.jpql.tools.AbstractRefactoringTool
-
- org.eclipse.persistence.jpa.jpql.tools.RefactoringTool
-
- Direct Known Subclasses:
DefaultRefactoringTool,EclipseLinkRefactoringTool
public abstract class RefactoringTool extends AbstractRefactoringTool
The abstract implementation providing refactoring support for JPQL queries.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.
- Version:
- 2.4
- See Also:
DefaultRefactoringTool,EclipseLinkRefactoringTool- Author:
- Pascal Filion
- Since:
- 2.4
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static classRefactoringTool.ClassNameRenamerThis visitor renames a fully qualified class name.protected static classRefactoringTool.EntityNameRenamerThis visitor renames an entity name.protected static classRefactoringTool.EnumConstantRenamerThis visitor renames an enum constant.protected static classRefactoringTool.FieldNameRenamerThis visitor renames any segment of a path expression.protected static classRefactoringTool.ResultVariableNameRenamerThis visitor renames all the result variables found in the JPQL query.protected static interfaceRefactoringTool.StateObjectUpdater<T extends StateObject>This interface is used to transparently push the new value into theStateObject.protected static classRefactoringTool.VariableNameRenamerThis visitor renames all the identification variables found in the JPQL query.
-
Constructor Summary
Constructors Modifier Constructor Description protectedRefactoringTool(IManagedTypeProvider managedTypeProvider, IJPQLQueryBuilder jpqlQueryBuilder, java.lang.CharSequence jpqlQuery)Creates a newRefactoringTool.protectedRefactoringTool(IManagedTypeProvider managedTypeProvider, IJPQLQueryBuilder jpqlQueryBuilder, java.lang.CharSequence jpqlFragment, java.lang.String jpqlQueryBNFId)Creates a newRefactoringTool.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected RefactoringTool.ClassNameRenamerbuildClassNameRenamer(java.lang.String oldClassName, java.lang.String newClassName)Creates the visitor that will traverse theStateObjectrepresentation of the JPQL query and will rename the fully qualified class name.protected RefactoringTool.EntityNameRenamerbuildEntityNameRenamer(java.lang.String oldEntityName, java.lang.String newEntityName)Creates the visitor that will traverse theStateObjectrepresentation of the JPQL query and will rename the entity name.protected RefactoringTool.EnumConstantRenamerbuildEnumConstantRenamer(java.lang.String oldClassName, java.lang.String newClassName)Creates the visitor that will traverse theStateObjectrepresentation of the JPQL query and will rename the enum constant.protected RefactoringTool.FieldNameRenamerbuildFieldNameRenamer(java.lang.String typeName, java.lang.String oldFieldName, java.lang.String newFieldName)Creates the visitor that will traverse theStateObjectrepresentation of the JPQL query and will rename a type's attribute name.protected abstract IJPQLQueryFormatterbuildFormatter()Creates a new formatter that will convert theStateObjectrepresentation of the JPQL query, once the refactoring occurred into a string.protected abstract JPQLQueryContextbuildJPQLQueryContext()Creates a newJPQLQueryContextthat can retrieve information from the declaration portion of the JPQL query.protected RefactoringTool.ResultVariableNameRenamerbuildResultVariableNameRenamer(java.lang.String oldVariableName, java.lang.String newVariableName)Creates the visitor that will traverse theStateObjectrepresentation of the JPQL query and will rename a result variable.protected JPQLQueryStateObjectbuildStateObject()Creates theStateObjectrepresentation of the JPQL fragment to manipulate.protected RefactoringTool.VariableNameRenamerbuildVariableNameRenamer(java.lang.String oldVariableName, java.lang.String newVariableName)Creates the visitor that will traverse theStateObjectrepresentation of the JPQL query and will rename an identification variable.IJPQLQueryFormattergetFormatter()Returns theIJPQLQueryFormatterthat creates an accurate representation of theStateObject, i.e. that output the JPQL query with the case used for the JPQL identifier.JPQLGrammargetGrammar()Returns theJPQLGrammarthat is associated with this builder.IJPQLQueryBuildergetJPQLQueryBuilder()Returns the builder that creates theStateObjectrepresentation of the JPQL query.JPQLQueryStateObjectgetStateObject()Returns theStateObjectrepresentation of the JPQL query or JPQL fragment that was parsed.voidrenameClassName(java.lang.String oldClassName, java.lang.String newClassName)Renames a fully qualified class name.voidrenameEntityName(java.lang.String oldEntityName, java.lang.String newEntityName)Renames a given entity name.voidrenameEnumConstant(java.lang.String oldEnumConstant, java.lang.String newEnumConstant)Renames an enum constant, which has to be fully qualified.voidrenameField(java.lang.Class<?> type, java.lang.String oldFieldName, java.lang.String newFieldName)Renames a field from the given type.voidrenameField(java.lang.String typeName, java.lang.String oldFieldName, java.lang.String newFieldName)Renames a field from the given type.voidrenameField(IType type, java.lang.String oldFieldName, java.lang.String newFieldName)Renames a field from the given type.voidrenameResultVariable(java.lang.String oldVariableName, java.lang.String newVariableName)Renames a result variable name.voidrenameVariable(java.lang.String oldVariableName, java.lang.String newVariableName)Renames a variable name.voidsetFormatter(IJPQLQueryFormatter jpqlQueryFormatter)Sets theIJPQLQueryFormatterthat creates an accurate representation of theStateObject, i.e. that output the JPQL query with the case used for the JPQL identifier.java.lang.StringtoActualText()Returns the resulted of the refactoring operations.-
Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.AbstractRefactoringTool
getJPQLFragment, getJPQLQueryBNFId, getManagedTypeProvider, isTolerant, setTolerant
-
-
-
-
Constructor Detail
-
RefactoringTool
protected RefactoringTool(IManagedTypeProvider managedTypeProvider, IJPQLQueryBuilder jpqlQueryBuilder, java.lang.CharSequence jpqlQuery)
Creates a newRefactoringTool.- Parameters:
managedTypeProvider- The external form of a provider that gives access to the JPA metadatajpqlQueryBuilder- The builder that creates theStateObjectrepresentation of the JPQL queryjpqlQuery- The JPQL query to manipulate
-
RefactoringTool
protected RefactoringTool(IManagedTypeProvider managedTypeProvider, IJPQLQueryBuilder jpqlQueryBuilder, java.lang.CharSequence jpqlFragment, java.lang.String jpqlQueryBNFId)
Creates a newRefactoringTool.- Parameters:
managedTypeProvider- The external form of a provider that gives access to the JPA metadatajpqlQueryBuilder- The builder that creates theStateObjectrepresentation of the JPQL queryjpqlFragment- The JPQL query to manipulate or a single JPQL fragment, which is parsed using the JPQL query BNF identifier by the given IDjpqlQueryBNFId- The unique identifier of theJPQLQueryBNFthat determines how to parse the JPQL fragment
-
-
Method Detail
-
buildClassNameRenamer
protected RefactoringTool.ClassNameRenamer buildClassNameRenamer(java.lang.String oldClassName, java.lang.String newClassName)
Creates the visitor that will traverse theStateObjectrepresentation of the JPQL query and will rename the fully qualified class name.- Parameters:
oldClassName- The current name of the class to renamenewClassName- The new name of the class- Returns:
- A new
RefactoringTool.ClassNameRenamer
-
buildEntityNameRenamer
protected RefactoringTool.EntityNameRenamer buildEntityNameRenamer(java.lang.String oldEntityName, java.lang.String newEntityName)
Creates the visitor that will traverse theStateObjectrepresentation of the JPQL query and will rename the entity name.- Parameters:
oldEntityName- The current name of the entity to renamenewEntityName- The new name of the entity- Returns:
- A new
RefactoringTool.EntityNameRenamer
-
buildEnumConstantRenamer
protected RefactoringTool.EnumConstantRenamer buildEnumConstantRenamer(java.lang.String oldClassName, java.lang.String newClassName)
Creates the visitor that will traverse theStateObjectrepresentation of the JPQL query and will rename the enum constant.- Parameters:
oldClassName- The new name of the enum constantnewClassName- The current name of the enum constant to rename- Returns:
- A new
RefactoringTool.EnumConstantRenamer
-
buildFieldNameRenamer
protected RefactoringTool.FieldNameRenamer buildFieldNameRenamer(java.lang.String typeName, java.lang.String oldFieldName, java.lang.String newFieldName)
Creates the visitor that will traverse theStateObjectrepresentation of the JPQL query and will rename a type's attribute name.- Parameters:
typeName- The fully qualified name of the type that got one of its attributes renamedoldFieldName- The current name of the attribute to renamenewFieldName- The new name of the attribute- Returns:
- A new
AttributeNameRenamer
-
buildFormatter
protected abstract IJPQLQueryFormatter buildFormatter()
Creates a new formatter that will convert theStateObjectrepresentation of the JPQL query, once the refactoring occurred into a string.- Returns:
- A new concrete instance of
IJPQLQueryFormatter
-
buildJPQLQueryContext
protected abstract JPQLQueryContext buildJPQLQueryContext()
Creates a newJPQLQueryContextthat can retrieve information from the declaration portion of the JPQL query.NOTE: This is temporary because the
StateObjectAPI does not have that knowledge yet.- Returns:
- A new concrete instance of
JPQLQueryContext
-
buildResultVariableNameRenamer
protected RefactoringTool.ResultVariableNameRenamer buildResultVariableNameRenamer(java.lang.String oldVariableName, java.lang.String newVariableName)
Creates the visitor that will traverse theStateObjectrepresentation of the JPQL query and will rename a result variable.- Parameters:
oldVariableName- The current result variable namenewVariableName- The new name of the result variable- Returns:
- A new
RefactoringTool.ResultVariableNameRenamer
-
buildStateObject
protected JPQLQueryStateObject buildStateObject()
Creates theStateObjectrepresentation of the JPQL fragment to manipulate.- Returns:
- The parsed and editable JPQL query
- See Also:
getStateObject()
-
buildVariableNameRenamer
protected RefactoringTool.VariableNameRenamer buildVariableNameRenamer(java.lang.String oldVariableName, java.lang.String newVariableName)
Creates the visitor that will traverse theStateObjectrepresentation of the JPQL query and will rename an identification variable.- Parameters:
oldVariableName- The current identification variable namenewVariableName- The new name of the identification variable- Returns:
- A new
RefactoringTool.VariableNameRenamer
-
getFormatter
public IJPQLQueryFormatter getFormatter()
Returns theIJPQLQueryFormatterthat creates an accurate representation of theStateObject, i.e. that output the JPQL query with the case used for the JPQL identifier.- Returns:
- An instance of
IJPQLQueryFormatter
-
getGrammar
public JPQLGrammar getGrammar()
Returns theJPQLGrammarthat is associated with this builder.- Returns:
- The
JPQLGrammarthat was used to parse the JPQL query or JPQL fragments
-
getJPQLQueryBuilder
public IJPQLQueryBuilder getJPQLQueryBuilder()
Returns the builder that creates theStateObjectrepresentation of the JPQL query.- Returns:
- The builder of the
StateObjectto be manipulated
-
getStateObject
public JPQLQueryStateObject getStateObject()
Returns theStateObjectrepresentation of the JPQL query or JPQL fragment that was parsed.- Returns:
- The editable state model
-
renameClassName
public void renameClassName(java.lang.String oldClassName, java.lang.String newClassName)Renames a fully qualified class name.- Parameters:
oldClassName- The current fully qualified class name of the class to renamenewClassName- The new fully qualified class name
-
renameEntityName
public void renameEntityName(java.lang.String oldEntityName, java.lang.String newEntityName)Renames a given entity name.- Parameters:
oldEntityName- The current name of the entity to renamenewEntityName- The new name of the entity
-
renameEnumConstant
public void renameEnumConstant(java.lang.String oldEnumConstant, java.lang.String newEnumConstant)Renames an enum constant, which has to be fully qualified.- Parameters:
oldEnumConstant- The current fully qualified name of the enum constant to renamenewEnumConstant- The new fully qualified name of the enum constant
-
renameField
public void renameField(java.lang.Class<?> type, java.lang.String oldFieldName, java.lang.String newFieldName)Renames a field from the given type.- Parameters:
type- The Java class from which the change originateoldFieldName- The current name of the attribute to renamenewFieldName- The new name of the attribute
-
renameField
public void renameField(IType type, java.lang.String oldFieldName, java.lang.String newFieldName)
Renames a field from the given type.- Parameters:
type- TheITypefrom which the change originateoldFieldName- The current name of the attribute to renamenewFieldName- The new name of the attribute
-
renameField
public void renameField(java.lang.String typeName, java.lang.String oldFieldName, java.lang.String newFieldName)Renames a field from the given type.- Parameters:
typeName- The fully qualified name of the type that got one of its attributes renamedoldFieldName- The current name of the attribute to renamenewFieldName- The new name of the attribute
-
renameResultVariable
public void renameResultVariable(java.lang.String oldVariableName, java.lang.String newVariableName)Renames a result variable name.- Parameters:
oldVariableName- The current identification variable namenewVariableName- The new name of the identification variable
-
renameVariable
public void renameVariable(java.lang.String oldVariableName, java.lang.String newVariableName)Renames a variable name.- Parameters:
oldVariableName- The current identification variable namenewVariableName- The new name of the identification variable
-
setFormatter
public void setFormatter(IJPQLQueryFormatter jpqlQueryFormatter)
Sets theIJPQLQueryFormatterthat creates an accurate representation of theStateObject, i.e. that output the JPQL query with the case used for the JPQL identifier.- Parameters:
jpqlQueryFormatter- This formatter converts aStateObjectrepresentation of the JPQL query into a string representation
-
toActualText
public java.lang.String toActualText()
Returns the resulted of the refactoring operations. The list of changes will be removed after applying the changes.- Specified by:
toActualTextin classAbstractRefactoringTool- Returns:
- The string representation of the JPQL query that contains the changes
-
-