org.apache.beehive.netui.databinding.datagrid.api.filter
Class FilterOperationHint

Object
  extended by FilterOperationHint
All Implemented Interfaces:
Serializable

public class FilterOperationHint
extends Object
implements Serializable

This class provides a hint for the operation performed by a Filter instance. The filter operations supported for a specific query language are not encoded in the FilterOperation class and are provided on an per-instance basis. The hint provides a way of representing a generic type of operation. The operations here are common across query languages and are not meant to be an exhaustive list.

Setting a FilterOperationHint on a Filter object, allows query infrastructure to generically interact with Filter instances regardless of the type of query mechanism.

See Also:
Serialized Form

Field Summary
static FilterOperationHint CONTAINS
          Operation representing 'contains'.
static FilterOperationHint EQUAL
          Operation representing equal.
static FilterOperationHint GREATER_THAN
          Operation representing greater than.
static FilterOperationHint GREATER_THAN_OR_EQUAL
          Operation representing greater than or equal.
static int INT_CONTAINS
          Int value representing contains.
static int INT_EQUAL
          Int value representing equal.
static int INT_GREATER_THAN
          Int value representing greater than.
static int INT_GREATER_THAN_OR_EQUAL
          Int value representing greater than or equal.
static int INT_IS_EMPTY
          Int value representing is empty.
static int INT_IS_NOT_EMPTY
          Int value representing is not empty.
static int INT_IS_ONE_OF
          Int value representing is one of.
static int INT_LESS_THAN
          Int value representing less than.
static int INT_LESS_THAN_OR_EQUAL
          Int value representing less than or equal.
static int INT_NONE
          Int value representing no operation.
static int INT_NOT_EQUAL
          Int value representing not equal.
static int INT_STARTS_WITH
          Int value representing starts with.
static FilterOperationHint IS_EMPTY
          Operation representing 'is empty'.
static FilterOperationHint IS_NOT_EMPTY
          Operation representing 'is not empty'.
static FilterOperationHint IS_ONE_OF
          Operation representing is one of.
static FilterOperationHint LESS_THAN
          Operation representing less than.
static FilterOperationHint LESS_THAN_OR_EQUAL
          Operation representing less than or equal.
static FilterOperationHint NONE
          Operation representing no filter.
static FilterOperationHint NOT_EQUAL
          Operation representing not equal.
static FilterOperationHint STARTS_WITH
          Operation representing starts with.
 
Method Summary
 boolean equals(Object value)
          Equals method.
 int getValue()
          The hint's int value.
 int hashCode()
          Hash code.
 String toString()
          Convert this filter operation hint to a readable String.
 
Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

INT_NONE

public static final int INT_NONE
Int value representing no operation.

See Also:
Constant Field Values

INT_EQUAL

public static final int INT_EQUAL
Int value representing equal.

See Also:
Constant Field Values

INT_NOT_EQUAL

public static final int INT_NOT_EQUAL
Int value representing not equal.

See Also:
Constant Field Values

INT_GREATER_THAN

public static final int INT_GREATER_THAN
Int value representing greater than.

See Also:
Constant Field Values

INT_LESS_THAN

public static final int INT_LESS_THAN
Int value representing less than.

See Also:
Constant Field Values

INT_GREATER_THAN_OR_EQUAL

public static final int INT_GREATER_THAN_OR_EQUAL
Int value representing greater than or equal.

See Also:
Constant Field Values

INT_LESS_THAN_OR_EQUAL

public static final int INT_LESS_THAN_OR_EQUAL
Int value representing less than or equal.

See Also:
Constant Field Values

INT_IS_ONE_OF

public static final int INT_IS_ONE_OF
Int value representing is one of.

See Also:
Constant Field Values

INT_STARTS_WITH

public static final int INT_STARTS_WITH
Int value representing starts with.

See Also:
Constant Field Values

INT_CONTAINS

public static final int INT_CONTAINS
Int value representing contains.

See Also:
Constant Field Values

INT_IS_EMPTY

public static final int INT_IS_EMPTY
Int value representing is empty.

See Also:
Constant Field Values

INT_IS_NOT_EMPTY

public static final int INT_IS_NOT_EMPTY
Int value representing is not empty.

See Also:
Constant Field Values

NONE

public static final FilterOperationHint NONE
Operation representing no filter.


EQUAL

public static final FilterOperationHint EQUAL
Operation representing equal.


NOT_EQUAL

public static final FilterOperationHint NOT_EQUAL
Operation representing not equal.


GREATER_THAN

public static final FilterOperationHint GREATER_THAN
Operation representing greater than.


LESS_THAN

public static final FilterOperationHint LESS_THAN
Operation representing less than.


GREATER_THAN_OR_EQUAL

public static final FilterOperationHint GREATER_THAN_OR_EQUAL
Operation representing greater than or equal.


LESS_THAN_OR_EQUAL

public static final FilterOperationHint LESS_THAN_OR_EQUAL
Operation representing less than or equal.


IS_ONE_OF

public static final FilterOperationHint IS_ONE_OF
Operation representing is one of. The implementations of an 'is one of' operation is left to the interpreter of a Filter instance.


STARTS_WITH

public static final FilterOperationHint STARTS_WITH
Operation representing starts with.


CONTAINS

public static final FilterOperationHint CONTAINS
Operation representing 'contains'. The implementation of a contains operation is left to the interpreter of a Filter instance.


IS_EMPTY

public static final FilterOperationHint IS_EMPTY
Operation representing 'is empty'.


IS_NOT_EMPTY

public static final FilterOperationHint IS_NOT_EMPTY
Operation representing 'is not empty'.

Method Detail

toString

public final String toString()
Convert this filter operation hint to a readable String. Note, this does not return the operator -- only text for the operation hint itself.

Overrides:
toString in class Object
Returns:
the readable operation name

equals

public boolean equals(Object value)
Equals method.

Overrides:
equals in class Object
Parameters:
value - value to check
Returns:
true if this hint matches the value. false otherwise.

hashCode

public int hashCode()
Hash code.

Overrides:
hashCode in class Object
Returns:
the hash code

getValue

public int getValue()
The hint's int value.

Returns:
the hint's value