atg.search.routing.command.search
Class TermLookupOp

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

public class TermLookupOp
extends Enum

Boolean operator of a lookup term

See Also:

Serialized Form

Nested Class Summary

static class

TermLookupOp.TermOpEditor

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

Enum.EnumEditor, Enum.LocaleEnumEditor

Field Summary

static java.lang.String	CLASS_VERSION Class version string
static TermLookupOp	DOC_NEGATIVE
static TermLookupOp	DOC_REQ_DISJ
static TermLookupOp	DOC_REQUIRED
static TermLookupOp	NEGATIVE
static TermLookupOp	NONE
static TermLookupOp	REQUIRED

Constructor Summary

protected

TermLookupOp(java.lang.String enumName, int ordinalVal) The subclass constructor should be private.

Method Summary

static TermLookupOp

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

REQUIRED

public static final TermLookupOp REQUIRED

NEGATIVE

public static final TermLookupOp NEGATIVE

DOC_REQ_DISJ

public static final TermLookupOp DOC_REQ_DISJ

DOC_REQUIRED

public static final TermLookupOp DOC_REQUIRED

DOC_NEGATIVE

public static final TermLookupOp DOC_NEGATIVE

NONE

public static final TermLookupOp NONE

Constructor Detail

TermLookupOp

protected TermLookupOp(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 TermLookupOp valueOf(java.lang.String pName)