eu.etaxonomy.cdm.persistence.query
Class OrderHint

java.lang.Object
  eu.etaxonomy.cdm.persistence.query.OrderHint

Direct Known Subclasses:

NativeSqlOrderHint, RandomOrder

public class OrderHint
extends Object

Nested Class Summary

static class

OrderHint.SortOrder

Field Summary

static List<OrderHint>	ORDER_BY_ID
static List<OrderHint>	ORDER_BY_TITLE_CACHE

Constructor Summary

OrderHint(String fieldName, OrderHint.SortOrder sortOrder)

Method Summary

void	add(org.hibernate.envers.query.AuditQuery query) FIXME document this
void	add(org.hibernate.Criteria criteria, Map<String,org.hibernate.Criteria> criteriaMap) FIXME document this
static List<OrderHint>	defaultOrderHintsFor(Class<? extends CdmBase> clazz)
boolean	equals(Object obj)
String	getPropertyName() The property of a bean
OrderHint.SortOrder	getSortOrder() possible sort orders are SortOrder.ASCENDING or SortOrder.DESCENDING
int	hashCode()
boolean	isAscending()
String	toHql() Returns a hql order by clause element which can directly be used in hql queries.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

ORDER_BY_ID

public static final List<OrderHint> ORDER_BY_ID

ORDER_BY_TITLE_CACHE

public static final List<OrderHint> ORDER_BY_TITLE_CACHE

Constructor Detail

OrderHint

public OrderHint(String fieldName,
                 OrderHint.SortOrder sortOrder)

Method Detail

defaultOrderHintsFor

public static List<OrderHint> defaultOrderHintsFor(Class<? extends CdmBase> clazz)

Parameters:

clazz -

Returns:

"by titleCache" for all IdentifiableEntitys otherwise "by id"

getPropertyName

public String getPropertyName()

The property of a bean

Returns:

getSortOrder

public OrderHint.SortOrder getSortOrder()

possible sort orders are SortOrder.ASCENDING or SortOrder.DESCENDING

Returns:

isAscending

public boolean isAscending()

add

public void add(org.hibernate.Criteria criteria,
                Map<String,org.hibernate.Criteria> criteriaMap)

FIXME document this

Parameters:

criteria -

criteriaMap -

add

public void add(org.hibernate.envers.query.AuditQuery query)

FIXME document this

Parameters:

query -

toHql

public String toHql()

Returns a hql order by clause element which can directly be used in hql queries. e.g.: "titleCache ASC"

Returns:

an hql order by clause element

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object