org.apache.lucene.analysis.ngram
Enum EdgeNGramTokenFilter.Side

java.lang.Object
  extended by java.lang.Enum<EdgeNGramTokenFilter.Side>
      extended by org.apache.lucene.analysis.ngram.EdgeNGramTokenFilter.Side
All Implemented Interfaces:
Serializable, Comparable<EdgeNGramTokenFilter.Side>
Enclosing class:
EdgeNGramTokenFilter

public static enum EdgeNGramTokenFilter.Side
extends Enum<EdgeNGramTokenFilter.Side>

Specifies which side of the input the n-gram should be generated from


Enum Constant Summary
BACK
          Get the n-gram from the end of the input
FRONT
          Get the n-gram from the front of the input
 
Method Summary
abstract  String getLabel()
           
static EdgeNGramTokenFilter.Side getSide(String sideName)
           
static EdgeNGramTokenFilter.Side valueOf(String name)
          Returns the enum constant of this type with the specified name.
static EdgeNGramTokenFilter.Side[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

FRONT

public static final EdgeNGramTokenFilter.Side FRONT
Get the n-gram from the front of the input


BACK

public static final EdgeNGramTokenFilter.Side BACK
Get the n-gram from the end of the input

Method Detail

values

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

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

valueOf

public static EdgeNGramTokenFilter.Side 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
NullPointerException - if the argument is null

getLabel

public abstract String getLabel()

getSide

public static EdgeNGramTokenFilter.Side getSide(String sideName)


Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.