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

Object
  extended by FilterOperation
All Implemented Interfaces:
Serializable

public class FilterOperation
extends Object
implements Serializable

A filter operation is an abstract representation of an operation that can be performed when filtering a data set. The operations that can be performed are not provided here; rather subclasses and external utilities can create FilterOperation instances that map to concrete operations for query languages like XQuery or SQL. The process for performing this mapping is left to filtering utilities.

See Also:
Serialized Form

Constructor Summary
FilterOperation(int id, String abbreviation, String resourceKey, FilterOperationHint operationHint)
          Construct a FilterOperation given a set of metadata about the filter.
 
Method Summary
 String getAbbreviation()
          Get the filter operation's abbreviation
 int getId()
          Get the filter operation's id.
 FilterOperationHint getOperationHint()
          Get the filter operation's FilterOperationHint.
 String getResourceKey()
          Get the filter operation's resource key.
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FilterOperation

public FilterOperation(int id,
                       String abbreviation,
                       String resourceKey,
                       FilterOperationHint operationHint)
Construct a FilterOperation given a set of metadata about the filter.

Parameters:
id - the operation identifier
abbreviation - the abbreviation for the filter
resourceKey - a resource key used to lookup a readable String for a filter operation
operationHint - a hint for the operation that classifies the operation into a language independent operation category.
Method Detail

getId

public int getId()
Get the filter operation's id.

Returns:
the id

getAbbreviation

public String getAbbreviation()
Get the filter operation's abbreviation

Returns:
the abbreviation

getResourceKey

public String getResourceKey()
Get the filter operation's resource key. Discoverying the readable text for an operation is left to the client or other filtering utilities.

Returns:
the resource key

getOperationHint

public FilterOperationHint getOperationHint()
Get the filter operation's FilterOperationHint.

Returns:
the operation hint