com.sun.syndication.feed.module.sle.types
Class Sort

java.lang.Object
  extended by com.sun.syndication.feed.module.sle.types.Sort
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class Sort
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

The cf:sort element is intended to inform the client that the property to which it refers is one that is “sortable� – that is, that the client should provide a user interface that allows the user to sort on that property.

The cf:sort element can also be used to provide a label for the default sort that appears in the list (in this case, only the label attribute should be included).

The cf:sort element contains the following attributes:

Author:
Robert "kebernet" Cooper
See Also:
Serialized Form

Field Summary
static java.lang.String DATE_TYPE
          dataType value for Date information.
static java.lang.String NUMBER_TYPE
          DataType value for Number information.
static java.lang.String TEXT_TYPE
          dataType value for Text information
 
Constructor Summary
Sort(org.jdom.Namespace namespace, java.lang.String element, java.lang.String dataType, java.lang.String label, boolean defaultOrder)
          Creates a new instance of Sort
 
Method Summary
 java.lang.Object clone()
           
 boolean equals(java.lang.Object o)
           
 java.lang.String getDataType()
          Returns the dataType of the sort
 boolean getDefaultOrder()
          Indicates this is the natural order of the feed.
 java.lang.String getElement()
          Name of the element.
 java.lang.String getLabel()
          User label for sorting.
 org.jdom.Namespace getNamespace()
          Namespace of the element
 int hashCode()
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

DATE_TYPE

public static final java.lang.String DATE_TYPE
dataType value for Date information.

See Also:
Constant Field Values

TEXT_TYPE

public static final java.lang.String TEXT_TYPE
dataType value for Text information

See Also:
Constant Field Values

NUMBER_TYPE

public static final java.lang.String NUMBER_TYPE
DataType value for Number information.

See Also:
Constant Field Values
Constructor Detail

Sort

public Sort(org.jdom.Namespace namespace,
            java.lang.String element,
            java.lang.String dataType,
            java.lang.String label,
            boolean defaultOrder)
Creates a new instance of Sort

Parameters:
namespace - Namespace of the element
element - Name of the element
dataType - data-type of the element
label - Label for the sort
defaultOrder - indicates if this is the defaul order of the feed.
Method Detail

getDataType

public java.lang.String getDataType()
Returns the dataType of the sort

Returns:
Returns the dataType of the sort

getDefaultOrder

public boolean getDefaultOrder()
Indicates this is the natural order of the feed.

Returns:
Indicates this is the natural order of the feed.

getElement

public java.lang.String getElement()
Name of the element.

Returns:
Name of the element.

getLabel

public java.lang.String getLabel()
User label for sorting.

Returns:
User label for sorting.

getNamespace

public org.jdom.Namespace getNamespace()
Namespace of the element

Returns:
Namespace of the element

clone

public java.lang.Object clone()
Overrides:
clone in class java.lang.Object

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object


Copyright © 2006-2009. All Rights Reserved.