org.nuxeo.ecm.core.api
Class SortInfo

java.lang.Object
  org.nuxeo.ecm.core.api.SortInfo

All Implemented Interfaces:

java.io.Serializable

public class SortInfo
extends java.lang.Object
implements java.io.Serializable

This class holds the details for sorting.

Author:

George Lefter

See Also:

Serialized Form

Field Summary

static java.lang.String	SORT_ASCENDING_NAME
static java.lang.String	SORT_COLUMN_NAME

Constructor Summary

SortInfo(java.lang.String sortColumn, boolean sortAscending)

Method Summary

static java.util.Map<java.lang.String,java.io.Serializable>	asMap(SortInfo sortInfo) Returns a map for given sort info, or null if sort info is null.
static SortInfo	asSortInfo(java.util.Map<java.lang.String,java.io.Serializable> map) Returns a sort info for given map, or null if map is null or does not contain both keys SORT_COLUMN_NAME and SORT_ASCENDING_NAME.
boolean	equals(java.lang.Object obj)
boolean	getSortAscending()
java.lang.String	getSortColumn()
void	setSortAscending(boolean sortAscending)
void	setSortColumn(java.lang.String sortColumn)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SORT_COLUMN_NAME

public static final java.lang.String SORT_COLUMN_NAME

See Also:

Constant Field Values

SORT_ASCENDING_NAME

public static final java.lang.String SORT_ASCENDING_NAME

See Also:

Constant Field Values

Constructor Detail

SortInfo

public SortInfo(java.lang.String sortColumn,
                boolean sortAscending)

Parameters:

sortColumn - the column to sort by, in schema:field format

sortAscending - whether to sort ascending or descending

Method Detail

getSortAscending

public boolean getSortAscending()

getSortColumn

public java.lang.String getSortColumn()

Returns:

the column to sort by, in schema:field format

setSortColumn

public void setSortColumn(java.lang.String sortColumn)

Since:

5.4.0

setSortAscending

public void setSortAscending(boolean sortAscending)

Since:

5.4.0

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

asMap

public static java.util.Map<java.lang.String,java.io.Serializable> asMap(SortInfo sortInfo)

Returns a map for given sort info, or null if sort info is null.

The map keys are SORT_COLUMN_NAME and SORT_ASCENDING_NAME.

Since:

5.4.0

asSortInfo

public static SortInfo asSortInfo(java.util.Map<java.lang.String,java.io.Serializable> map)

Returns a sort info for given map, or null if map is null or does not contain both keys SORT_COLUMN_NAME and SORT_ASCENDING_NAME.

Since:

5.4.0

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object