org.compass.annotations
Enum FilterDuplicates

java.lang.Object
  extended by java.lang.Enum<FilterDuplicates>
      extended by org.compass.annotations.FilterDuplicates
All Implemented Interfaces:
Serializable, Comparable<FilterDuplicates>

public enum FilterDuplicates
extends Enum<FilterDuplicates>

Controls if the Searchable class should filter duplciates. Duplciates are objects that have already been marshalled during the marshalling process of a single root object (and its object graph). Filtering them out means reducing the size of the index (content, of course, is still searchable), though object graph queries and possible "boost" information by having it several times is lost.

By default, controlled by global setting CompassEnvironment.Osem.FILTER_DUPLICATES which defaults to false.

Author:
kimchy

Enum Constant Summary
FALSE
          The searchable class will not filter duplicates.
NA
          Defaults to Compass global osem setting CompassEnvironment.Osem.FILTER_DUPLICATES.
TRUE
          The searchable class will filter duplciates.
 
Method Summary
static FilterDuplicates valueOf(String name)
          Returns the enum constant of this type with the specified name.
static FilterDuplicates[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

NA

public static final FilterDuplicates NA
Defaults to Compass global osem setting CompassEnvironment.Osem.FILTER_DUPLICATES.


TRUE

public static final FilterDuplicates TRUE
The searchable class will filter duplciates. Will override anything set in Compass global osem setting filterDuplicates.


FALSE

public static final FilterDuplicates FALSE
The searchable class will not filter duplicates. Will override anything set in Compass global osem setting filterDuplicates.

Method Detail

values

public static final FilterDuplicates[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(FilterDuplicates c : FilterDuplicates.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

public static FilterDuplicates valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name


Copyright (c) 2004-2009 The Compass Project.