Top Description Fields Constructors Methods
org.eclipse.persistence.jpa.jpql.tools.model.query

public Class CoalesceExpressionStateObject

extends AbstractEncapsulatedExpressionStateObject
implements ListHolderStateObject<StateObject>
Class Inheritance
All Implemented Interfaces
org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject, org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject
Annotations
@SuppressWarnings:nls
Static Imports
org.eclipse.persistence.jpa.jpql.parser.Expression.COALESCE
A COALESCE expression returns null if all its arguments evaluate to null, and the value of the first non-null argument otherwise.

The return type is the type returned by the arguments if they are all of the same type, otherwise it is undetermined.

BNF: coalesce_expression::= COALESCE(scalar_expression {, scalar_expression}+)
Author
Pascal Filion
Since
2.4
Version
2.4
See Also
CoalesceExpression

Field Summary

Modifier and TypeField and Description
private List<StateObject>
items

The state objects representing the scalar expressions.

public static final String
STATE_OBJECTS_LIST

Notifies the content of the state object list has changed.

Constructor Summary

AccessConstructor and Description
public
CoalesceExpressionStateObject(StateObject
The parent of this state object, which cannot be null
parent)

Creates a new CoalesceExpressionStateObject.

public
CoalesceExpressionStateObject(StateObject
The parent of this state object, which cannot be null
parent, List<StateObject>
The list of StateObjects representing the encapsulated expressions
items)

Creates a new CoalesceExpressionStateObject.

public
CoalesceExpressionStateObject(StateObject
The parent of this state object, which cannot be null
parent, StateObject...
The list of StateObjects representing the encapsulated expressions
items)

Creates a new CoalesceExpressionStateObject.

public
CoalesceExpressionStateObject(StateObject
The parent of this state object, which cannot be null
parent, String...
The list of expression to parse into their StateObject
items)

Creates a new CoalesceExpressionStateObject.

Method Summary

Modifier and TypeMethod and Description
public void
accept(StateObjectVisitor
The visitor to visit this object
visitor)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.accept.

Visits this StateObject by the given visitor.
protected void
addChildren(List<StateObject>
The list used to store the children
children)

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.addChildren.

Adds the children of this StateObject to the given list.
public <S extends StateObject> S
addItem(S
The child StateObject to become a child of this one return The given item
item)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.addItem.

Adds the given StateObject as a child of this one.
public void
addItems(List<? extends StateObject>
The StateObjects to become children of this one
items)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.addItems.

Adds the given list of StateObjects as children of this one.
public void
addListChangeListener(String
The name of the list for which the listener will be notified when the content of the list has changed
listName, IListChangeListener<StateObject>
The listener to be notified upon changes
listener)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.addListChangeListener.

Registers the given IListChangeListener for the specified list.
protected boolean

Returns:

true if both have equivalent children; false otherwise
areChildrenEquivalent(CoalesceExpressionStateObject
The StateObject to compare its children to this one's children
stateObject)

Determines whether the children of this StateObject are equivalent to the children of the given one, i.e. the information of the StateObjects is the same.

public boolean
canMoveDown(StateObject
The StateObject that could potentially be moved down
item)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.canMoveDown.

Determines whether the given StateObject can be moved down by one position in the list owned by its parent.
public boolean
canMoveUp(StateObject
The StateObject that could potentially be moved up
item)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.canMoveUp.

Determines whether the given StateObject can be moved up by one position in the list owned by its parent.
public CoalesceExpression
getExpression()

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractEncapsulatedExpressionStateObject.getExpression.

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getExpression.

Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.
public String
getIdentifier()

Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractEncapsulatedExpressionStateObject.getIdentifier.

Returns the JPQL identifier of the expression represented by this AbstractSingleEncapsulatedExpressionStateObject.
public StateObject
getItem(int
The position of the StateObject to retrieve
index)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.getItem.

Returns the StateObject at the given positions from the list
public boolean
hasItems()

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.hasItems.

Determines whether this StateObject has any children.
protected void
initialize()

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.initialize.

Initializes this state object.
public boolean
isEquivalent(StateObject
The StateObject to compare its content to this one
stateObject)

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.isEquivalent.

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.isEquivalent.

Determines whether the given StateObject is equivalent to this one, i.e. the information of both StateObject is the same.
public ListIterable<StateObject>
items()

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.items.

Returns an ListIterable over the children.
public int
itemsSize()

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.itemsSize.

Returns the number of children this list holder has.
public StateObject
moveDown(StateObject
The StateObject to move down in the list
item)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.moveDown.

Moves the given StateObject down by one position in the list owned by its parent.
public StateObject
moveUp(StateObject
The StateObject to move up in the list
item)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.moveUp.

Moves the given StateObject up by one position in the list owned by its parent.
public void
parseItem(String
The portion of the query representing a single encapsulated expression
jpqlFragment)

Parses the given JPQL fragment, which represents a single encapsulated expression, and creates the StateObject.

protected void
parseItemInternal(String...
The list of expression to parse into their StateObject
items)

Parses the given list of JPQL fragments, which represents each of the encapsulated expressions, and creates the StateObjects.

public void
parseItems(ListIterator<String>
The portion of the query representing a single encapsulated expression
items)

Parses the given JPQL fragments, which represent individual expression, and creates the StateObjects.

public void
parseItems(String...
The portion of the query representing a single encapsulated expression
items)

Parses the given JPQL fragments, which represent individual expression, and creates the StateObjects.

public void
removeItem(StateObject
The child StateObject to not longer be a child
item)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.removeItem.

Removes the given StateObject from the list of children.
public void
removeItems(Collection<StateObject>
The StateObjects to remove from this one
items)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.removeItems.

Removes the given StateObject from the list of children.
public void
removeListChangeListener(String
The name of the list for which the listener was registered
listName, IListChangeListener<StateObject>
The listener to unregister
listener)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.removeListChangeListener.

Unregisters the given IListChangeListener that was registered for the specified list.
public void
setExpression(CoalesceExpression
The parsed object representing a CASE expression
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.

protected void
toTextEncapsulatedExpression(Appendable
The writer used to print out the string representation of the encapsulated information
writer)

Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractEncapsulatedExpressionStateObject.toTextEncapsulatedExpression.

Prints out a string representation of this encapsulated information, which should not be used to define a true string representation of a JPQL query but should be used for debugging purposes.
Inherited from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractEncapsulatedExpressionStateObject:
toTextInternal

Field Detail

itemsback to summary
private List<StateObject> items

The state objects representing the scalar expressions.

STATE_OBJECTS_LISTback to summary
public static final String STATE_OBJECTS_LIST

Notifies the content of the state object list has changed.

Constructor Detail

CoalesceExpressionStateObjectback to summary
public CoalesceExpressionStateObject(StateObject parent)

Creates a new CoalesceExpressionStateObject.

Parameters
parent:StateObject

The parent of this state object, which cannot be null

Exceptions
NullPointerException:
The given parent cannot be null
CoalesceExpressionStateObjectback to summary
public CoalesceExpressionStateObject(StateObject parent, List<StateObject> items)

Creates a new CoalesceExpressionStateObject.

Parameters
parent:StateObject

The parent of this state object, which cannot be null

items:List<StateObject>

The list of StateObjects representing the encapsulated expressions

Exceptions
NullPointerException:
The given parent cannot be null
CoalesceExpressionStateObjectback to summary
public CoalesceExpressionStateObject(StateObject parent, StateObject... items)

Creates a new CoalesceExpressionStateObject.

Parameters
parent:StateObject

The parent of this state object, which cannot be null

items:StateObject[]

The list of StateObjects representing the encapsulated expressions

Exceptions
NullPointerException:
The given parent cannot be null
CoalesceExpressionStateObjectback to summary
public CoalesceExpressionStateObject(StateObject parent, String... items)

Creates a new CoalesceExpressionStateObject.

Parameters
parent:StateObject

The parent of this state object, which cannot be null

items:String[]

The list of expression to parse into their StateObject

Exceptions
NullPointerException:
The given parent cannot be null

Method Detail

acceptback to summary
public void accept(StateObjectVisitor visitor)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.accept.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.accept.

Visits this StateObject by the given visitor.

Parameters
visitor:StateObjectVisitor

The visitor to visit this object

Annotations
@Override
addChildrenback to summary
protected void addChildren(List<StateObject> children)

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.addChildren.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.addChildren.

Adds the children of this StateObject to the given list.

Parameters
children:List<StateObject>

The list used to store the children

Annotations
@Override
addItemback to summary
public <S extends StateObject> S addItem(S item)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.addItem.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.addItem.

Adds the given StateObject as a child of this one.

Parameters
item:S

The child StateObject to become a child of this one return The given item

Annotations
@Override
addItemsback to summary
public void addItems(List<? extends StateObject> items)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.addItems.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.addItems.

Adds the given list of StateObjects as children of this one.

Parameters
items:List<? extends StateObject>

The StateObjects to become children of this one

Annotations
@Override
addListChangeListenerback to summary
public void addListChangeListener(String listName, IListChangeListener<StateObject> listener)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.addListChangeListener.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.addListChangeListener.

Registers the given IListChangeListener for the specified list. The listener will be notified only when items are added, removed, moved from the list.

Parameters
listName:String

The name of the list for which the listener will be notified when the content of the list has changed

listener:IListChangeListener<StateObject>

The listener to be notified upon changes

Annotations
@Override
areChildrenEquivalentback to summary
protected boolean areChildrenEquivalent(CoalesceExpressionStateObject stateObject)

Determines whether the children of this StateObject are equivalent to the children of the given one, i.e. the information of the StateObjects is the same.

Parameters
stateObject:CoalesceExpressionStateObject

The StateObject to compare its children to this one's children

Returns:boolean

true if both have equivalent children; false otherwise

canMoveDownback to summary
public boolean canMoveDown(StateObject item)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.canMoveDown.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.canMoveDown.

Determines whether the given StateObject can be moved down by one position in the list owned by its parent.

Parameters
item:StateObject

The StateObject that could potentially be moved down

Returns:boolean

true if the object can be moved down by one unit; false otherwise

Annotations
@Override
canMoveUpback to summary
public boolean canMoveUp(StateObject item)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.canMoveUp.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.canMoveUp.

Determines whether the given StateObject can be moved up by one position in the list owned by its parent.

Parameters
item:StateObject

The StateObject that could potentially be moved up

Returns:boolean

true if the object can be moved up by one unit; false otherwise

Annotations
@Override
getExpressionback to summary
public CoalesceExpression getExpression()

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractEncapsulatedExpressionStateObject.getExpression.

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getExpression.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.getExpression.

Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.

Returns:CoalesceExpression

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)

Annotations
@Override
getIdentifierback to summary
public String getIdentifier()

Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractEncapsulatedExpressionStateObject.getIdentifier.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractEncapsulatedExpressionStateObject.getIdentifier.

Returns the JPQL identifier of the expression represented by this AbstractSingleEncapsulatedExpressionStateObject.

Returns:String

The JPQL identifier that is shown before the left parenthesis

Annotations
@Override
getItemback to summary
public StateObject getItem(int index)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.getItem.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.getItem.

Returns the StateObject at the given positions from the list

Parameters
index:int

The position of the StateObject to retrieve

Returns:StateObject

The StateObject at the given position

Annotations
@Override
hasItemsback to summary
public boolean hasItems()

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.hasItems.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.hasItems.

Determines whether this StateObject has any children.

Returns:boolean

true if this StateObject has children; false otherwise

Annotations
@Override
initializeback to summary
protected void initialize()

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.initialize.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.initialize.

Initializes this state object.

Annotations
@Override
isEquivalentback to summary
public boolean isEquivalent(StateObject stateObject)

Overrides org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject.isEquivalent.

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.isEquivalent.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject.isEquivalent.

Determines whether the given StateObject is equivalent to this one, i.e. the information of both StateObject is the same.

Parameters
stateObject:StateObject

The StateObject to compare its content to this one

Returns:boolean

true if both object are equivalent; false otherwise

Annotations
@Override
itemsback to summary
public ListIterable<StateObject> items()

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.items.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.items.

Returns an ListIterable over the children.

Returns:ListIterable<StateObject>

An ListIterable that is iterating over the children

Annotations
@Override
itemsSizeback to summary
public int itemsSize()

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.itemsSize.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.itemsSize.

Returns the number of children this list holder has.

Returns:int

The count of StateObjects that are children of this one

Annotations
@Override
moveDownback to summary
public StateObject moveDown(StateObject item)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.moveDown.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.moveDown.

Moves the given StateObject down by one position in the list owned by its parent.

Parameters
item:StateObject

The StateObject to move down in the list

Returns:StateObject

The given item

Annotations
@Override
moveUpback to summary
public StateObject moveUp(StateObject item)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.moveUp.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.moveUp.

Moves the given StateObject up by one position in the list owned by its parent.

Parameters
item:StateObject

The StateObject to move up in the list

Returns:StateObject

The given item

Annotations
@Override
parseItemback to summary
public void parseItem(String jpqlFragment)

Parses the given JPQL fragment, which represents a single encapsulated expression, and creates the StateObject.

Parameters
jpqlFragment:String

The portion of the query representing a single encapsulated expression

parseItemInternalback to summary
protected void parseItemInternal(String... items)

Parses the given list of JPQL fragments, which represents each of the encapsulated expressions, and creates the StateObjects.

Parameters
items:String[]

The list of expression to parse into their StateObject

parseItemsback to summary
public void parseItems(ListIterator<String> items)

Parses the given JPQL fragments, which represent individual expression, and creates the StateObjects.

Parameters
items:ListIterator<String>

The portion of the query representing a single encapsulated expression

parseItemsback to summary
public void parseItems(String... items)

Parses the given JPQL fragments, which represent individual expression, and creates the StateObjects.

Parameters
items:String[]

The portion of the query representing a single encapsulated expression

removeItemback to summary
public void removeItem(StateObject item)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.removeItem.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.removeItem.

Removes the given StateObject from the list of children.

Parameters
item:StateObject

The child StateObject to not longer be a child

Annotations
@Override
removeItemsback to summary
public void removeItems(Collection<StateObject> items)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.removeItems.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.removeItems.

Removes the given StateObject from the list of children.

Parameters
items:Collection<StateObject>

The StateObjects to remove from this one

Annotations
@Override
removeListChangeListenerback to summary
public void removeListChangeListener(String listName, IListChangeListener<StateObject> listener)

Implements org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.removeListChangeListener.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject.removeListChangeListener.

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.

Parameters
listName:String

The name of the list for which the listener was registered

listener:IListChangeListener<StateObject>

The listener to unregister

Annotations
@Override
setExpressionback to summary
public void setExpression(CoalesceExpression 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:CoalesceExpression

The parsed object representing a CASE expression

toTextEncapsulatedExpressionback to summary
protected void toTextEncapsulatedExpression(Appendable writer) throws IOException

Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractEncapsulatedExpressionStateObject.toTextEncapsulatedExpression.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractEncapsulatedExpressionStateObject.toTextEncapsulatedExpression.

Prints out a string representation of this encapsulated information, which should not be used to define a true string representation of a JPQL query but should be used for debugging purposes.

Parameters
writer:Appendable

The writer used to print out the string representation of the encapsulated information

Annotations
@Override
Exceptions
IOException:
This should never happens, only required because Appendable is used instead of StringBuilder for instance