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

Class ConcatExpressionStateObject

java.lang.Object

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

org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractListHolderStateObject<StateObject>

org.eclipse.persistence.jpa.jpql.tools.model.query.ConcatExpressionStateObject

All Implemented Interfaces:

ListHolderStateObject<StateObject>, StateObject

public class ConcatExpressionStateObject
extends AbstractListHolderStateObject<StateObject>

The CONCAT function returns a string that is a concatenation of its arguments.

JPA 1.0:

BNF: expression ::= CONCAT(string_primary, string_primary)

JPA 2.0

BNF: expression ::= CONCAT(string_primary, string_primary {, string_primary}*)

Version:

2.4

See Also:

ConcatExpression

Author:

Pascal Filion

Since:

2.4

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	STRING_PRIMARY_STATE_OBJECT_LIST	Notifies the content of the list of StateObject representing the string primaries has changed.

Constructor Summary

Constructors

Constructor	Description
ConcatExpressionStateObject(StateObject parent)	Creates a new ConcatExpressionStateObject.
ConcatExpressionStateObject(StateObject parent, java.util.List<? extends StateObject> stateObjects)	Creates a new ConcatExpressionStateObject.
ConcatExpressionStateObject(StateObject parent, StateObject... stateObjects)	Creates a new ConcatExpressionStateObject.

Method Summary

Modifier and Type	Method	Description
void	accept(StateObjectVisitor visitor)	Visits this StateObject by the given visitor.
ConcatExpression	getExpression()	Returns the actual parsed object if this StateObject representation of the JPQL query was created by parsing an existing JPQL query.
boolean	isEquivalent(StateObject stateObject)	Determines whether the given StateObject is equivalent to this one, i.e. the information of both StateObject is the same.
protected java.lang.String	listName()	Returns the name that is uniquely identifying the list.
void	setExpression(ConcatExpression 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	toTextInternal(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 org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractListHolderStateObject

addChildren, addItem, addItems, addListChangeListener, areChildrenEquivalent, canMoveDown, canMoveUp, getItem, hasItems, initialize, items, itemsSize, moveDown, moveUp, removeItem, removeItems, removeListChangeListener, toStringItems

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

acceptUnknownVisitor, acceptUnknownVisitor, addProblems, addPropertyChangeListener, areEquivalent, buildProblem, buildProblem, buildStateObject, buildStateObjects, checkParent, children, decorate, equals, findIdentificationVariable, firePropertyChanged, getChangeSupport, getDeclaration, getDecorator, getGrammar, getManagedTypeProvider, getParent, getQueryBuilder, getRoot, getType, getType, getTypeHelper, getTypeRepository, hashCode, isDecorated, parent, parent, parent, removePropertyChangeListener, setExpression, setParent, toString, toString, toStringInternal, toStringItems, toText

Methods inherited from class java.lang.Object

clone, finalize, 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

STRING_PRIMARY_STATE_OBJECT_LIST

public static final java.lang.String STRING_PRIMARY_STATE_OBJECT_LIST

Notifies the content of the list of StateObject representing the string primaries has changed.

See Also:

Constant Field Values

Constructor Detail

ConcatExpressionStateObject

public ConcatExpressionStateObject(StateObject parent)

Creates a new ConcatExpressionStateObject.

Parameters:

parent - The parent of this state object, which cannot be null

Throws:

java.lang.NullPointerException - The given parent cannot be null

ConcatExpressionStateObject

public ConcatExpressionStateObject(StateObject parent,
                                   java.util.List<? extends StateObject> stateObjects)

Creates a new ConcatExpressionStateObject.

Parameters:

stateObjects - The list of StateObject representing the encapsulated expressions

ConcatExpressionStateObject

public ConcatExpressionStateObject(StateObject parent,
                                   StateObject... stateObjects)

Creates a new ConcatExpressionStateObject.

Parameters:

parent - The parent of this state object, which cannot be null

stateObjects - The list of StateObject representing the encapsulated expressions

Throws:

java.lang.NullPointerException - The given parent cannot be null

Method Detail

accept

public void accept(StateObjectVisitor visitor)

Visits this StateObject by the given visitor.

Parameters:

visitor - The visitor to visit this object

getExpression

public ConcatExpression 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)

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

listName

protected java.lang.String listName()

Returns the name that is uniquely identifying the list.

Specified by:

listName in class AbstractListHolderStateObject<StateObject>

Returns:

The unique name identifying the list

setExpression

public void setExpression(ConcatExpression 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 CONCAT expression

toTextInternal

protected void toTextInternal(java.lang.Appendable writer)
                       throws java.io.IOException

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.

Specified by:

toTextInternal in class AbstractStateObject

Parameters:

writer - The writer used to print out the string representation

Throws:

java.io.IOException - This should never happens, it is only required because Appendable is used instead of any concrete class