Order (Concourse Java API)

All Known Implementing Classes:

BuildableOrderState, NoOrder, OrderAtState, OrderByState, OrderDirectionState
```
public interface Order
```
Order encapsulates the semantics of a result set sorting. Any given time, objects of this class can exist in one of two modes: building or built. When an Order is built, it is guaranteed to represent a fully and well formed sort order that can be processed. On the other hand, when a Order is building it is in an incomplete state.
This class is the public interface to Order construction. It is meant to be used in a chained manner, where the caller initially calls by(java.lang.String) and continues to construct the Order using the options available from each subsequently returned state.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static OrderByState`	`by(String key)` Start building a new `Order`.
`static Order`	`from(OrderTree tree)` Return an `Order` based on the parsed statement that produced the `OrderTree`.
`default boolean`	`isSingular()` Return `true` if this `Order` only contains one component, and therefore can be processed by consulting a single index.
`default Set<String>`	`keys()` Return all the keys that are referenced by this `Order`.
`default Map<String,Collection<Timestamp>>`	`keysWithTimestamps()` Return any of the `keys()` referenced by this `Order` that have a `Timestamp` as a mapping from the key to a collection of all of its associated timestamps.
`static Order`	`none()` Return an `Order` that specifies no order.
`List<OrderComponent>`	`spec()` Return the order specification, expressed as an ordered list of `components` containing each key, an optional `Timestamp` and the the corresponding direction ordinal (e.g.

- Method Detail
  - by
```
static OrderByState by(String key)
```
    Start building a new Order.
    
    Returns:
    
    the Order builder
  - from
```
static Order from(OrderTree tree)
```
    Return an Order based on the parsed statement that produced the OrderTree.
    
    Parameters:
    
    tree -
    
    Returns:
    
    the associated Order
  - none
```
static Order none()
```
    Return an Order that specifies no order.
    
    Returns:
    
    a no-op Order
  - isSingular
```
default boolean isSingular()
```
    Return true if this Order only contains one component, and therefore can be processed by consulting a single index.
    
    Returns:
    
    true if this Order is singular
  - keys
```
default Set<String> keys()
```
    Return all the keys that are referenced by this Order.
    
    Returns:
    
    a Set of all the keys that are referenced by this Order
  - keysWithTimestamps
```
default Map<String,Collection<Timestamp>> keysWithTimestamps()
```
    Return any of the keys() referenced by this Order that have a Timestamp as a mapping from the key to a collection of all of its associated timestamps.
    
    Returns:
    
    a mapping from order keys to their timestamps (if applicable)
  - spec
```
List<OrderComponent> spec()
```
    Return the order specification, expressed as an ordered list of components containing each key, an optional Timestamp and the the corresponding direction ordinal (e.g. 1 for ASC and -1 for DESC) in the constructed Order.
    
    Returns:
    
    a sequential list of all the OrderComponents that form this Order.

Interface Order

Method Summary

Method Detail

by

from

none

isSingular

keys

keysWithTimestamps

spec