org.modeshape.jcr.query.model

Class Ordering

java.lang.Object

org.modeshape.jcr.query.model.Ordering

All Implemented Interfaces:

Serializable, Ordering, LanguageObject, Visitable

@Immutable
public class Ordering
extends Object
implements LanguageObject, Ordering

A specification of the ordering for the results.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Ordering(DynamicOperand operand, Order order, NullOrder nullOrder) Create a new ordering specification, given the supplied operand and order.

Method Summary

Modifier and Type	Method and Description
void	accept(Visitor visitor) Accept the supplied visitor, which should call back to the visitor to complete the double-dispatch operation.
boolean	equals(Object obj)
String	getNullOrder() Gets the order.
DynamicOperand	getOperand()
String	getOrder()
int	hashCode()
boolean	isDefaultNullOrder()
NullOrder	nullOrder()
Order	order()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Ordering

public Ordering(DynamicOperand operand,
                Order order,
                NullOrder nullOrder)

Create a new ordering specification, given the supplied operand and order.

Parameters:

operand - the operand being ordered

order - the order type

nullOrder - the order specification for null values; may not be null

Throws:

IllegalArgumentException - if the operand or order type is null

Method Detail

getOperand

public DynamicOperand getOperand()

Specified by:

getOperand in interface Ordering

order

public Order order()

nullOrder

public NullOrder nullOrder()

isDefaultNullOrder

public boolean isDefaultNullOrder()

getOrder

public String getOrder()

Specified by:

getOrder in interface Ordering

getNullOrder

public String getNullOrder()

Description copied from interface: Ordering

Gets the order.

Returns:

either QueryObjectModelConstants.JCR_ORDER_NULLS_FIRST or QueryObjectModelConstants.JCR_ORDER_NULLS_LAST

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

accept

public void accept(Visitor visitor)

Description copied from interface: Visitable

Accept the supplied visitor, which should call back to the visitor to complete the double-dispatch operation.

Specified by:

accept in interface Visitable

Parameters:

visitor - the visitor; never null