org.apache.manifoldcf.crawler.interfaces
Class SortOrder

java.lang.Object
  extended by org.apache.manifoldcf.crawler.interfaces.SortOrder

public class SortOrder
extends java.lang.Object

Class which describes specification of the sort order for a report.


Nested Class Summary
static class SortOrder.ParseBuffer
           
static class SortOrder.SortSpec
           
 
Field Summary
static java.lang.String _rcsid
           
static int SORT_ASCENDING
          Sort ascending
static int SORT_DESCENDING
          Sort descending
protected  java.util.ArrayList sortList
          The sort order list.
 
Constructor Summary
SortOrder()
          Constructor.
SortOrder(java.lang.String rep)
          Constructor from string representation.
 
Method Summary
 void addCriteria(java.lang.String columnName, int order)
          Add a sort criteria, at the front.
 void clickColumn(java.lang.String columnName)
          Click a column.
 java.lang.String getColumn(int i)
          Return an individual sort column.
 int getCount()
          Get the sort spec count.
 int getDirection(int i)
          Return an individual direction.
 java.lang.String toString()
          Convert to string form.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

_rcsid

public static final java.lang.String _rcsid
See Also:
Constant Field Values

SORT_ASCENDING

public static final int SORT_ASCENDING
Sort ascending

See Also:
Constant Field Values

SORT_DESCENDING

public static final int SORT_DESCENDING
Sort descending

See Also:
Constant Field Values

sortList

protected java.util.ArrayList sortList
The sort order list. This is an array of SortSpec objects

Constructor Detail

SortOrder

public SortOrder()
Constructor.


SortOrder

public SortOrder(java.lang.String rep)
          throws ManifoldCFException
Constructor from string representation.

Throws:
ManifoldCFException
Method Detail

toString

public java.lang.String toString()
Convert to string form.

Overrides:
toString in class java.lang.Object

clickColumn

public void clickColumn(java.lang.String columnName)
Click a column.


addCriteria

public void addCriteria(java.lang.String columnName,
                        int order)
Add a sort criteria, at the front.


getCount

public int getCount()
Get the sort spec count.


getColumn

public java.lang.String getColumn(int i)
Return an individual sort column.


getDirection

public int getDirection(int i)
Return an individual direction.