Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

nectar.data
Class OrderByPostElement  view OrderByPostElement download OrderByPostElement.java

java.lang.Object
  extended bynectar.data.OrderByPostElement
All Implemented Interfaces:
PostElement

public class OrderByPostElement
extends java.lang.Object
implements PostElement

Analogous to the SQL "order by field_name [asc|desc]" clause. You can append several sorting fields by using the append method.


Nested Class Summary
 class OrderByPostElement.OrderByElm
          Internal data element defining the order by element.
 
Field Summary
static byte ASC
          Ascending order direction.
static byte DESC
          Descending order direction.
(package private)  java.util.List list
           
 
Constructor Summary
OrderByPostElement()
          Creates an empty OrderByPostElement
OrderByPostElement(byte sort, FieldElement fe)
          Creates an OrderByPostElement with the given FieldElement sorted in the given direction.
OrderByPostElement(FieldElement fe)
          Creates an OrderByPostElement with the given FieldElement sorted in ASCending direction.
 
Method Summary
 void append(byte sorting, FieldElement fe)
          append a field to sort by.
 void append(FieldElement fe)
          append a field to sort by.
 void append(OrderByPostElement.OrderByElm e)
          append a field to sort by.
 java.lang.Object clone()
          creates an identical copies of this instance.
 java.util.Iterator getListIterator()
          creates and returns an iterator to the internal list of OrderByPostElement.OrderByElm objects.
 boolean isEmpty()
          does this object define any fieldElements for sorting?
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ASC

public static final byte ASC
Ascending order direction.

See Also:
Constant Field Values

DESC

public static final byte DESC
Descending order direction.

See Also:
Constant Field Values

list

java.util.List list
Constructor Detail

OrderByPostElement

public OrderByPostElement()
Creates an empty OrderByPostElement


OrderByPostElement

public OrderByPostElement(FieldElement fe)
Creates an OrderByPostElement with the given FieldElement sorted in ASCending direction.


OrderByPostElement

public OrderByPostElement(byte sort,
                          FieldElement fe)
Creates an OrderByPostElement with the given FieldElement sorted in the given direction.

Method Detail

clone

public java.lang.Object clone()
creates an identical copies of this instance.


getListIterator

public java.util.Iterator getListIterator()
creates and returns an iterator to the internal list of OrderByPostElement.OrderByElm objects.


isEmpty

public boolean isEmpty()
does this object define any fieldElements for sorting?


append

public void append(byte sorting,
                   FieldElement fe)
append a field to sort by.


append

public void append(FieldElement fe)
append a field to sort by.


append

public void append(OrderByPostElement.OrderByElm e)
append a field to sort by.