org.camunda.bpm.engine.impl

Class QueryOrderingProperty

java.lang.Object

org.camunda.bpm.engine.impl.QueryOrderingProperty

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

VariableOrderProperty

public class QueryOrderingProperty
extends Object
implements 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

Property Summary

Properties

Type	Property and Description
boolean	isContained

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
QueryOrderingProperty()
QueryOrderingProperty(QueryProperty queryProperty, Direction direction)
QueryOrderingProperty(String relation, QueryProperty queryProperty)

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Property Detail

isContained

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)

Field Detail

RELATION_VARIABLE

public static final String RELATION_VARIABLE

See Also:

Constant Field Values

RELATION_PROCESS_DEFINITION

public static final String RELATION_PROCESS_DEFINITION

See Also:

Constant Field Values

RELATION_CASE_DEFINITION

public static final String RELATION_CASE_DEFINITION

See Also:

Constant Field Values

serialVersionUID

protected static final long serialVersionUID

See Also:

Constant Field Values

relation

protected String relation

queryProperty

protected QueryProperty queryProperty

direction

protected Direction direction

relationConditions

protected List<QueryEntityRelationCondition> relationConditions

Constructor Detail

QueryOrderingProperty

public QueryOrderingProperty()

QueryOrderingProperty

public QueryOrderingProperty(QueryProperty queryProperty,
                     Direction direction)

QueryOrderingProperty

public QueryOrderingProperty(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 List<QueryEntityRelationCondition> getRelationConditions()

setRelationConditions

public void setRelationConditions(List<QueryEntityRelationCondition> relationConditions)

hasRelationConditions

public boolean hasRelationConditions()

getRelation

public String getRelation()

setRelation

public void setRelation(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 String toString()

Overrides:

toString in class Object

getRelationConditionsString

public String getRelationConditionsString()