com.arsdigita.search.filters
Class ObjectTypeFilterSpecification

java.lang.Object
  extended bycom.arsdigita.search.FilterSpecification
      extended bycom.arsdigita.search.filters.ObjectTypeFilterSpecification

public class ObjectTypeFilterSpecification
extends FilterSpecification

A filter spec for supplying a list of object types to the object type filter type. There are two flags can alter the semantics of the filter. The first specifies whether the list of an inclusion (white) or exclusion (black) list.


Field Summary
static String EXCLUSION
           
static String TYPES
           
 
Constructor Summary
ObjectTypeFilterSpecification(ObjectType type)
          Creates a new filter restricting results to a single object type.
ObjectTypeFilterSpecification(ObjectType[] types)
          Creates a new filter restricting results to a set object type.
ObjectTypeFilterSpecification(String typeName)
          Creates a new filter restricting results to a single object type.
ObjectTypeFilterSpecification(String[] typeNames)
          Creates a new filter restricting results to a set object types.
 
Method Summary
 ObjectType[] getTypes()
          Returns the set of object types to filter on
 boolean isExclusion()
          Gets the flag indicating that the type list is an exclusion list rather than an inclusion list.
 void setExclusion(boolean exclude)
          Sets the flag indicating that the type list is an exclusion list rather than an inclusion list.
 
Methods inherited from class com.arsdigita.search.FilterSpecification
equals, get, getType, hashCode, set
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TYPES

public static final String TYPES
See Also:
Constant Field Values

EXCLUSION

public static final String EXCLUSION
See Also:
Constant Field Values
Constructor Detail

ObjectTypeFilterSpecification

public ObjectTypeFilterSpecification(String typeName)
Creates a new filter restricting results to a single object type.

Parameters:
typeName - the object type name

ObjectTypeFilterSpecification

public ObjectTypeFilterSpecification(String[] typeNames)
Creates a new filter restricting results to a set object types.


ObjectTypeFilterSpecification

public ObjectTypeFilterSpecification(ObjectType type)
Creates a new filter restricting results to a single object type.

Parameters:
type - the object type

ObjectTypeFilterSpecification

public ObjectTypeFilterSpecification(ObjectType[] types)
Creates a new filter restricting results to a set object type.

Method Detail

getTypes

public ObjectType[] getTypes()
Returns the set of object types to filter on

Returns:
the object type

setExclusion

public void setExclusion(boolean exclude)
Sets the flag indicating that the type list is an exclusion list rather than an inclusion list. Default is an inclusion list.

Parameters:
exclude - true to mark as an exclusion list

isExclusion

public boolean isExclusion()
Gets the flag indicating that the type list is an exclusion list rather than an inclusion list.

Returns:
true if marked as an exclusion list


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