EclipseLink Hermes Parser 4.0.2 · org.eclipse.persistence.jpa.jpql.tools.AbstractRefactoringTool

Field Summary

Modifier and Type	Field and Description
private CharSequence	jpqlFragment The JPQL query to manipulate or a single JPQL fragment, which is parsed using the JPQL query specified BNF.
private String	jpqlQueryBNFId The unique identifier of the `JPQLQueryBNF` that determines how to parse the JPQL fragment.
private IManagedTypeProvider	managedTypeProvider The external form of a provider that gives access to the JPA metadata.
private boolean	tolerant Determines whether the parsing system should be tolerant.

Constructor Summary

Access Constructor and Description

protected

Access	Constructor and Description
protected	AbstractRefactoringTool(CharSequence The JPQL query to manipulate or a single JPQL fragment, which is parsed using the JPQL query BNF identifier by the given ID jpqlFragment, IManagedTypeProvider The external form of a provider that gives access to the JPA metadata managedTypeProvider, String The unique identifier of the `JPQLQueryBNF` that determines how to parse the JPQL fragment jpqlQueryBNFId) Creates a new `BasicRefactoringTool`.

AbstractRefactoringTool(CharSequence

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

jpqlFragment, IManagedTypeProvider

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

managedTypeProvider, String

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

jpqlQueryBNFId)

Creates a new BasicRefactoringTool.

Method Summary

Modifier and Type	Method and Description
public CharSequence	Returns: The string representation of the JPQL query or fragment getJPQLFragment() Returns the original JPQL query or the JPQL fragment that was passed to this tool so it can be manipulated.
public String	Returns: The ID of the `JPQLQueryBNF` used to parse the query getJPQLQueryBNFId() Returns the unique identifier of the JPQL query BNF that determined how the JPQL query or fragment needs to be parsed.
public IManagedTypeProvider	Returns: The provider that gives access to the managed types getManagedTypeProvider() Returns the provider of managed types.
public boolean	Returns: By default, the parsing system uses tolerance isTolerant() Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries.
public void	setTolerant(boolean `true` if the JPQL query or fragment should be parsed with tolerance; `false` otherwise tolerant) Sets whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries.
public abstract String	Returns: The string representation of the JPQL query that contains the changes toActualText() Returns the resulted of the refactoring operations.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

jpqlFragment	back to summary
private CharSequence jpqlFragment The JPQL query to manipulate or a single JPQL fragment, which is parsed using the JPQL query specified BNF.

jpqlQueryBNFId	back to summary
private String jpqlQueryBNFId The unique identifier of the `JPQLQueryBNF` that determines how to parse the JPQL fragment.

managedTypeProvider	back to summary
private IManagedTypeProvider managedTypeProvider The external form of a provider that gives access to the JPA metadata.

tolerant	back to summary
private boolean tolerant Determines whether the parsing system should be tolerant.

Constructor Detail

AbstractRefactoringTool back to summary

AbstractRefactoringTool	back to summary
protected AbstractRefactoringTool(CharSequence jpqlFragment, IManagedTypeProvider managedTypeProvider, String jpqlQueryBNFId) Creates a new `BasicRefactoringTool`. Parameters jpqlFragment:CharSequence The JPQL query to manipulate or a single JPQL fragment, which is parsed using the JPQL query BNF identifier by the given ID managedTypeProvider:IManagedTypeProvider The external form of a provider that gives access to the JPA metadata jpqlQueryBNFId:String The unique identifier of the `JPQLQueryBNF` that determines how to parse the JPQL fragment

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

Creates a new BasicRefactoringTool.

Parameters

jpqlFragment:CharSequence: The JPQL query to manipulate or a single JPQL fragment, which is parsed using the JPQL query BNF identifier by the given ID
managedTypeProvider:IManagedTypeProvider: The external form of a provider that gives access to the JPA metadata
jpqlQueryBNFId:String: The unique identifier of the JPQLQueryBNF that determines how to parse the JPQL fragment

Method Detail

getJPQLFragment	back to summary
public CharSequence getJPQLFragment() Returns the original JPQL query or the JPQL fragment that was passed to this tool so it can be manipulated. Returns:CharSequence The string representation of the JPQL query or fragment

getJPQLFragment

back to summary

public CharSequence getJPQLFragment()

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

Returns:CharSequence: The string representation of the JPQL query or fragment

getJPQLQueryBNFId back to summary

getJPQLQueryBNFId	back to summary
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:String The ID of the `JPQLQueryBNF` used to parse the query

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:String: The ID of the JPQLQueryBNF used to parse the query

getManagedTypeProvider	back to summary
public IManagedTypeProvider getManagedTypeProvider() Returns the provider of managed types. Returns:IManagedTypeProvider The provider that gives access to the managed types

getManagedTypeProvider

back to summary

public IManagedTypeProvider getManagedTypeProvider()

Returns the provider of managed types.

Returns:IManagedTypeProvider: The provider that gives access to the managed types

isTolerant	back to summary
public boolean isTolerant() Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries. Returns:boolean By default, the parsing system uses tolerance

isTolerant

back to summary

public boolean isTolerant()

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

Returns:boolean: By default, the parsing system uses tolerance

setTolerant back to summary

setTolerant	back to summary
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:boolean `true` if the JPQL query or fragment should be parsed with tolerance; `false` otherwise

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:boolean: true if the JPQL query or fragment should be parsed with tolerance; false otherwise

toActualText	back to summary
public abstract String toActualText() Returns the resulted of the refactoring operations. The list of changes will be removed after applying the changes. Returns:String The string representation of the JPQL query that contains the changes

toActualText

back to summary

public abstract String toActualText()

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

Returns:String: The string representation of the JPQL query that contains the changes

public abstract Class AbstractRefactoringTool

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail