atg.search.routing.command.search
Class ParserOptions

java.lang.Object
  atg.search.routing.command.SearchXMLObject
      atg.search.routing.command.SearchEngineRequestImpl
          atg.search.routing.command.indexing.IndexingRequest
              atg.search.routing.command.indexing.IndexingRequestFragment
                  atg.search.routing.command.indexing.OptionsBase
                      atg.search.routing.command.search.ParserOptions

All Implemented Interfaces:

atg.search.routing.command.SearchEngineRequest, java.io.Serializable

public class ParserOptions
extends OptionsBase

Text processing options for requests.

Optional: All

Required: None Call the backdoor method setXml(String) if you already have well-formed xml and want to override settings; or you can call the static valueOf(String).

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class atg.search.routing.command.indexing.OptionsBase

OptionsBase.ExpandedStemmingType, OptionsBase.ExpandedStemmingTypeEditor, OptionsBase.Index, OptionsBase.IndexScheme, OptionsBase.IndexSchemeEditor, OptionsBase.IndexTypeEditor, OptionsBase.SpellChecker, OptionsBase.SpellCheckerEditor, OptionsBase.SpellSplitWords

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Fields inherited from class atg.search.routing.command.indexing.OptionsBase

CONTEXT, DELETE, DOC_NORM_MIN, EXPANDED_STEMMING, FEATURE_SENTENCE_TERMS, FEATURE_TERMS, FEATURE_ZONES, IGNORE_STATEMENT, IGNORE_ZONE, INDEX, INDEX_CONTENT_MAX, INDEX_IMAGE_FILE, INDEX_ITEM_URLS, INDEX_SCHEME, INDEX_STOP_THRESH, INDEX_TERM_MAX, INDEX_TERM_THRESH, LANGUAGE, METATAG, METATAG_DELIM, METATAG_ENUM_PROP, METATAG_EXCLUDE, METATAG_FLOAT_PROP, METATAG_INDEX, METATAG_INFO_PROP, METATAG_NORM, METATAG_NUMBER_PROP, METATAG_PROP_WEIGHT, METATAG_SEARCHABLE, METATAG_STRING_PROP, METATAG_SUMMARY, METATAG_TERM_PROP, METATAG_TEXT_PROP, PACKAGE_DISABLE, PROCESS_LEVEL, PROPERTY_MAPPING, QUERY_RULE_DISABLE, QUERY_RULE_ENABLE, RANK_DOC_PROP, RULE_ENABLE, SECURITY_ROLE, SENTENCE_MAX_SIZE, SENTENCE_MIN_SIZE, SPELL_CHECKER, SPELL_MAX_SUGGESTIONS, SPELL_SPLIT_WORDS, SPELL_SUGGESTION_CUTOFF, SPELL_SUGGESTION_FACTOR, STORE_SOURCE, TABLE_CELL, TABLE_STRUCTURE, TARGET_LANGUAGE, TARGET_LANGUAGE_EXPANSION, TOPIC_CONFIDENCE, TOPIC_DISABLE, TOPIC_ENABLE, TOPIC_INHERITANCE, TOPIC_MAXIMUM, TOPIC_PROP_ONLY, TOPIC_RELEVANCE, WILDCARD_CHAR, WILDCARD_MAX

Constructor Summary

ParserOptions()

ParserOptions(java.lang.String pXml)
Constructor that creates and initializes the instance from specified XML.

Method Summary

boolean	equals(java.lang.Object pObject) compares this with another by an XML comparison.
protected static ParserOptions	fromXmlParser(atg.search.routing.utils.SearchMessageNode xml) creates a new ParserOptions from the xml parser
protected void	getBodyXML(java.lang.StringBuilder cmd)
atg.search.routing.command.indexing.RequestTagType	getRequestEnum()
java.lang.String	getXml() Getter for the xml.
int	hashCode()
void	setXml(java.lang.String pXml) Method for overriding everything in this class from well-formed xml.
java.lang.String	toString()
java.lang.String	toXML()
static ParserOptions	valueOf(java.lang.String pOptionsXml) parses options xml and returns a populated ParserOptions

Methods inherited from class atg.search.routing.command.indexing.OptionsBase

addFromSourceList, appendOptionalElemList, appendOptionalElemList, getContexts, getDeletes, getDocNormMin, getExpandedStemming, getFeatureSentenceTerms, getFeatureTerms, getFeatureZones, getIgnoreStatements, getIgnoreZones, getIndex, getIndexContentMax, getIndexImageFiles, getIndexItemURLs, getIndexScheme, getIndexStopThresh, getIndexTermMax, getIndexTermThresh, getLanguage, getMetatagDelims, getMetatagEnumProps, getMetatagExcludes, getMetatagFloatProps, getMetatagIndexes, getMetatagInfoProps, getMetatagNorm, getMetatagNumberProps, getMetatagPropWeights, getMetatags, getMetatagSearchables, getMetatagStringProps, getMetatagSummaries, getMetatagTermProps, getMetatagTextProps, getPackageDisables, getProcessLevel, getPropertyMappings, getQueryRuleDisables, getQueryRuleEnables, getRankDocProp, getRuleEnables, getSecurityRoles, getSentenceMaxSize, getSentenceMinSize, getSpellChecker, getSpellMaxSuggestions, getSpellSplitWords, getSpellSuggestionCutoff, getSpellSuggestionFactor, getStoreSource, getTableCell, getTableStructures, getTargetLanguageExpansion, getTargetLanguages, getTopicConfidence, getTopicDisables, getTopicEnables, getTopicInheritance, getTopicMaximum, getTopicPropOnly, getTopicRelevance, getWildcardChars, getWildcardMax, isSourceListNeeded, mergeFrom, setContexts, setDeletes, setDocNormMin, setExpandedStemming, setFeatureSentenceTerms, setFeatureTerms, setFeatureZones, setIgnoreStatements, setIgnoreZones, setIndex, setIndexContentMax, setIndexImageFiles, setIndexItemURLs, setIndexScheme, setIndexStopThresh, setIndexTermMax, setIndexTermThresh, setLanguage, setMetatagDelims, setMetatagEnumProps, setMetatagExcludes, setMetatagFloatProps, setMetatagIndexes, setMetatagInfoProps, setMetatagNorm, setMetatagNumberProps, setMetatagPropWeights, setMetatags, setMetatagSearchables, setMetatagStringProps, setMetatagSummaries, setMetatagTermProps, setMetatagTextProps, setPackageDisables, setProcessLevel, setPropertyMappings, setQueryRuleDisables, setQueryRuleEnables, setRankDocProp, setRuleEnables, setSecurityRoles, setSentenceMaxSize, setSentenceMinSize, setSpellChecker, setSpellMaxSuggestions, setSpellSplitWords, setSpellSuggestionCutoff, setSpellSuggestionFactor, setStoreSource, setTableCell, setTableStructures, setTargetLanguageExpansion, setTargetLanguages, setTopicConfidence, setTopicDisables, setTopicEnables, setTopicInheritance, setTopicMaximum, setTopicPropOnly, setTopicRelevance, setWildcardChars, setWildcardMax

Methods inherited from class atg.search.routing.command.indexing.IndexingRequestFragment

getIndexingType

Methods inherited from class atg.search.routing.command.indexing.IndexingRequest

getAllAttributeXML, getContentBytes, getIndexingLayer, getItemDescription, getLongHash, getRequestCode, getRequestTag, getSizeInBytes, getStringForHash, getSubscriptionKey, getTimeoutMs, isSynchronous, setContentBytes, setItemDescription, setStringForHash, setSubscriptionKey, setSynchronous, setTimeoutMs

Methods inherited from class atg.search.routing.command.SearchEngineRequestImpl

encodeMapData, getRequestAttribute, getRequestAttributes, isFiringSearchEvents, isKeepingResponseData, isLoggingThisRequest, processResponse, setFiringSearchEvents, setKeepingResponseData, setLoggingThisRequest, setRequestAttribute, setRequestAttributes

Methods inherited from class atg.search.routing.command.SearchXMLObject

appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendOptionalValue, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllBodyXML, getAttributeXML, getDefaultXmlBytes, getParentXMLObject, getXmlPath, isPrintedFirstChild, setParentXMLObject, setPrintedFirstChild, toXML

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

ParserOptions

public ParserOptions()

ParserOptions

public ParserOptions(java.lang.String pXml)

Constructor that creates and initializes the instance from specified XML.

Parameters:

pXml - the parser options XML or null

Method Detail

getRequestEnum

public atg.search.routing.command.indexing.RequestTagType getRequestEnum()

Specified by:

getRequestEnum in class atg.search.routing.command.indexing.IndexingRequest

Returns:

request tag for this type

setXml

public void setXml(java.lang.String pXml)

Method for overriding everything in this class from well-formed xml. Be careful when using this, the XML is not validated and must be correct.

The parser options will be initialized from whatever the parser finds. Ill-formed XML may result in partially initialized parser options. If you are using a parser, see fromXmlParser(atg.search.routing.utils.SearchMessageNode).

Parameters:

pXml - parser option xml

getXml

public java.lang.String getXml()
                        throws atg.search.routing.command.IncompleteCommandException

Getter for the xml. Same as toXml().

Returns:

xml representation of the parserOptions

Throws:

atg.search.routing.command.IncompleteCommandException

toXML

public java.lang.String toXML()
                       throws atg.search.routing.command.IncompleteCommandException

Specified by:

toXML in interface atg.search.routing.command.SearchEngineRequest

Overrides:

toXML in class atg.search.routing.command.SearchXMLObject

Throws:

atg.search.routing.command.IncompleteCommandException

getBodyXML

protected void getBodyXML(java.lang.StringBuilder cmd)
                   throws atg.search.routing.command.IncompleteCommandException

Overrides:

getBodyXML in class atg.search.routing.command.SearchXMLObject

Throws:

atg.search.routing.command.IncompleteCommandException

fromXmlParser

protected static ParserOptions fromXmlParser(atg.search.routing.utils.SearchMessageNode xml)

creates a new ParserOptions from the xml parser

Parameters:

xml - an xml parser

Returns:

a new ParserOptions initialized from the parser

valueOf

public static ParserOptions valueOf(java.lang.String pOptionsXml)

parses options xml and returns a populated ParserOptions

Parameters:

pOptionsXml - well-formed and decoded options xml

Returns:

a populated ParserOptions, or null if the input is null or empty

toString

public java.lang.String toString()

Overrides:

toString in class atg.search.routing.command.indexing.IndexingRequest

equals

public boolean equals(java.lang.Object pObject)

compares this with another by an XML comparison. Note that this will generate full xml. It's not fast.

Overrides:

equals in class java.lang.Object

Parameters:

pObject - another ParserOptions

Returns:

true if they produce identical XML

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object