org.eclipse.stardust.engine.api.query

Class AttributeOrder

java.lang.Object

org.eclipse.stardust.engine.api.query.AbstractSingleOrderCriterion

org.eclipse.stardust.engine.api.query.AttributeOrder

All Implemented Interfaces:

Serializable, OrderCriterion

public class AttributeOrder
extends org.eclipse.stardust.engine.api.query.AbstractSingleOrderCriterion

Criterion for ordering elements resulting from a query according to a given attribute, either with ascending or descending values.

Version:

$Revision$

Author:

rsauer

See Also:

OrderCriteria, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AttributeOrder(FilterableAttribute attribute) Creates a criterion for ordering by ascending attribute values.
AttributeOrder(FilterableAttribute attribute, boolean ascending) Creates a criterion for ordering by either ascending or descending attribute values.

Method Summary

Methods

Modifier and Type	Method and Description
Object	accept(OrderEvaluationVisitor visitor, Object context) Visitor dispatch callback used for evaluating order criteria.
String	getAttribute() Deprecated. Use getAttributeName() instead.
String	getAttributeName() Gets the name of the attribute to order by.

Methods inherited from class org.eclipse.stardust.engine.api.query.AbstractSingleOrderCriterion

isAscending

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AttributeOrder

public AttributeOrder(FilterableAttribute attribute)

Creates a criterion for ordering by ascending attribute values.

Parameters:

attribute - The attribute to order by.

See Also:

AttributeOrder(FilterableAttribute, boolean)

AttributeOrder

public AttributeOrder(FilterableAttribute attribute,
              boolean ascending)

Creates a criterion for ordering by either ascending or descending attribute values.

Parameters:

attribute -

ascending -

Method Detail

getAttribute

public String getAttribute()

Deprecated. Use getAttributeName() instead.

Gets the name of the attribute to order by.

Returns:

The attribute name.

getAttributeName

public String getAttributeName()

Gets the name of the attribute to order by.

Returns:

The attribute name.

accept

public Object accept(OrderEvaluationVisitor visitor,
            Object context)

Description copied from interface: OrderCriterion

Visitor dispatch callback used for evaluating order criteria. Usually implemented as return visitor.visit(this, context), thus calling the appropriately overloaded visitation method.

Parameters:

visitor - The visitor performing the evaluation.

context - Information used by the visitor during the visitation process.

Returns:

Visitor specific result of the visitation.