atg.search.routing.command.search
Class TypeAheadSortType

java.lang.Object
  atg.core.util.Enum
      atg.search.routing.command.search.TypeAheadSortType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

public class TypeAheadSortType
extends Enum

An Enum class for the sort order types for the TypeAheadRequest class

See Also:

Serialized Form

Nested Class Summary

static class

TypeAheadSortType.TypeAheadSortTypeEditor

Nested classes/interfaces inherited from class atg.core.util.Enum

Enum.EnumEditor, Enum.LocaleEnumEditor

Field Summary

static TypeAheadSortType	ALPHA ALPHA - Sort the matching string values alphabetically
static java.lang.String	CLASS_VERSION Class version string
static TypeAheadSortType	LENGTH LENGTH - Sort by the length of the matching string values
static TypeAheadSortType	MATCH MATCH - Sort by the engine's heuristic metric, which favors initial substrings on shorter strings with higher value
static TypeAheadSortType	VALUE VALUE -- Sort by the stored value (the value data in the index, loaded with the type ahead data

Method Summary

static TypeAheadSortType

valueOf(java.lang.String pName) Convert a string value to correponding enum value

Methods inherited from class atg.core.util.Enum

compareTo, getEnumClassInfo, getOrdinal, iterator, iterator, lookup, lookup, lookup, lookup, readResolve, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

VALUE

public static final TypeAheadSortType VALUE

VALUE -- Sort by the stored value (the value data in the index, loaded with the type ahead data

ALPHA

public static final TypeAheadSortType ALPHA

ALPHA - Sort the matching string values alphabetically

LENGTH

public static final TypeAheadSortType LENGTH

LENGTH - Sort by the length of the matching string values

MATCH

public static final TypeAheadSortType MATCH

MATCH - Sort by the engine's heuristic metric, which favors initial substrings on shorter strings with higher value

Method Detail

valueOf

public static TypeAheadSortType valueOf(java.lang.String pName)

Convert a string value to correponding enum value

Parameters:

pName - the string to convert

Returns:

the assoicated TypeAheadSortType value