org.eiichiro.acidhouse

Class Order<E,T extends Comparable<T>>

java.lang.Object

org.eiichiro.acidhouse.Order<E,T>

All Implemented Interfaces:

Comparator<E>

public class Order<E,T extends Comparable<T>>
extends Object
implements Comparator<E>

Order represents a sorting order for Acid Houses' typesafe "Command builder API". You can get Order instance from metamodel property and can pass to GetList and GetScalar. As an example:

 import org.eiichiro.acidhouse.Session;
 import org.eiichiro.acidhouse.appengine.AppEngineDatastoreSession;
 ...
 
 // Create 'Session' instance.
 Session session = new AppEngineDatastoreSession();
 // Get metamodel instance of 'Entity3' class.
 Entity3_ entity3_ = Metamodels.metamodel(Entity3.class);
 // Get all 'Entity3' entities sorted by 'entity1.i' property in descending 
 // order and 'i' property in descending order.
 List<Entity3> entity3s = session.get(entity3_)
                .sort(entity3_.entity1.i.desc, entity3_.i.desc)
                .execute();
 

Author:

Eiichiro Uchiumi

See Also:

ComparableProperty, GetList, GetScalar

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Order.Direction Direction represents a sorting direction.

Constructor Summary

Constructors

Constructor and Description
Order(ComparableProperty<E,T> property, Order.Direction direction) Constructs a new Order instance with the specified ComparableProperty and sorting direction.

Method Summary

Methods

Modifier and Type	Method and Description
int	compare(E entity1, E entity2) Compares the specified two entities.
Order.Direction	direction() Returns sorting direction.
ComparableProperty<E,T>	property() Returns ComparableProperty to be sorted.
String	toString() Returns the custom string representation.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

equals

Constructor Detail

Order

public Order(ComparableProperty<E,T> property,
     Order.Direction direction)

Constructs a new Order instance with the specified ComparableProperty and sorting direction.

Parameters:

property - ComparableProperty to be sorted.

direction - The sorting direction.

Method Detail

property

public ComparableProperty<E,T> property()

Returns ComparableProperty to be sorted.

Returns:

The ComparableProperty to be sorted.

direction

public Order.Direction direction()

Returns sorting direction.

Returns:

The sorting direction.

compare

public int compare(E entity1,
          E entity2)

Compares the specified two entities.

Specified by:

compare in interface Comparator<E>

Parameters:

entity1 - An entity to be compared.

entity2 - An entity to be compared.

Returns:

The comparison result.

toString

public String toString()

Returns the custom string representation.

Overrides:

toString in class Object

Returns:

The custom string representation.