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

All Implemented Interfaces:: ListHolderStateObject<StateObject>, StateObject

public class FunctionExpressionStateObject
extends AbstractStateObject
implements ListHolderStateObject<StateObject>

Since:: 2.4
Version:: 2.4
Author:: Pascal Filion

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ARGUMENTS_LIST`	Notifies the list of arguments has changed.
`static String`	`FUNCTION_NAME_PROPERTY`	Notifies the function name property has changed.

Constructor Summary

Constructors
Constructor	Description
`FunctionExpressionStateObject(StateObject parent)`	Creates a new `AbstractFunctionExpressionStateObject`.
`FunctionExpressionStateObject(StateObject parent, String identifier, String functionName, List<? extends StateObject> arguments)`	Creates a new `AbstractFunctionExpressionStateObject`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`accept(StateObjectVisitor visitor)`	Visits this `StateObject` by the given `visitor`.
`<S extends StateObject> S`	`addItem(S item)`	Adds the given `StateObject` as a child of this one.
`void`	`addItems(List<? extends StateObject> items)`	Adds the given list of `StateObjects` as children of this one.
`void`	`addListChangeListener(String listName, IListChangeListener<StateObject> listener)`	Registers the given `IListChangeListener` for the specified list.
`boolean`	`canMoveDown(StateObject item)`	Determines whether the given `StateObject` can be moved down by one position in the list owned by its parent.
`boolean`	`canMoveUp(StateObject item)`	Determines whether the given `StateObject` can be moved up by one position in the list owned by its parent.
`FunctionExpression`	`getExpression()`	Returns the actual parsed object if this `StateObject` representation of the JPQL query was created by parsing an existing JPQL query.
`String`	`getFunctionName()`	Returns the name of the native database function.
`String`	`getIdentifier()`	Returns the JPQL identifier of this expression.
`StateObject`	`getItem(int index)`	Returns the `StateObject` at the given positions from the list
`String`	`getQuotedFunctionName()`	Returns the quoted name of the native database function.
`boolean`	`hasFunctionName()`	Determines whether the name of the native SQL function has been specified.
`boolean`	`hasItems()`	Determines whether this `StateObject` has any children.
`boolean`	`isEquivalent(StateObject stateObject)`	Determines whether the given `StateObject` is equivalent to this one, i.e.
`ListIterable<StateObject>`	`items()`	Returns an `ListIterable` over the children.
`int`	`itemsSize()`	Returns the number of children this list holder has.
`StateObject`	`moveDown(StateObject item)`	Moves the given `StateObject` down by one position in the list owned by its parent.
`StateObject`	`moveUp(StateObject item)`	Moves the given `StateObject` up by one position in the list owned by its parent.
`void`	`removeItem(StateObject item)`	Removes the given `StateObject` from the list of children.
`void`	`removeItems(Collection<StateObject> items)`	Removes the given `StateObject` from the list of children.
`void`	`removeListChangeListener(String listName, IListChangeListener<StateObject> listener)`	Unregisters the given `IListChangeListener` that was registered for the specified list.
`void`	`setExpression(FunctionExpression expression)`	Keeps a reference of the `parsed object` object, which should only be done when this object is instantiated during the conversion of a parsed JPQL query into `StateObjects`.
`void`	`setFunctionName(String functionName)`	Sets the unquoted name of the native database function.

Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject
addPropertyChangeListener, children, decorate, equals, findIdentificationVariable, getDeclaration, getDecorator, getGrammar, getManagedTypeProvider, getParent, getQueryBuilder, getRoot, getType, getType, getTypeHelper, getTypeRepository, hashCode, isDecorated, removePropertyChangeListener, setExpression, setParent, toString, toString, toText

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
addPropertyChangeListener, children, decorate, findIdentificationVariable, getDeclaration, getDecorator, getGrammar, getManagedTypeProvider, getParent, getQueryBuilder, getRoot, isDecorated, removePropertyChangeListener, setParent, toString, toText

- Field Detail
  - ARGUMENTS_LIST
```
public static final String ARGUMENTS_LIST
```
    Notifies the list of arguments has changed.
    
    See Also:
    
    Constant Field Values
  - FUNCTION_NAME_PROPERTY
```
public static final String FUNCTION_NAME_PROPERTY
```
    Notifies the function name property has changed.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FunctionExpressionStateObject
```
public FunctionExpressionStateObject(StateObject parent)
```
    Creates a new AbstractFunctionExpressionStateObject.
    
    Parameters:
    
    parent - The parent of this state object, which cannot be null
    
    Throws:
    
    NullPointerException - The given parent cannot be null
  - FunctionExpressionStateObject
```
public FunctionExpressionStateObject(StateObject parent,
                                     String identifier,
                                     String functionName,
                                     List<? extends StateObject> arguments)
```
    Creates a new AbstractFunctionExpressionStateObject.
    
    Parameters:
    
    parent - The parent of this state object, which cannot be null
    
    identifier - The JPQL identifier of the SQL expression
    
    functionName - The name of the native database function
    
    arguments - The list of StateObject representing the arguments to pass to the native database function
    
    Throws:
    
    NullPointerException - The given parent cannot be null
- Method Detail
  - accept
```
public void accept(StateObjectVisitor visitor)
```
    Visits this StateObject by the given visitor.
    
    Specified by:
    
    accept in interface StateObject
    
    Parameters:
    
    visitor - The visitor to visit this object
  - addItem
```
public <S extends StateObject> S addItem(S item)
```
    Adds the given StateObject as a child of this one.
    
    Specified by:
    
    addItem in interface ListHolderStateObject<StateObject>
    
    Parameters:
    
    item - The child StateObject to become a child of this one return The given item
  - addItems
```
public void addItems(List<? extends StateObject> items)
```
    Adds the given list of StateObjects as children of this one.
    
    Specified by:
    
    addItems in interface ListHolderStateObject<StateObject>
    
    Parameters:
    
    items - The StateObjects to become children of this one
  - addListChangeListener
```
public void addListChangeListener(String listName,
                                  IListChangeListener<StateObject> listener)
```
    Registers the given IListChangeListener for the specified list. The listener will be notified only when items are added, removed, moved from the list.
    
    Specified by:
    
    addListChangeListener in interface ListHolderStateObject<StateObject>
    
    Parameters:
    
    listName - The name of the list for which the listener will be notified when the content of the list has changed
    
    listener - The listener to be notified upon changes
  - canMoveDown
```
public boolean canMoveDown(StateObject item)
```
    Determines whether the given StateObject can be moved down by one position in the list owned by its parent.
    
    Specified by:
    
    canMoveDown in interface ListHolderStateObject<StateObject>
    
    Parameters:
    
    item - The StateObject that could potentially be moved down
    
    Returns:
    
    true if the object can be moved down by one unit; false otherwise
  - canMoveUp
```
public boolean canMoveUp(StateObject item)
```
    Determines whether the given StateObject can be moved up by one position in the list owned by its parent.
    
    Specified by:
    
    canMoveUp in interface ListHolderStateObject<StateObject>
    
    Parameters:
    
    item - The StateObject that could potentially be moved up
    
    Returns:
    
    true if the object can be moved up by one unit; false otherwise
  - getExpression
```
public FunctionExpression 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
    
    Overrides:
    
    getExpression in class AbstractStateObject
    
    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)
  - getFunctionName
```
public String getFunctionName()
```
    Returns the name of the native database function.
    
    Returns:
    
    The new name of the native database function
  - getIdentifier
```
public String getIdentifier()
```
    Returns the JPQL identifier of this expression.
    
    Returns:
    
    The JPQL identifier
  - getItem
```
public StateObject getItem(int index)
```
    Returns the StateObject at the given positions from the list
    
    Specified by:
    
    getItem in interface ListHolderStateObject<StateObject>
    
    Parameters:
    
    index - The position of the StateObject to retrieve
    
    Returns:
    
    The StateObject at the given position
  - getQuotedFunctionName
```
public String getQuotedFunctionName()
```
    Returns the quoted name of the native database function.
    
    Returns:
    
    The new name of the native database function, which is quoted
  - hasFunctionName
```
public boolean hasFunctionName()
```
    Determines whether the name of the native SQL function has been specified.
    
    Returns:
    
    true if the function name has been specified; false otherwise
  - hasItems
```
public boolean hasItems()
```
    Determines whether this StateObject has any children.
    
    Specified by:
    
    hasItems in interface ListHolderStateObject<StateObject>
    
    Returns:
    
    true if this StateObject has children; false otherwise
  - 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
    
    Overrides:
    
    isEquivalent in class AbstractStateObject
    
    Parameters:
    
    stateObject - The StateObject to compare its content to this one
    
    Returns:
    
    true if both object are equivalent; false otherwise
  - items
```
public ListIterable<StateObject> items()
```
    Returns an ListIterable over the children.
    
    Specified by:
    
    items in interface ListHolderStateObject<StateObject>
    
    Returns:
    
    An ListIterable that is iterating over the children
  - itemsSize
```
public int itemsSize()
```
    Returns the number of children this list holder has.
    
    Specified by:
    
    itemsSize in interface ListHolderStateObject<StateObject>
    
    Returns:
    
    The count of StateObjects that are children of this one
  - moveDown
```
public StateObject moveDown(StateObject item)
```
    Moves the given StateObject down by one position in the list owned by its parent.
    
    Specified by:
    
    moveDown in interface ListHolderStateObject<StateObject>
    
    Parameters:
    
    item - The StateObject to move down in the list
    
    Returns:
    
    The given item
  - moveUp
```
public StateObject moveUp(StateObject item)
```
    Moves the given StateObject up by one position in the list owned by its parent.
    
    Specified by:
    
    moveUp in interface ListHolderStateObject<StateObject>
    
    Parameters:
    
    item - The StateObject to move up in the list
    
    Returns:
    
    The given item
  - removeItem
```
public void removeItem(StateObject item)
```
    Removes the given StateObject from the list of children.
    
    Specified by:
    
    removeItem in interface ListHolderStateObject<StateObject>
    
    Parameters:
    
    item - The child StateObject to not longer be a child
  - removeItems
```
public void removeItems(Collection<StateObject> items)
```
    Removes the given StateObject from the list of children.
    
    Specified by:
    
    removeItems in interface ListHolderStateObject<StateObject>
    
    Parameters:
    
    items - The StateObjects to remove from this one
  - removeListChangeListener
```
public void removeListChangeListener(String listName,
                                     IListChangeListener<StateObject> listener)
```
    Unregisters the given IListChangeListener that was registered for the specified list. The listener will no longer be notified only when items are added, removed, moved from the list.
    
    Specified by:
    
    removeListChangeListener in interface ListHolderStateObject<StateObject>
    
    Parameters:
    
    listName - The name of the list for which the listener was registered
    
    listener - The listener to unregister
  - setExpression
```
public void setExpression(FunctionExpression expression)
```
    Keeps a reference of the parsed object object, which should only be done when this object is instantiated during the conversion of a parsed JPQL query into StateObjects.
    
    Parameters:
    
    expression - The parsed object representing a SQL expression
  - setFunctionName
```
public void setFunctionName(String functionName)
```
    Sets the unquoted name of the native database function.
    
    Parameters:
    
    functionName - The new name of the native database function, which should be unquoted

Class FunctionExpressionStateObject

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject

Methods inherited from class java.lang.Object

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

Field Detail

ARGUMENTS_LIST

FUNCTION_NAME_PROPERTY

Constructor Detail

FunctionExpressionStateObject

FunctionExpressionStateObject

Method Detail

accept

addItem

addItems

addListChangeListener

canMoveDown

canMoveUp

getExpression

getFunctionName

getIdentifier

getItem

getQuotedFunctionName

hasFunctionName

hasItems

isEquivalent

items

itemsSize

moveDown

moveUp

removeItem

removeItems

removeListChangeListener

setExpression

setFunctionName