|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.datasalt.pangool.tuplemr.OrderBy
public class OrderBy
OrderBy is a convenience builder used by TupleMRConfig
, similar to
Criteria
. The main difference is that OrderBy
is mutable
using the concatenation pattern and allows to specify schemaOrder.
TupleMRConfig
.
Constructor Summary | |
---|---|
OrderBy()
|
|
OrderBy(List<Criteria.SortElement> elements)
|
Method Summary | |
---|---|
OrderBy |
add(String name,
Criteria.Order order)
Adds a new field to order by and its specified order. |
OrderBy |
add(String name,
Criteria.Order order,
Criteria.NullOrder nullOrder)
Adds a new field to order by and its specified order. |
OrderBy |
add(String name,
Criteria.Order order,
Criteria.NullOrder nullOrder,
org.apache.hadoop.io.RawComparator<?> comparator)
Same as OrderBy#add(String, Order) but adding the possibility to
specify a custom comparator for that field. |
OrderBy |
addSchemaOrder(Criteria.Order order)
This method,unlike the traditional OrderBy#add(String, Order, NullOrder, RawComparator) method, adds a symbolic
elements to order by. |
boolean |
containsBeforeSchemaOrder(String field)
True if field was added before calling #addSchemaOrder(Order) |
boolean |
containsFieldName(String field)
True if field was added using #add(String, Order) |
List<Criteria.SortElement> |
getElements()
Returns a Criteria.SortElement object for every field added to this builder. |
Criteria.Order |
getSchemaOrder()
Gets the schemaOrder if set. |
Integer |
getSchemaOrderIndex()
Returns the position in the list where schemaOrder was added using OrderBy#addSchemaOrder(Order) |
static OrderBy |
parse(String orderBy)
Parse in the form "field1:asc, field2:desc,...,fieldn:asc|null_smallest" Examples: "f1,f2,f3" "f1:asc,f2:desc,f3" "f1,f2:asc|null_smallest,f3:desc|null_biggest" |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public OrderBy(List<Criteria.SortElement> elements)
public OrderBy()
Method Detail |
---|
public static OrderBy parse(String orderBy)
public OrderBy add(String name, Criteria.Order order)
name
- Field's nameorder
- Field's orderCriteria.Order
public OrderBy add(String name, Criteria.Order order, Criteria.NullOrder nullOrder)
name
- Field's nameorder
- Field's ordernullOrder
- Sorting of null values in nullable fields. Criteria.NullOrder.NULL_SMALLEST
if you want
nulls to be the smallest value or Criteria.NullOrder.NULL_BIGGEST
if you want
nulls to be the biggest. Ignored if fields are not nullable. Cannot be null.Criteria.Order
,
Criteria.NullOrder
public OrderBy add(String name, Criteria.Order order, Criteria.NullOrder nullOrder, org.apache.hadoop.io.RawComparator<?> comparator)
OrderBy#add(String, Order)
but adding the possibility to
specify a custom comparator for that field.
name
- Field's nameorder
- Field's ordernullOrder
- Sorting of null values in nullable fields. Criteria.NullOrder.NULL_SMALLEST
if you want
nulls to be the smallest value or Criteria.NullOrder.NULL_BIGGEST
if you want
nulls to be the biggest. Ignored if fields are not nullable. Cannot be null.comparator
- Custom comparator instanceCriteria.Order
,
Criteria.NullOrder
public OrderBy addSchemaOrder(Criteria.Order order)
OrderBy#add(String, Order, NullOrder, RawComparator)
method, adds a symbolic
elements to order by.This method only works in a multi-schema scenario, and it specifies that tuples will be sorted by their schema,not by a field's name.
TupleMRConfigBuilder.setSpecificOrderBy(String, OrderBy)
public List<Criteria.SortElement> getElements()
Criteria.SortElement
object for every field added to this builder.
Criteria.SortElement
public Criteria.Order getSchemaOrder()
public Integer getSchemaOrderIndex()
OrderBy#addSchemaOrder(Order)
public boolean containsFieldName(String field)
#add(String, Order)
public boolean containsBeforeSchemaOrder(String field)
#addSchemaOrder(Order)
public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |