Class GroupByClauseStateObject
- 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.GroupByClauseStateObject
-
- All Implemented Interfaces:
ListHolderStateObject<StateObject>
,StateObject
public class GroupByClauseStateObject extends AbstractListHolderStateObject<StateObject>
TheGROUP BY
construct enables the aggregation of values according to the properties of an entity class.BNF:groupby_clause ::= GROUP BY groupby_item {, groupby_item}*
- Since:
- 2.4
- Version:
- 2.4
- Author:
- Pascal Filion
- See Also:
GroupByClause
-
-
Field Summary
Fields Modifier and Type Field Description static String
GROUP_BY_ITEMS_LIST
Notify the list ofStateObjects
representing theGROUP BY
items.
-
Constructor Summary
Constructors Constructor Description GroupByClauseStateObject(AbstractSelectStatementStateObject parent)
Creates a newGroupByClauseStateObject
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(StateObjectVisitor visitor)
Visits thisStateObject
by the givenvisitor
.StateObject
addGroupByItem(String path)
Adds the given path as a select item, which can either be an identification variable or a state-field path expression.GroupByClause
getExpression()
Returns the actual parsed object if thisStateObject
representation of the JPQL query was created by parsing an existing JPQL query.AbstractSelectStatementStateObject
getParent()
Returns the parent of thisStateObject
.boolean
isEquivalent(StateObject stateObject)
Determines whether the givenStateObject
is equivalent to this one, i.e.void
parse(String jpqlFragment)
Parses the given JPQL fragment, which will represent the group by items.void
setExpression(GroupByClause expression)
Keeps a reference of theparsed object
object, which should only be done when this object is instantiated during the conversion of a parsed JPQL query intoStateObjects
.-
Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractListHolderStateObject
addItem, addItems, addListChangeListener, canMoveDown, canMoveUp, getItem, hasItems, items, itemsSize, moveDown, moveUp, removeItem, removeItems, removeListChangeListener
-
Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject
addPropertyChangeListener, children, decorate, equals, findIdentificationVariable, getDeclaration, getDecorator, getGrammar, getManagedTypeProvider, getQueryBuilder, getRoot, getType, getType, getTypeHelper, getTypeRepository, hashCode, isDecorated, removePropertyChangeListener, setExpression, setParent, toString, toString, toText
-
Methods inherited from interface org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject
addPropertyChangeListener, children, decorate, findIdentificationVariable, getDeclaration, getDecorator, getGrammar, getManagedTypeProvider, getQueryBuilder, getRoot, isDecorated, removePropertyChangeListener, setParent, toString, toText
-
-
-
-
Field Detail
-
GROUP_BY_ITEMS_LIST
public static final String GROUP_BY_ITEMS_LIST
Notify the list ofStateObjects
representing theGROUP BY
items.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
GroupByClauseStateObject
public GroupByClauseStateObject(AbstractSelectStatementStateObject parent)
Creates a newGroupByClauseStateObject
.- Parameters:
parent
- The parent of this state object, which cannot benull
- Throws:
NullPointerException
- The given parent cannot benull
-
-
Method Detail
-
accept
public void accept(StateObjectVisitor visitor)
Visits thisStateObject
by the givenvisitor
.- Parameters:
visitor
- Thevisitor
to visit this object
-
addGroupByItem
public StateObject addGroupByItem(String path)
Adds the given path as a select item, which can either be an identification variable or a state-field path expression.- Parameters:
path
- Either an identification variable or a state-field path expression- Returns:
- The
StateObject
encapsulating the given path
-
getExpression
public GroupByClause getExpression()
Returns the actual parsed object if thisStateObject
representation of the JPQL query was created by parsing an existing JPQL query.- Specified by:
getExpression
in interfaceStateObject
- Overrides:
getExpression
in classAbstractStateObject
- Returns:
- The parsed object when a JPQL query is parsed and converted into a
StateObject
ornull
when the JPQL query is manually created (i.e. not from a string)
-
getParent
public AbstractSelectStatementStateObject getParent()
Returns the parent of thisStateObject
.- Specified by:
getParent
in interfaceStateObject
- Overrides:
getParent
in classAbstractStateObject
- Returns:
- Returns the parent of this
StateObject
, which isnull
only when this is the root of the hierarchy
-
isEquivalent
public boolean isEquivalent(StateObject stateObject)
Determines whether the givenStateObject
is equivalent to this one, i.e. the information of bothStateObject
is the same.- Specified by:
isEquivalent
in interfaceStateObject
- Overrides:
isEquivalent
in classAbstractStateObject
- Parameters:
stateObject
- TheStateObject
to compare its content to this one- Returns:
true
if both object are equivalent;false
otherwise
-
parse
public void parse(String jpqlFragment)
Parses the given JPQL fragment, which will represent the group by items. The fragment cannot start with theGROUP BY
.- Parameters:
jpqlFragment
- The string representation of the group by items
-
setExpression
public void setExpression(GroupByClause expression)
Keeps a reference of theparsed object
object, which should only be done when this object is instantiated during the conversion of a parsed JPQL query intoStateObjects
.- Parameters:
expression
- Theparsed object
representing aGROUP BY
clause
-
-