org.jcreme.filters
Class OrderComparisonOperator

java.lang.Object
  org.jcreme.enumerations.Enumeration
      org.jcreme.filters.ComparisonOperator
          org.jcreme.filters.OrderComparisonOperator

All Implemented Interfaces:

java.lang.Comparable, java.io.Serializable

public class OrderComparisonOperator

extends ComparisonOperator

This enumeration contains the operators that can be used in a sort context to test the order of two values. As a subclass of the ComparisonOperator enumeration, values of this class are also registered as elements of the ComparisonOperator enumeration.

Version:

$Revision: 1.3 $

Author:

$Author: dbregeon $

See Also:

Serialized Form

Field Summary

static OrderComparisonOperator	EQUAL The '=' enumeration value.
static OrderComparisonOperator	GREATER_THAN The '>' enumeration value.
static OrderComparisonOperator	GREATER_THAN_EQUAL The '>=' enumeration value.
static OrderComparisonOperator	LESSER_THAN The ' <' enumeration value.
static OrderComparisonOperator	LESSER_THAN_EQUAL The ' <=' enumeration value.
static OrderComparisonOperator	NOT_EQUAL The '!
static java.lang.String	S_EQUAL The name for the '=' enumeration value.
static java.lang.String	S_GREATER_THAN The name for the '>' enumeration value.
static java.lang.String	S_GREATER_THAN_EQUAL The name for the '>=' enumeration value.
static java.lang.String	S_LESSER_THAN The name for the ' <' enumeration value.
static java.lang.String	S_LESSER_THAN_EQUAL The name for the ' <=' enumeration value.
static java.lang.String	S_NOT_EQUAL The name for the '!
(package private) static long	serialVersionUID

Constructor Summary

protected

OrderComparisonOperator(java.lang.String name) Creates new OrderComparisonOperator

Method Summary

protected java.util.Hashtable	getFromName() This method is for internal use only.
static OrderComparisonOperator	getOrderComparisonOperator(java.lang.String name) This method retrieves an OrderComparisonOperator instance from its name.
static OrderComparisonOperator[]	getOrderComparisonOperators() This methods gives the instances of this class.
static Enumeration[]	getValues() This method enables to retrieve all the possible values of an Enumeration class.

Methods inherited from class org.jcreme.filters.ComparisonOperator

addAsComparisonOperator, get, getComparisonOperators

Methods inherited from class org.jcreme.enumerations.Enumeration

compareTo, getName, readResolve, toString

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

S_LESSER_THAN

public static final java.lang.String S_LESSER_THAN

The name for the ' <' enumeration value.

See Also:

Constant Field Values

LESSER_THAN

public static final OrderComparisonOperator LESSER_THAN

The ' <' enumeration value.

S_LESSER_THAN_EQUAL

public static final java.lang.String S_LESSER_THAN_EQUAL

The name for the ' <=' enumeration value.

See Also:

Constant Field Values

LESSER_THAN_EQUAL

public static final OrderComparisonOperator LESSER_THAN_EQUAL

The ' <=' enumeration value.

S_EQUAL

public static final java.lang.String S_EQUAL

The name for the '=' enumeration value.

See Also:

Constant Field Values

EQUAL

public static final OrderComparisonOperator EQUAL

The '=' enumeration value.

S_NOT_EQUAL

public static final java.lang.String S_NOT_EQUAL

The name for the '!=' enumeration value.

See Also:

Constant Field Values

NOT_EQUAL

public static final OrderComparisonOperator NOT_EQUAL

The '!=' enumeration value.

S_GREATER_THAN_EQUAL

public static final java.lang.String S_GREATER_THAN_EQUAL

The name for the '>=' enumeration value.

See Also:

Constant Field Values

GREATER_THAN_EQUAL

public static final OrderComparisonOperator GREATER_THAN_EQUAL

The '>=' enumeration value.

S_GREATER_THAN

public static final java.lang.String S_GREATER_THAN

The name for the '>' enumeration value.

See Also:

Constant Field Values

GREATER_THAN

public static final OrderComparisonOperator GREATER_THAN

The '>' enumeration value.

Constructor Detail

OrderComparisonOperator

protected OrderComparisonOperator(java.lang.String name)
                           throws java.security.InvalidParameterException

Creates new OrderComparisonOperator

Parameters:

name - the name of this enumerated value. It cannot be null.

Throws:

java.security.InvalidParameterException - if the parameter is null.

Method Detail

getFromName

protected java.util.Hashtable getFromName()

This method is for internal use only.

Overrides:

getFromName in class ComparisonOperator

Returns:

the Hashtable that links the enumerated values names with the actual enumerated value.

getOrderComparisonOperator

public static OrderComparisonOperator getOrderComparisonOperator(java.lang.String name)

This method retrieves an OrderComparisonOperator instance from its name.

Parameters:

name - the name of the OrderComparisonOperator instance.

Returns:

the OrderComparisonOperator that has this name. Null if no value corresponding to this name was found.

getOrderComparisonOperators

public static OrderComparisonOperator[] getOrderComparisonOperators()

This methods gives the instances of this class.

Returns:

all the instances of this class.

getValues

public static Enumeration[] getValues()

This method enables to retrieve all the possible values of an Enumeration class.

Returns:

the values for this class.