org.compass.core
Enum CompassQuery.SortImplicitType

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

public static enum CompassQuery.SortImplicitType
extends Enum<CompassQuery.SortImplicitType>

Implicit types that the hits can be sorted by.

Author:
kimchy

Enum Constant Summary
DOC
          Sort by document number (index order).
SCORE
          Sort by resource score (relevancy).
 
Method Summary
static CompassQuery.SortImplicitType valueOf(String name)
          Returns the enum constant of this type with the specified name.
static CompassQuery.SortImplicitType[] 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

SCORE

public static final CompassQuery.SortImplicitType SCORE
Sort by resource score (relevancy). Sort values are Float and higher values are at the front.


DOC

public static final CompassQuery.SortImplicitType DOC
Sort by document number (index order). Sort values are Integer and lower values are at the front. Note, that if an updated occurs, the document number will be higher.

Method Detail

values

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

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

valueOf

public static CompassQuery.SortImplicitType 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.