OrderBy (YABR)

tonic@yabr:~$ Source Portfolio tonicbox.dev

java.lang.Object
- com.tonic.analysis.query.ast.OrderBy

```
public final class OrderBy
extends Object
```
Ordering clause for query results: a sort key and a direction.

Constructor Summary

Constructors
Constructor Description

OrderBy(String key, boolean ascending)
Creates an ordering clause.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static OrderBy`	`asc(String key)`	Creates an ascending ordering.
`boolean`	`ascending()`
`static OrderBy`	`desc(String key)`	Creates a descending ordering.
`boolean`	`equals(Object o)`
`int`	`hashCode()`
`String`	`key()`
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - OrderBy
```
public OrderBy(String key,
               boolean ascending)
```
    Creates an ordering clause.
    
    Parameters:
    
    key - the attribute name to sort by
    
    ascending - whether results sort in ascending order
- Method Detail
  - key
```
public String key()
```
    Returns:
    
    the sort key attribute name
  - ascending
```
public boolean ascending()
```
    Returns:
    
    whether results sort in ascending order
  - asc
```
public static OrderBy asc(String key)
```
    Creates an ascending ordering.
    
    Parameters:
    
    key - the attribute name to sort by
    
    Returns:
    
    the ascending clause
  - desc
```
public static OrderBy desc(String key)
```
    Creates a descending ordering.
    
    Parameters:
    
    key - the attribute name to sort by
    
    Returns:
    
    the descending clause
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object