net.sf.flatpack.ordering

Class OrderColumn

java.lang.Object

net.sf.flatpack.ordering.OrderColumn

public class OrderColumn
extends Object

Version:

2.0

Author:

paul zepernick Used in conjunction with the OrderBy class. Holds the name of the column to order by and the direction the order should go, ASC, DESC.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	ASC Specifies Ascending sort order
static int	COLTYPE_DATE date sort indicator
static int	COLTYPE_NUMERIC numeric sort indicator
static int	COLTYPE_STRING string sort indicator
static boolean	DESC Specifies descending sort order

Constructor Summary

Constructors

Constructor and Description
OrderColumn(String columnName, boolean desc) Constructs a new order by element
OrderColumn(String columnName, boolean desc, int colType) Constructs a new order by element

Method Summary

Modifier and Type	Method and Description
String	getColumnName()
String	getDateFormatPattern() Format pattern to use to parse dates for sorting.
int	getSelectedColType()
int	getSortIndicator()
void	setColumnName(String columnName)
void	setDateFormatPattern(String dateFormatPattern) Format pattern to use to parse dates for sorting.
void	setSelectedColType(int selectedColType)

Methods inherited from class java.lang.Object

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

Field Detail

DESC

public static final boolean DESC

Specifies descending sort order

See Also:

Constant Field Values

ASC

public static final boolean ASC

Specifies Ascending sort order

See Also:

Constant Field Values

COLTYPE_STRING

public static final int COLTYPE_STRING

string sort indicator

See Also:

Constant Field Values

COLTYPE_DATE

public static final int COLTYPE_DATE

date sort indicator

See Also:

Constant Field Values

COLTYPE_NUMERIC

public static final int COLTYPE_NUMERIC

numeric sort indicator

See Also:

Constant Field Values

Constructor Detail

OrderColumn

public OrderColumn(String columnName,
                   boolean desc,
                   int colType)

Constructs a new order by element

Parameters:

columnName - column to sort by

desc - boolean sort DESC. OrderColumn.DESC, OrderColumn.ASC

colType - Type of column to be sorted: OrderColumn.COLTYPE_STRING,OrderColumn.COLTYPE_DATE, OrderColum.COLTYPE_NUMERIC

OrderColumn

public OrderColumn(String columnName,
                   boolean desc)

Constructs a new order by element

Parameters:

columnName - column to sort by

desc - boolean sort DESC. OrderColumn.DESC, OrderColumn.ASC

Method Detail

getColumnName

public String getColumnName()

Returns:

Returns the propertyName.

setColumnName

public void setColumnName(String columnName)

Parameters:

columnName - The columnName to set.

getSortIndicator

public int getSortIndicator()

Returns:

Returns the sortIndicator.

getSelectedColType

public int getSelectedColType()

Returns:

the selectedColType

setSelectedColType

public void setSelectedColType(int selectedColType)

Parameters:

selectedColType - the selectedColType to set

getDateFormatPattern

public String getDateFormatPattern()

Format pattern to use to parse dates for sorting. Default is yyyyMMdd

Returns:

the dateFormatPattern

setDateFormatPattern

public void setDateFormatPattern(String dateFormatPattern)

Format pattern to use to parse dates for sorting. Default is yyyyMMdd

Parameters:

dateFormatPattern - the dateFormatPattern to set

See Also:

SimpleDateFormat