EclipseLink 2.4.2, build 'v20130514-5956486' API Reference

org.eclipse.persistence.jpa.jpql
Class EclipseLinkBasicRefactoringTool

java.lang.Object
  extended by org.eclipse.persistence.jpa.jpql.AbstractRefactoringTool
      extended by org.eclipse.persistence.jpa.jpql.BasicRefactoringTool
          extended by org.eclipse.persistence.jpa.jpql.EclipseLinkBasicRefactoringTool

public class EclipseLinkBasicRefactoringTool
extends BasicRefactoringTool

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 model.query.StateObject 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.

Version:
2.4
See Also:
DefaultBasicRefactoringTool
Author:
Pascal Filion
Since:
2.4

Nested Class Summary
 
Nested classes/interfaces inherited from class org.eclipse.persistence.jpa.jpql.BasicRefactoringTool
BasicRefactoringTool.AbstractRenamer, BasicRefactoringTool.ClassNameRenamer, BasicRefactoringTool.EntityNameRenamer, BasicRefactoringTool.EnumConstantRenamer, BasicRefactoringTool.FieldNameRenamer, BasicRefactoringTool.ResultVariableNameRenamer, BasicRefactoringTool.VariableNameRenamer
 
Constructor Summary
EclipseLinkBasicRefactoringTool(java.lang.CharSequence jpqlQuery, JPQLGrammar jpqlGrammar, IManagedTypeProvider managedTypeProvider)
          Creates a new EclipseLinkBasicRefactoringTool.
EclipseLinkBasicRefactoringTool(java.lang.CharSequence jpqlFragment, JPQLGrammar jpqlGrammar, IManagedTypeProvider managedTypeProvider, java.lang.String jpqlQueryBNFId)
          Creates a new EclipseLinkBasicRefactoringTool.
 
Method Summary
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.BasicRefactoringTool
buildClassNameRenamer, buildEntityNameRenamer, buildEnumConstantRenamer, buildFieldNameRenamer, buildResultVariableNameRenamer, buildVariableNameRenamer, getDelta, getExpression, getGrammar, getQueryContext, hasChanges, renameClassName, renameEntityName, renameEnumConstant, renameField, renameField, renameField, renameResultVariable, renameVariable, toActualText
 
Methods inherited from class org.eclipse.persistence.jpa.jpql.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 Detail

EclipseLinkBasicRefactoringTool

public EclipseLinkBasicRefactoringTool(java.lang.CharSequence jpqlQuery,
                                       JPQLGrammar jpqlGrammar,
                                       IManagedTypeProvider managedTypeProvider)
Creates a new EclipseLinkBasicRefactoringTool.

Parameters:
jpqlQuery - The JPQL query to manipulate
jpqlGrammar - The JPQLGrammar that was used to parse the JPQL query
managedTypeProvider - The external form of a provider that gives access to the JPA metadata

EclipseLinkBasicRefactoringTool

public EclipseLinkBasicRefactoringTool(java.lang.CharSequence jpqlFragment,
                                       JPQLGrammar jpqlGrammar,
                                       IManagedTypeProvider managedTypeProvider,
                                       java.lang.String jpqlQueryBNFId)
Creates a new EclipseLinkBasicRefactoringTool.

Parameters:
jpqlFragment - The JPQL query to manipulate or a single JPQL fragment, which is parsed using the JPQL query BNF identifier by the given ID
jpqlGrammar - The JPQLGrammar that was used to parse the JPQL fragment
managedTypeProvider - The external form of a provider that gives access to the JPA metadata
jpqlQueryBNFId - The unique identifier of the parser.JPQLQueryBNF JPQLQueryBNF that determines how to parse the JPQL fragment
Method Detail

buildJPQLQueryContext

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

Specified by:
buildJPQLQueryContext in class BasicRefactoringTool
Returns:
A new concrete instance of JPQLQueryContext

EclipseLink 2.4.2, build 'v20130514-5956486' API Reference