atg.search.routing.command.search
Class StructuredStatement.Mode

java.lang.Object
  extended by atg.core.util.Enum
      extended by atg.search.routing.command.search.StructuredStatement.Mode
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable
Enclosing class:
StructuredStatement

public static class StructuredStatement.Mode
extends Enum

ATG Search handles natural language and Boolean queries. Simple Boolean syntax is handled automatically as part of the natural language processing, but complex Boolean expressions require a special mode of processing. Furthermore, ATG Search can support simple keyword search behavior in several additional modes. These modes are controlled by this attribute.

The value can be nlp, for natural language and simple Boolean queries. This is the default value. The value can also be boolean, for parsing of complex Boolean expressions.

The value can also be keyword, which handles natural language queries in a simplistic keyword search model. Essentially, ATG Search parses the query as normal, but each query term is double-quoted and required to appear in the index items of the results.

The value can also be and, which handles natural language queries in an expanded keyword search model. Essentially, ATG Search parses the query as normal, but each query term is required to appear in the index items of the results. This is similar to the keyword mode, but without the double-quotes, which means the query terms could match morphological variants and use term expansions.

The value can also be matchall, which handles natural language queries as a Boolean AND of terms, as opposed to ATG Search's default Boolean OR. Essentially, ATG Search parses the query as normal, but each query term is required to appear in the result statements. See SearchPropertyEditors.

See Also:
Serialized Form

Nested Class Summary
static class StructuredStatement.Mode.ModeEditor
           
 
Nested classes/interfaces inherited from class atg.core.util.Enum
Enum.EnumEditor, Enum.LocaleEnumEditor
 
Field Summary
static StructuredStatement.Mode ALL
           
static StructuredStatement.Mode AND
           
static StructuredStatement.Mode BOOLEAN
          Deprecated. as of 9.0. Use BOOLEAN_STMT.
static StructuredStatement.Mode BOOLEAN_DOC
           
static StructuredStatement.Mode BOOLEAN_STMT
           
static java.lang.String CLASS_VERSION
          Class version string
static StructuredStatement.Mode KEYWORD
           
static StructuredStatement.Mode NLP
           
 
Method Summary
static StructuredStatement.Mode 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 final java.lang.String CLASS_VERSION
Class version string

See Also:
Constant Field Values

NLP

public static final StructuredStatement.Mode NLP

BOOLEAN

public static final StructuredStatement.Mode BOOLEAN
Deprecated. as of 9.0. Use BOOLEAN_STMT.

KEYWORD

public static final StructuredStatement.Mode KEYWORD

AND

public static final StructuredStatement.Mode AND

ALL

public static final StructuredStatement.Mode ALL

BOOLEAN_STMT

public static final StructuredStatement.Mode BOOLEAN_STMT

BOOLEAN_DOC

public static final StructuredStatement.Mode BOOLEAN_DOC
Method Detail

valueOf

public static StructuredStatement.Mode valueOf(java.lang.String pName)