org.compass.core
Enum CompassTermFreqsBuilder.Sort

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

public static enum CompassTermFreqsBuilder.Sort
extends Enum<CompassTermFreqsBuilder.Sort>


Enum Constant Summary
FREQ
          Sort the terms based on their frequency (the default)
TERM
          Sort the terms based on their name
 
Method Summary
static CompassTermFreqsBuilder.Sort valueOf(String name)
          Returns the enum constant of this type with the specified name.
static CompassTermFreqsBuilder.Sort[] 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

TERM

public static final CompassTermFreqsBuilder.Sort TERM
Sort the terms based on their name


FREQ

public static final CompassTermFreqsBuilder.Sort FREQ
Sort the terms based on their frequency (the default)

Method Detail

values

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

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

valueOf

public static CompassTermFreqsBuilder.Sort 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.