Module org.eclipse.persistence.jpa.jpql

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

Class AbstractRefactoringTool

java.lang.Object

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

Direct Known Subclasses:

BasicRefactoringTool, RefactoringTool

public abstract class AbstractRefactoringTool
extends Object

The abstract definition of a refactoring

Since:

2.4

Version:

2.4

See Also:

• RefactoringTool
• BasicRefactoringTool

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractRefactoringTool(CharSequence jpqlFragment, IManagedTypeProvider managedTypeProvider, String jpqlQueryBNFId)	Creates a new BasicRefactoringTool.

Method Summary

Modifier and Type	Method	Description
CharSequence	getJPQLFragment()	Returns the original JPQL query or the JPQL fragment that was passed to this tool so it can be manipulated.
String	getJPQLQueryBNFId()	Returns the unique identifier of the JPQL query BNF that determined how the JPQL query or fragment needs to be parsed.
IManagedTypeProvider	getManagedTypeProvider()	Returns the provider of managed types.
boolean	isTolerant()	Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries.
void	setTolerant(boolean tolerant)	Sets whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries.
abstract String	toActualText()	Returns the resulted of the refactoring operations.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractRefactoringTool

protected AbstractRefactoringTool(CharSequence jpqlFragment,
 IManagedTypeProvider managedTypeProvider,
 String jpqlQueryBNFId)

Creates a new BasicRefactoringTool.

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

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

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

Method Details

getJPQLFragment

public CharSequence getJPQLFragment()

Returns the original JPQL query or the JPQL fragment that was passed to this tool so it can be manipulated.

Returns:

The string representation of the JPQL query or fragment

getJPQLQueryBNFId

public String getJPQLQueryBNFId()

Returns the unique identifier of the JPQL query BNF that determined how the JPQL query or fragment needs to be parsed.

Returns:

The ID of the JPQLQueryBNF used to parse the query

getManagedTypeProvider

public IManagedTypeProvider getManagedTypeProvider()

Returns the provider of managed types.

Returns:

The provider that gives access to the managed types

isTolerant

public boolean isTolerant()

Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries.

Returns:

By default, the parsing system uses tolerance

setTolerant

public void setTolerant(boolean tolerant)

Sets whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries.

Parameters:

tolerant - true if the JPQL query or fragment should be parsed with tolerance; false otherwise

toActualText

public abstract String toActualText()

Returns the resulted of the refactoring operations. The list of changes will be removed after applying the changes.

Returns:

The string representation of the JPQL query that contains the changes