org.compass.core
Enum CompassHighlighter.TextTokenizer

java.lang.Object
  extended by java.lang.Enum<CompassHighlighter.TextTokenizer>
      extended by org.compass.core.CompassHighlighter.TextTokenizer
All Implemented Interfaces:
Serializable, Comparable<CompassHighlighter.TextTokenizer>
Enclosing interface:
CompassHighlighter

public static enum CompassHighlighter.TextTokenizer
extends Enum<CompassHighlighter.TextTokenizer>

Controls the way text will be tokenized in order to perform the highlight operation.

Author:
kimchy

Enum Constant Summary
ANALYZER
          Forces tokenization of the text using the analyzer.
AUTO
          Will use term vector if available to tokenize the text, otherwise will use analyzer.
TERM_VECTOR
          Forces tokenization of the text using the tem vector information.
 
Method Summary
static CompassHighlighter.TextTokenizer fromString(String textTokenizer)
           
static String toString(CompassHighlighter.TextTokenizer textTokenizer)
           
static CompassHighlighter.TextTokenizer valueOf(String name)
          Returns the enum constant of this type with the specified name.
static CompassHighlighter.TextTokenizer[] 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

ANALYZER

public static final CompassHighlighter.TextTokenizer ANALYZER
Forces tokenization of the text using the analyzer.


TERM_VECTOR

public static final CompassHighlighter.TextTokenizer TERM_VECTOR
Forces tokenization of the text using the tem vector information.


AUTO

public static final CompassHighlighter.TextTokenizer AUTO
Will use term vector if available to tokenize the text, otherwise will use analyzer.

Method Detail

values

public static final CompassHighlighter.TextTokenizer[] 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(CompassHighlighter.TextTokenizer c : CompassHighlighter.TextTokenizer.values())
        System.out.println(c);

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

valueOf

public static CompassHighlighter.TextTokenizer 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

toString

public static String toString(CompassHighlighter.TextTokenizer textTokenizer)

fromString

public static CompassHighlighter.TextTokenizer fromString(String textTokenizer)


Copyright (c) 2004-2009 The Compass Project.