com.arsdigita.search
Class FilterType

java.lang.Object
  extended bycom.arsdigita.search.FilterType
Direct Known Subclasses:
CategoryFilterType, ObjectTypeFilterType, PermissionFilterType

public abstract class FilterType
extends Object

A filter type defines a condition on which a set of result documents can be restricted. An example would be 'restrict by category'.

See Also:
FilterSpecification

Constructor Summary
protected FilterType(String key, String description)
          Creates a new filter type
 
Method Summary
 boolean equals(Object o)
          Two filter type objects compare equal if they have the same filter key
 String getDescription()
          Gets the filter description
 String getKey()
          Gets the unique filter key
 int hashCode()
          Returns a hashcode compatible with the definition of the equals() method
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FilterType

protected FilterType(String key,
                     String description)
Creates a new filter type

Parameters:
key - a unique key representing this filter type
description - a human friendly description
Method Detail

getKey

public String getKey()
Gets the unique filter key

Returns:
the filter key

getDescription

public String getDescription()
Gets the filter description

Returns:
the filter description

equals

public boolean equals(Object o)
Two filter type objects compare equal if they have the same filter key


hashCode

public int hashCode()
Returns a hashcode compatible with the definition of the equals() method



Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 21 2004:2337 UTC