atg.search.routing.command.search

Class ExpansionType

java.lang.Object

atg.core.util.Enum

atg.search.routing.command.search.ExpansionType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

public class ExpansionType
extends Enum

Enumeration for types of query term expansions

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExpansionType.ExpansionTypeEditor

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

Enum.EnumEditor, Enum.LocaleEnumEditor

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
static ExpansionType	EQUAL
static ExpansionType	IDENTITY
static ExpansionType	MEDIUM
static ExpansionType	STRONG
static ExpansionType	UNKNOWN
static ExpansionType	WEAK

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ExpansionType(java.lang.String enumName, int ordinalVal) The subclass constructor should be private.

Method Summary

Modifier and Type	Method and Description
static ExpansionType	valueOf(java.lang.String pName)

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

IDENTITY

public static final ExpansionType IDENTITY

EQUAL

public static final ExpansionType EQUAL

STRONG

public static final ExpansionType STRONG

MEDIUM

public static final ExpansionType MEDIUM

WEAK

public static final ExpansionType WEAK

UNKNOWN

public static final ExpansionType UNKNOWN

Constructor Detail

ExpansionType

protected ExpansionType(java.lang.String enumName,
                        int ordinalVal)

The subclass constructor should be private.

The ordinal value is used to compare (done when sorting, for example) two Enum objects and to order the objects in iterators and PropertyEditors. No two instances of a subclass should have the same ordinal value or name. To safely add new Enum subclass instances and preserve previous orderings in containers the best thing to do is to always use a new ordinal value when creating a new instance rather than changing old instance's ordinal value.

If an enum subclass instance is ever removed, there should be a comment in the file that reserves the old ordinal value so that any old serialized files don't accidentally map an old enum to a new enum.

Parameters:

enumName - The name of the instance that will appear in editors and toString().

ordinalVal - The ordinal value

Throws:

java.lang.Error - if the subclass already has an instance name n or if the ordinal number is already used by another instance of the same subclass.

Method Detail

valueOf

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