Package org.camunda.bpm.engine.impl

Class QueryOrderingProperty

java.lang.Object

org.camunda.bpm.engine.impl.QueryOrderingProperty

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

VariableOrderProperty

public class QueryOrderingProperty
extends java.lang.Object
implements java.io.Serializable

A QueryOrderingProperty specifies a condition by which the results of a query should be sorted. It can either specify a sorting by a property of the entities to be selected or a sorting by a property of a related entity. For example in a TaskQuery, the entity to be selected is Task while a related entity could be a VariableInstance.

It is made up of the following:

relation

A symbolic name that identifies a related entity. null if an ordering over a property of the entity to be selected is expressed.

queryProperty

The property to be sorted on. An instance of QueryProperty.

direction

The ordering direction, refer to Direction

relationConditions

A list of constraints that describe the nature of the relation to another entity (or in SQL terms, the joining conditions). Is null if relation is null. Contains instances of QueryEntityRelationCondition.

Author:

Thorben Lindhauer

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Direction	direction
protected QueryProperty	queryProperty
protected java.lang.String	relation
static java.lang.String	RELATION_CASE_DEFINITION
static java.lang.String	RELATION_DEPLOYMENT
static java.lang.String	RELATION_PROCESS_DEFINITION
static java.lang.String	RELATION_VARIABLE
protected java.util.List<QueryEntityRelationCondition>	relationConditions
protected static long	serialVersionUID

Constructor Summary

Constructors

Constructor	Description
QueryOrderingProperty()
QueryOrderingProperty(java.lang.String relation, QueryProperty queryProperty)
QueryOrderingProperty(QueryProperty queryProperty, Direction direction)

Method Summary

Modifier and Type	Method	Description
Direction	getDirection()
QueryProperty	getQueryProperty()
java.lang.String	getRelation()
java.util.List<QueryEntityRelationCondition>	getRelationConditions()
java.lang.String	getRelationConditionsString()
boolean	hasRelationConditions()
boolean	isContainedProperty()
void	setDirection(Direction direction)
void	setQueryProperty(QueryProperty queryProperty)
void	setRelation(java.lang.String relation)
void	setRelationConditions(java.util.List<QueryEntityRelationCondition> relationConditions)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RELATION_VARIABLE

public static final java.lang.String RELATION_VARIABLE

See Also:

Constant Field Values

RELATION_PROCESS_DEFINITION

public static final java.lang.String RELATION_PROCESS_DEFINITION

See Also:

Constant Field Values

RELATION_CASE_DEFINITION

public static final java.lang.String RELATION_CASE_DEFINITION

See Also:

Constant Field Values

RELATION_DEPLOYMENT

public static final java.lang.String RELATION_DEPLOYMENT

See Also:

Constant Field Values

serialVersionUID

protected static final long serialVersionUID

See Also:

Constant Field Values

relation

protected java.lang.String relation

queryProperty

protected QueryProperty queryProperty

direction

protected Direction direction

relationConditions

protected java.util.List<QueryEntityRelationCondition> relationConditions

Constructor Detail

QueryOrderingProperty

public QueryOrderingProperty()

QueryOrderingProperty

public QueryOrderingProperty(QueryProperty queryProperty,
                             Direction direction)

QueryOrderingProperty

public QueryOrderingProperty(java.lang.String relation,
                             QueryProperty queryProperty)

Method Detail

getQueryProperty

public QueryProperty getQueryProperty()

setQueryProperty

public void setQueryProperty(QueryProperty queryProperty)

setDirection

public void setDirection(Direction direction)

getDirection

public Direction getDirection()

getRelationConditions

public java.util.List<QueryEntityRelationCondition> getRelationConditions()

setRelationConditions

public void setRelationConditions(java.util.List<QueryEntityRelationCondition> relationConditions)

hasRelationConditions

public boolean hasRelationConditions()

getRelation

public java.lang.String getRelation()

setRelation

public void setRelation(java.lang.String relation)

isContainedProperty

public boolean isContainedProperty()

Returns:

whether this ordering property is contained in the default fields of the base entity (e.g. task.NAME_ is a contained property; LOWER(task.NAME_) or variable.TEXT_ (given a task query) is not contained)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getRelationConditionsString

public java.lang.String getRelationConditionsString()