de.tif.jacob.core.definition
Class SortOrder

java.lang.Object
  de.tif.jacob.core.definition.SortOrder

public final class SortOrder
extends java.lang.Object

This class declares the different kinds of sort orders.

See Also:

IBrowserTableField.getSortorder(), IAdhocBrowserDefinition.addBrowserField(int, String, String, String, SortOrder), IAdhocBrowserDefinition.addBrowserField(String, String, String, SortOrder)

Field Summary

static SortOrder	ASCENDING The instance for indicating that ascending sort order is used.
static SortOrder	DESCENDING The instance for indicating that descending sort order is used.
static SortOrder	NONE The instance for indicating that no sort order is used.
static java.lang.String	RCS_ID The internal revision control system id.
static java.lang.String	RCS_REV The internal revision control system id in short form.

Method Summary

static SortOrder	fromJad(CastorSortOrder jadType) Internal method for converting a XML JAD type to this class.
java.lang.String	getSqlKeyword() Internal method for determining the corresponding SQL sort order keyword.
static SortOrder	parse(java.lang.String orderString) Parses the hands over string to a valid SortOrder object.
CastorSortOrder	toJad() Internal method for converting this sort order to the corresponding XML JAD type.
java.lang.String	toString() Returns a string representation of this sort order, which is easy for a person to read.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RCS_ID

public static final transient java.lang.String RCS_ID

The internal revision control system id.

See Also:

Constant Field Values

RCS_REV

public static final transient java.lang.String RCS_REV

The internal revision control system id in short form.

See Also:

Constant Field Values

NONE

public static final SortOrder NONE

The instance for indicating that no sort order is used.

ASCENDING

public static final SortOrder ASCENDING

The instance for indicating that ascending sort order is used.

DESCENDING

public static final SortOrder DESCENDING

The instance for indicating that descending sort order is used.

Method Detail

fromJad

public static SortOrder fromJad(CastorSortOrder jadType)

Internal method for converting a XML JAD type to this class.

Parameters:

jadType - the XML JAD type

Returns:

the resulting sort order instance

getSqlKeyword

public java.lang.String getSqlKeyword()

Internal method for determining the corresponding SQL sort order keyword.

Returns:

the SQL sort order keyword or null if unsorted.

toJad

public CastorSortOrder toJad()

Internal method for converting this sort order to the corresponding XML JAD type.

Returns:

the XML JAD type

toString

public java.lang.String toString()

Returns a string representation of this sort order, which is easy for a person to read.

Overrides:

toString in class java.lang.Object

Returns:

the string representation of this sort order.

parse

public static SortOrder parse(java.lang.String orderString)

Parses the hands over string to a valid SortOrder object.

Parameters:

orderString - the order string to parse

Returns:

The SortOrder object or SortOrder.NONE if no valid mapping possible.