ComparableProperty (Acid House API 0.6.2 API)

java.lang.Object
- org.eiichiro.acidhouse.metamodel.Property<E,T>
- - org.eiichiro.acidhouse.metamodel.ComparableProperty<E,T>

public class ComparableProperty<E,T extends Comparable<T>>
extends Property<E,T>

ComparableProperty is a Property extension represents a comparable property. You can get several ComparableFilter instances from this class, and then pass them to command's #filter(Filter...) methods, like this:

 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);
 // Qualify entities which their 'entity1.i' proerty is greater than or equal 
 // to 13, and 15 or 16.
 List<Entity3> entity3s = session
                .get(Entity3.class)
                .filter(entity3_.entity1.i.greaterThanOrEqualTo(13), 
                        entity3_.entity1.i.in(15, 16))
                .execute();

And sorting order. Like this:

 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.class)
                .sort(entity3_.entity1.i.desc, entity3_.i.asc)
                .execute();

Author:: Eiichiro Uchiumi

Field Summary

Fields
Modifier and Type Field and Description

Order<E,T> asc
Sorting order: ascending direction.

Order<E,T> desc
Sorting order: descending direction.

Fields
Modifier and Type	Field and Description
`Order<E,T>`	`asc` Sorting order: ascending direction.
`Order<E,T>`	`desc` Sorting order: descending direction.

Constructor Summary

Constructors
Constructor and Description
`ComparableProperty(Metamodel<E> metamodel, Type type, String name)` Constructs a new `ComparableProperty` instance with the specified `Metamodel` instance which has this metamodel property, property type and property name.
`ComparableProperty(Property<E,?> parent, Type type, String name)` Constructs a new `ComparableProperty` instance with the specified `Property` instance which has this metamodel property, property type and property name.

Method Summary

Methods
Modifier and Type	Method and Description
`Filter<T>`	`equalTo(T value)` Creates a `Filter` to indicate whether this property is equal to the specified value or not (==).
`Filter<T>`	`greaterThan(T value)` Creates a `Filter` to indicate whether this property is greater than the specified value or not (>).
`Filter<T>`	`greaterThanOrEqualTo(T value)` Creates a `Filter` to indicate whether this property is greater than or equal to the specified value or not (>=).
`Filter<T>`	`in(T... values)` Creates a `Filter` to indicate whether this property is contained in the specified value or not (IN(...)).
`Filter<T>`	`lessThan(T value)` Creates a `Filter` to indicate whether this property is less than the specified value or not (<).
`Filter<T>`	`lessThanOrEqualTo(T value)` Creates a `Filter` to indicate whether this property is less than or equal to the specified value or not (<=).
`Filter<T>`	`notEqualTo(T value)` Creates a `Filter` to indicate whether this property is not equal to the specified value or not (!=, <>).

Methods inherited from class org.eiichiro.acidhouse.metamodel.Property
get, metamodel, name, parent, path, set, type

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - desc
```
public final Order<E,T extends Comparable<T>> desc
```
    Sorting order: descending direction.
  - asc
```
public final Order<E,T extends Comparable<T>> asc
```
    Sorting order: ascending direction.
- Constructor Detail
  - ComparableProperty
```
public ComparableProperty(Metamodel<E> metamodel,
                  Type type,
                  String name)
```
    Constructs a new ComparableProperty instance with the specified Metamodel instance which has this metamodel property, property type and property name.
    
    Parameters:
    metamodel - The Metamodel instance which has this metamodel property.
    type - The property type.
    name - The property name.
  - ComparableProperty
```
public ComparableProperty(Property<E,?> parent,
                  Type type,
                  String name)
```
    Constructs a new ComparableProperty instance with the specified Property instance which has this metamodel property, property type and property name.
    
    Parameters:
    parent - The parent Property instance which has this metamodel property.
    type - The property type.
    name - The property name.
- Method Detail
  - equalTo
```
public Filter<T> equalTo(T value)
```
    Creates a Filter to indicate whether this property is equal to the specified value or not (==).
    
    Parameters:
    value - The value to be evaluated.
    
    Returns:
    The Filter to indicate whether this property is equal to the specified value or not.
  - notEqualTo
```
public Filter<T> notEqualTo(T value)
```
    Creates a Filter to indicate whether this property is not equal to the specified value or not (!=, <>).
    
    Parameters:
    value - The value to be evaluated.
    
    Returns:
    The Filter to indicate whether this property is not equal to the specified value or not.
  - greaterThan
```
public Filter<T> greaterThan(T value)
```
    Creates a Filter to indicate whether this property is greater than the specified value or not (>).
    
    Parameters:
    value - The value to be evaluated.
    
    Returns:
    The Filter to indicate whether this property is greater than the specified value or not.
  - greaterThanOrEqualTo
```
public Filter<T> greaterThanOrEqualTo(T value)
```
    Creates a Filter to indicate whether this property is greater than or equal to the specified value or not (>=).
    
    Parameters:
    value - The value to be evaluated.
    
    Returns:
    The Filter to indicate whether this property is greater than or equal to the specified value or not.
  - lessThan
```
public Filter<T> lessThan(T value)
```
    Creates a Filter to indicate whether this property is less than the specified value or not (<).
    
    Parameters:
    value - The value to be evaluated.
    
    Returns:
    The Filter to indicate whether this property is less than the specified value or not.
  - lessThanOrEqualTo
```
public Filter<T> lessThanOrEqualTo(T value)
```
    Creates a Filter to indicate whether this property is less than or equal to the specified value or not (<=).
    
    Parameters:
    value - The value to be evaluated.
    
    Returns:
    The Filter to indicate whether this property is less than or equal to the specified value or not.
  - in
```
public Filter<T> in(T... values)
```
    Creates a Filter to indicate whether this property is contained in the specified value or not (IN(...)).
    
    Parameters:
    value - The value to be evaluated.
    
    Returns:
    The Filter to indicate whether this property is contained in the specified value or not.

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.eiichiro.acidhouse.metamodel.Property

Methods inherited from class java.lang.Object

Field Detail

desc

asc

Constructor Detail

ComparableProperty

ComparableProperty

Method Detail

equalTo

notEqualTo

greaterThan

greaterThanOrEqualTo

lessThan

lessThanOrEqualTo

in