AbstractStateObject (EclipseLink 2.6.3, "build v20160428-59c81c5" API Reference)

java.lang.Object
- org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject

All Implemented Interfaces:

StateObject

Direct Known Subclasses:

AbstractConditionalClauseStateObject, AbstractEncapsulatedExpressionStateObject, AbstractListHolderStateObject, AbstractModifyClauseStateObject, AbstractModifyStatementStateObject, AbstractPathExpressionStateObject, AbstractRangeVariableDeclarationStateObject, AbstractSelectClauseStateObject, AbstractSelectStatementStateObject, ArithmeticFactorStateObject, BetweenExpressionStateObject, CollectionExpressionStateObject, CollectionMemberDeclarationStateObject, CollectionMemberExpressionStateObject, CompoundExpressionStateObject, EmptyCollectionComparisonExpressionStateObject, FunctionExpressionStateObject, JoinStateObject, JPQLQueryStateObject, LikeExpressionStateObject, NotExpressionStateObject, NullComparisonExpressionStateObject, OrderByItemStateObject, ResultVariableStateObject, SimpleStateObject, TreatExpressionStateObject, UpdateItemStateObject
```
public abstract class AbstractStateObject
extends java.lang.Object
implements StateObject
```
The abstract definition of a StateObject.

Since:

2.4

Version:

2.5

Author:

Pascal Filion

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPropertyChangeListener(java.lang.String propertyName, IPropertyChangeListener<?> listener)` Registers the given `IPropertyChangeListener` for the specified property.
`java.lang.Iterable<StateObject>`	`children()` Returns the ordered children of this `StateObject`.
`void`	`decorate(StateObject decorator)` Decorates this `StateObject` with the given decorator.
`boolean`	`equals(java.lang.Object object)`
`IdentificationVariableStateObject`	`findIdentificationVariable(java.lang.String identificationVariable)` Returns the `IdentificationVariableStateObject` representing the given identification variable.
`DeclarationStateObject`	`getDeclaration()` Returns the declaration clause which defines the domain of the query by declaring identification variables.
`StateObject`	`getDecorator()` Returns the `StateObject` decorating this one if one has been set, which means the behavior of this `StateObject` is modified by the decorator.
`Expression`	`getExpression()` Returns the actual parsed object if this `StateObject` representation of the JPQL query was created by parsing an existing JPQL query.
`JPQLGrammar`	`getGrammar()` Returns the grammar that defines how to parse a JPQL query.
`IManagedTypeProvider`	`getManagedTypeProvider()` Returns the provider of managed types.
`StateObject`	`getParent()` Returns the parent of this `StateObject`.
`IJPQLQueryBuilder`	`getQueryBuilder()` Returns the `IJPQLQueryBuilder` that is responsible to create various part of the `StateObject` hierarchy.
`JPQLQueryStateObject`	`getRoot()` Returns the root of the `StateObject` hierarchy.
`IType`	`getType(java.lang.Class<?> type)` Retrieves the external type for the given Java type.
`IType`	`getType(java.lang.String typeName)` Retrieves the external class for the given fully qualified class name.
`TypeHelper`	`getTypeHelper()` Returns a helper that gives access to the most common `types`.
`ITypeRepository`	`getTypeRepository()` Returns the type repository for the application.
`int`	`hashCode()`
`boolean`	`isDecorated()` Determines whether this `StateObject` is being decorated by another `StateObject`, which means the behavior is modified by the given one.
`boolean`	`isEquivalent(StateObject stateObject)` Determines whether the given `StateObject` is equivalent to this one, i.e.
`void`	`removePropertyChangeListener(java.lang.String propertyName, IPropertyChangeListener<?> listener)` Unregisters the given `IPropertyChangeListener` that was registered for the specified property.
`void`	`setExpression(Expression expression)` Sets the actual parsed object if this `StateObject` representation of the JPQL query is created by converting the parsed representation of the JPQL query.
`void`	`setParent(StateObject parent)` Sets the given `StateObject` to become the parent of this one.
`java.lang.String`	`toString()`
`void`	`toString(java.lang.Appendable writer)` Prints out a string representation of this `StateObject`, which should not be used to define a `true` string representation of a JPQL query but should be used for debugging purposes.
`void`	`toText(java.lang.Appendable writer)` Prints out a string representation of this `StateObject`, which should not be used to define a `true` string representation of a JPQL query but should be used for debugging purposes.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject
accept

- Method Detail
  - addPropertyChangeListener
```
public final void addPropertyChangeListener(java.lang.String propertyName,
                                            IPropertyChangeListener<?> listener)
```
    Registers the given IPropertyChangeListener for the specified property. The listener will be notified only for changes to the specified property.
    
    Specified by:
    
    addPropertyChangeListener in interface StateObject
    
    Parameters:
    
    propertyName - The name of the property for which the listener was registered
    
    listener - The listener to be notified upon changes
  - children
```
public final java.lang.Iterable<StateObject> children()
```
    Returns the ordered children of this StateObject.
    
    Specified by:
    
    children in interface StateObject
    
    Returns:
    
    The children of this StateObject or an empty iterable this state object does not have children
  - decorate
```
public void decorate(StateObject decorator)
```
    Decorates this StateObject with the given decorator. It means the behavior of this StateObject is modified by the given one. By default, this StateObject becomes the parent of the given one.
    
    Specified by:
    
    decorate in interface StateObject
    
    Parameters:
    
    decorator - The StateObject decorating this one
  - equals
```
public final boolean equals(java.lang.Object object)
```
    Overrides:
    
    equals in class java.lang.Object
  - findIdentificationVariable
```
public IdentificationVariableStateObject findIdentificationVariable(java.lang.String identificationVariable)
```
    Returns the IdentificationVariableStateObject representing the given identification variable.
    
    Specified by:
    
    findIdentificationVariable in interface StateObject
    
    Parameters:
    
    identificationVariable - The name of the identification variable to retrieve its state object
    
    Returns:
    
    The IdentificationVariableStateObject defining the given identification variable
  - getDeclaration
```
public DeclarationStateObject getDeclaration()
```
    Returns the declaration clause which defines the domain of the query by declaring identification variables.
    
    Specified by:
    
    getDeclaration in interface StateObject
    
    Returns:
    
    The declaration clause of which this StateObject is a child; i.e. either the top-level declaration if this is part of the top query or the sub-level declaration if this is part of a subquery
  - getDecorator
```
public StateObject getDecorator()
```
    Returns the StateObject decorating this one if one has been set, which means the behavior of this StateObject is modified by the decorator.
    
    Specified by:
    
    getDecorator in interface StateObject
    
    Returns:
    
    The StateObject decorating this one
  - getExpression
```
public Expression getExpression()
```
    Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.
    
    Specified by:
    
    getExpression in interface StateObject
    
    Returns:
    
    The parsed object when a JPQL query is parsed and converted into a StateObject or null when the JPQL query is manually created (i.e. not from a string)
  - getGrammar
```
public JPQLGrammar getGrammar()
```
    Returns the grammar that defines how to parse a JPQL query.
    
    Specified by:
    
    getGrammar in interface StateObject
    
    Returns:
    
    The grammar that was used to parse the JPQL query
  - getManagedTypeProvider
```
public IManagedTypeProvider getManagedTypeProvider()
```
    Returns the provider of managed types.
    
    Specified by:
    
    getManagedTypeProvider in interface StateObject
    
    Returns:
    
    The provider that gives access to the managed types
  - getParent
```
public StateObject getParent()
```
    Returns the parent of this StateObject.
    
    Specified by:
    
    getParent in interface StateObject
    
    Returns:
    
    Returns the parent of this StateObject, which is null only when this is the root of the hierarchy
  - getQueryBuilder
```
public IJPQLQueryBuilder getQueryBuilder()
```
    Returns the IJPQLQueryBuilder that is responsible to create various part of the StateObject hierarchy.
    
    Specified by:
    
    getQueryBuilder in interface StateObject
    
    Returns:
    
    The builder that created this StateObject from a JPQL query or that gives access to various sub-builders
  - getRoot
```
public JPQLQueryStateObject getRoot()
```
    Returns the root of the StateObject hierarchy.
    
    Specified by:
    
    getRoot in interface StateObject
    
    Returns:
    
    The root of the state model representing the JPQL query
  - getType
```
public IType getType(java.lang.Class<?> type)
```
    Retrieves the external type for the given Java type.
    
    Parameters:
    
    type - The Java type to wrap with an external form
    
    Returns:
    
    The external form of the given type
  - getType
```
public IType getType(java.lang.String typeName)
```
    Retrieves the external class for the given fully qualified class name.
    
    Parameters:
    
    typeName - The fully qualified class name of the class to retrieve
    
    Returns:
    
    The external form of the class to retrieve
  - getTypeHelper
```
public TypeHelper getTypeHelper()
```
    Returns a helper that gives access to the most common types.
    
    Returns:
    
    A helper containing a collection of methods related to IType
  - getTypeRepository
```
public ITypeRepository getTypeRepository()
```
    Returns the type repository for the application.
    
    Returns:
    
    The repository of ITypes
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - isDecorated
```
public boolean isDecorated()
```
    Determines whether this StateObject is being decorated by another StateObject, which means the behavior is modified by the given one. return true if this StateObject is being decorated; false otherwise
    
    Specified by:
    
    isDecorated in interface StateObject
  - isEquivalent
```
public boolean isEquivalent(StateObject stateObject)
```
    Determines whether the given StateObject is equivalent to this one, i.e. the information of both StateObject is the same.
    
    Specified by:
    
    isEquivalent in interface StateObject
    
    Parameters:
    
    stateObject - The StateObject to compare its content to this one
    
    Returns:
    
    true if both object are equivalent; false otherwise
  - removePropertyChangeListener
```
public final void removePropertyChangeListener(java.lang.String propertyName,
                                               IPropertyChangeListener<?> listener)
```
    Unregisters the given IPropertyChangeListener that was registered for the specified property. The listener will no longer be notified when the property changes.
    
    Specified by:
    
    removePropertyChangeListener in interface StateObject
    
    Parameters:
    
    propertyName - The name of the property for which the listener was registered
    
    listener - The listener to unregister
  - setExpression
```
public void setExpression(Expression expression)
```
    Sets the actual parsed object if this StateObject representation of the JPQL query is created by converting the parsed representation of the JPQL query.
    
    Parameters:
    
    expression - The parsed object when a JPQL query is parsed
  - setParent
```
public final void setParent(StateObject parent)
```
    Sets the given StateObject to become the parent of this one.
    
    Specified by:
    
    setParent in interface StateObject
    
    Parameters:
    
    parent - The new parent StateObject of this one, which cannot be null
  - toString
```
public final java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - toString
```
public final void toString(java.lang.Appendable writer)
```
    Prints out a string representation of this StateObject, which should not be used to define a true string representation of a JPQL query but should be used for debugging purposes.
    Important: If this StateObject is decorated by another one, then StateObject.toString(Appendable) from that decorator is invoked, otherwise the information contained in this one will be printed out.
    
    Specified by:
    
    toString in interface StateObject
    
    Parameters:
    
    writer - The writer used to print out the string representation
    
    See Also:
    
    StateObject.toText(Appendable)
  - toText
```
public final void toText(java.lang.Appendable writer)
```
    Prints out a string representation of this StateObject, which should not be used to define a true string representation of a JPQL query but should be used for debugging purposes.
    Important: Even if this StateObject is decorated by another one, the decorator will not be used to print out a string representation of this one.
    
    Specified by:
    
    toText in interface StateObject
    
    Parameters:
    
    writer - The writer used to print out the string representation
    
    See Also:
    
    StateObject.toString(Appendable)

Class AbstractStateObject

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject

Method Detail

addPropertyChangeListener

children

decorate

equals

findIdentificationVariable

getDeclaration

getDecorator

getExpression

getGrammar

getManagedTypeProvider

getParent

getQueryBuilder

getRoot

getType

getType

getTypeHelper

getTypeRepository

hashCode

isDecorated

isEquivalent

removePropertyChangeListener

setExpression

setParent

toString

toString

toText