org.andromda.utils.beans

Class SortCriteria

java.lang.Object

org.andromda.utils.beans.SortCriteria

All Implemented Interfaces:

Serializable

public class SortCriteria
extends Object
implements Serializable

Used to contain sort criteria.

Author:

Chad Brandon

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SortCriteria.Ordering Represents the types of ordering that may occur when sorting with the BeanSorter.

Constructor Summary

Constructors

Constructor and Description
SortCriteria(String sortBy) Creates a SortCriteria object with the default ascending ordering and nulls placed first.
SortCriteria(String sortBy, boolean nullsFirst) Creates a new instance of this SortCriteria class.
SortCriteria(String sortBy, SortCriteria.Ordering ordering) Creates a new instance of this SortCriteria class.
SortCriteria(String sortBy, SortCriteria.Ordering ordering, boolean nullsFirst) Creates a new instance of this SortCriteria class.

Method Summary

Methods

Modifier and Type	Method and Description
SortCriteria.Ordering	getOrdering() Gets the current ordering to be used.
String	getSortBy() Gets the sort by name.
boolean	isNullsFirst()
void	setNullsFirst(boolean nullsFirst)
void	setOrdering(SortCriteria.Ordering ordering) Sets the ordering to use for sorting.
void	setSortBy(String sortBy) Sets the name of the property by which to sort.

Methods inherited from class java.lang.Object

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

Constructor Detail

SortCriteria

public SortCriteria(String sortBy)

Creates a SortCriteria object with the default ascending ordering and nulls placed first.

Parameters:

sortBy - the property to sort by, this can be nested (i.e. person.name.firstName will be sorted).

SortCriteria

public SortCriteria(String sortBy,
            boolean nullsFirst)

Creates a new instance of this SortCriteria class.

Parameters:

sortBy - the property to sort by, this can be nested (i.e. person.name.firstName will be sorted).

nullsFirst - whether or not nulls will be placed first or last when sorting occurs.

SortCriteria

public SortCriteria(String sortBy,
            SortCriteria.Ordering ordering)

Creates a new instance of this SortCriteria class.

Parameters:

sortBy - the property to sort by, this can be nested (i.e. person.name.firstName will be sorted).

ordering - the ordering to sort by: SortCriteria.Ordering.ASCENDING or SortCriteria.Ordering.DESCENDING.

SortCriteria

public SortCriteria(String sortBy,
            SortCriteria.Ordering ordering,
            boolean nullsFirst)

Creates a new instance of this SortCriteria class.

Parameters:

sortBy - the property to sort by, this can be nested (i.e. person.name.firstName will be sorted).

ordering - the ordering to sort by: SortCriteria.Ordering.ASCENDING or SortCriteria.Ordering.DESCENDING.

nullsFirst - whether or not nulls will be placed first or last when sorting occurs.

Method Detail

getOrdering

public SortCriteria.Ordering getOrdering()

Gets the current ordering to be used.

Returns:

Ordering

setOrdering

public void setOrdering(SortCriteria.Ordering ordering)

Sets the ordering to use for sorting.

Parameters:

ordering - the ordering.

getSortBy

public String getSortBy()

Gets the sort by name.

Returns:

String

setSortBy

public void setSortBy(String sortBy)

Sets the name of the property by which to sort.

Parameters:

sortBy - the name of the property by which to sort.

isNullsFirst

public boolean isNullsFirst()

Returns:

the nullsFirst

setNullsFirst

public void setNullsFirst(boolean nullsFirst)

Parameters:

nullsFirst - the nullsFirst to set