atg.search.routing.command.indexing
Class OptionsBase

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ParserOptions

public abstract class OptionsBase
extends atg.search.routing.command.indexing.IndexingRequestFragment

Optional: All

Required: None

See Also:

Serialized Form

Nested Class Summary

static class	OptionsBase.ExpandedStemmingType
static class	OptionsBase.ExpandedStemmingTypeEditor
static class	OptionsBase.Index
static class	OptionsBase.IndexScheme
static class	OptionsBase.IndexSchemeEditor
static class	OptionsBase.IndexTypeEditor
static class	OptionsBase.SpellChecker
static class	OptionsBase.SpellCheckerEditor
static class	OptionsBase.SpellSplitWords Controls how split-word spell correction is performed

Field Summary

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

Constructor Summary

OptionsBase()

Method Summary

protected java.lang.Object	addFromSourceList(java.lang.Object[] pParentList) Add entries from the source List only if our local List is empty.
protected boolean	appendOptionalElemList(java.lang.StringBuilder buf, java.lang.String tag, java.util.List vals) Adds the element once for each non-null element in the array.
protected boolean	appendOptionalElemList(java.lang.StringBuilder buf, java.lang.String tag, java.lang.Object[] vals) Adds the element once for each non-null element in the array.
java.lang.String[]	getContexts() String contexts
java.lang.String[]	getDeletes() String delete text
java.lang.Integer	getDocNormMin()
OptionsBase.ExpandedStemmingType	getExpandedStemming()
java.lang.String[]	getFeatureSentenceTerms() Returns the sentence feature term array
java.lang.String[]	getFeatureTerms()
java.lang.String[]	getFeatureZones()
java.lang.String[]	getIgnoreStatements()
java.lang.String[]	getIgnoreZones()
OptionsBase.Index	getIndex()
java.lang.Integer	getIndexContentMax()
java.lang.String[]	getIndexImageFiles()
java.lang.Boolean	getIndexItemURLs() Indicates whether to index the document URL in a special text field called role:url
OptionsBase.IndexScheme	getIndexScheme()
java.lang.Integer	getIndexStopThresh()
java.lang.Integer	getIndexTermMax()
java.lang.Integer	getIndexTermThresh()
atg.search.routing.utils.Language	getLanguage()
java.lang.String[]	getMetatagDelims()
java.lang.String[]	getMetatagEnumProps()
java.lang.String[]	getMetatagExcludes()
java.lang.String[]	getMetatagFloatProps()
java.lang.String[]	getMetatagIndexes()
java.lang.String[]	getMetatagInfoProps()
java.lang.Boolean	getMetatagNorm()
java.lang.String[]	getMetatagNumberProps()
java.lang.String[]	getMetatagPropWeights()
java.lang.String[]	getMetatags()
java.lang.String[]	getMetatagSearchables()
java.lang.String[]	getMetatagStringProps()
java.lang.String[]	getMetatagSummaries()
java.lang.String[]	getMetatagTermProps()
java.lang.String[]	getMetatagTextProps()
java.lang.String[]	getPackageDisables()
java.lang.String	getProcessLevel()
java.lang.String[]	getPropertyMappings()
java.lang.String[]	getQueryRuleDisables()
java.lang.String[]	getQueryRuleEnables()
java.lang.String	getRankDocProp()
java.lang.String[]	getRuleEnables()
java.lang.String[]	getSecurityRoles()
java.lang.Integer	getSentenceMaxSize()
java.lang.Integer	getSentenceMinSize()
OptionsBase.SpellChecker	getSpellChecker()
java.lang.Integer	getSpellMaxSuggestions()
OptionsBase.SpellSplitWords	getSpellSplitWords() Returns the setting for spell-correcting split words
java.lang.Integer	getSpellSuggestionCutoff()
java.lang.Integer	getSpellSuggestionFactor() Controls when to return spelling suggestions for query terms that are in the index and thus are not considered misspelled.
java.lang.Boolean	getStoreSource()
java.lang.String	getTableCell()
java.lang.String[]	getTableStructures()
java.lang.Boolean	getTargetLanguageExpansion()
atg.search.routing.utils.Language[]	getTargetLanguages() Returns an array of target languages
java.lang.Integer	getTopicConfidence()
java.lang.String[]	getTopicDisables()
java.lang.String[]	getTopicEnables()
java.lang.Boolean	getTopicInheritance()
java.lang.Integer	getTopicMaximum()
java.lang.Boolean	getTopicPropOnly()
java.lang.Integer	getTopicRelevance()
java.lang.String[]	getWildcardChars()
java.lang.Integer	getWildcardMax()
protected boolean	isSourceListNeeded(java.lang.Object[] pLocalList, java.lang.Object[] pParentList) Indicates whether the we should take the options from the provided source.
void	mergeFrom(OptionsBase pOptionsSource) Merge values from the specified OptionsBase object.
void	setContexts(java.lang.String[] contexts) Sets the array of context strings.
void	setDeletes(java.lang.String[] deletes) Sets whether text within certain tags is deleted (not forwarded to the NLP processing).
void	setDocNormMin(java.lang.Integer docNormMin) Sets the minimum normalization value for document weighting
void	setExpandedStemming(OptionsBase.ExpandedStemmingType expandedStemming) Controls whether an expanded set of stems is used for query processing.
void	setFeatureSentenceTerms(java.lang.String[] pFeatureSentenceTerms) These features are stored with the sentence if it contains a word with the feature
void	setFeatureTerms(java.lang.String[] featureTerms)
void	setFeatureZones(java.lang.String[] featureZones) If a sentence is contained in a tag name from this list, then the sentence is assigned a feature of that name.
void	setIgnoreStatements(java.lang.String[] ignoreStatements) Defines a pattern to match against text statements and exclude them from indexing.
void	setIgnoreZones(java.lang.String[] ignoreZones) Defines an HTML tag that will be ignored within text statements during indexing, but the statement text will be preserved.
void	setIndex(OptionsBase.Index index) Controls whether the document is actually indexed for retrieval.
void	setIndexContentMax(java.lang.Integer indexContentMax) Sets index max content size in bytes
void	setIndexImageFiles(java.lang.String[] indexImageFiles) Controls what rich content file extensions will be indexed as images rather than converted text.
void	setIndexItemURLs(java.lang.Boolean pIndexItemURLs) Controls whether to index the document URL in a special text field called role:url
void	setIndexScheme(OptionsBase.IndexScheme indexScheme) Controls whether the index is compressed, uncompressed, or on disk.
void	setIndexStopThresh(java.lang.Integer indexStopThresh) Controls what terms are treated as stop-words (skipped during indexing).
void	setIndexTermMax(java.lang.Integer indexTermMax) Limits the maximum number of times a term can be indexed.
void	setIndexTermThresh(java.lang.Integer indexTermThresh) Controls what terms are stored but not indexed.
void	setLanguage(atg.search.routing.utils.Language language) Sets the language to assume for text processing of documents during indexing or query text.
void	setMetatagDelims(java.lang.String[] metatagDelims) Lists the characters that will be interpreted as separators for metatag values.
void	setMetatagEnumProps(java.lang.String[] metatagEnumProps) Defines meta tag names which will be stored as enumerated (string) properties
void	setMetatagExcludes(java.lang.String[] metatagExcludes) Values of metatag names to exclude from document sets
void	setMetatagFloatProps(java.lang.String[] metatagFloatProps) Defines meta tag names which will be stored as floating point properties
void	setMetatagIndexes(java.lang.String[] metatagIndexes) Defines meta tag names which will be stored as indexed properties
void	setMetatagInfoProps(java.lang.String[] metatagInfoProps) Defines meta tag names which will be stored as information properties in the storage file
void	setMetatagNorm(java.lang.Boolean metatagNorm) Sets whether meta tag values should be normalized to lower case
void	setMetatagNumberProps(java.lang.String[] metatagNumberProps) Defines meta tag names which will be stored as integer properties
void	setMetatagPropWeights(java.lang.String[] metatagPropWeights) Sets metatag property weights
void	setMetatags(java.lang.String[] metatags) Defines meta tag names which will be stored as document sets
void	setMetatagSearchables(java.lang.String[] metatagSearchables)
void	setMetatagStringProps(java.lang.String[] metatagStringProps) Defines meta tag names which will be stored as string properties
void	setMetatagSummaries(java.lang.String[] metatagSummaries)
void	setMetatagTermProps(java.lang.String[] metatagTermProps)
void	setMetatagTextProps(java.lang.String[] metatagTextProps)
void	setPackageDisables(java.lang.String[] packageDisables)
void	setProcessLevel(java.lang.String processLevel) Sets the process level
void	setPropertyMappings(java.lang.String[] propertyMappings) Specifies if an external property name (from a constraint, refinement, or request) should be mapped to an internal property name from an ordered list of choices.
void	setQueryRuleDisables(java.lang.String[] queryRuleDisables) Disables query rules
void	setQueryRuleEnables(java.lang.String[] queryRuleEnables) Enables query rule groups
void	setRankDocProp(java.lang.String pRankDocProp) Names of properties to use for document relevancy ranking
void	setRuleEnables(java.lang.String[] ruleEnables)
void	setSecurityRoles(java.lang.String[] securityRoles) Names of security roles or fields to restrict search to
void	setSentenceMaxSize(java.lang.Integer sentenceMaxSize) Sets the sentence max size
void	setSentenceMinSize(java.lang.Integer sentenceMinSize) Sets the sentence min size
void	setSpellChecker(OptionsBase.SpellChecker spellChecker) Sets the spell checking module
void	setSpellMaxSuggestions(java.lang.Integer spellMaxSuggestions) Sets the max spelling suggestions
void	setSpellSplitWords(OptionsBase.SpellSplitWords pSpellSplitWords) Sets the setting for spell-correcting split words
void	setSpellSuggestionCutoff(java.lang.Integer spellSuggestionCutoff) Score threshold for Wintertree suggestions
void	setSpellSuggestionFactor(java.lang.Integer pSpellSuggestionFactor) Controls when to return spelling suggestions for query terms that are in the index and thus are not considered misspelled.
void	setStoreSource(java.lang.Boolean storeSource) Enables or disables storage of index item text during indexing.
void	setTableCell(java.lang.String tableCell)
void	setTableStructures(java.lang.String[] tableStructures)
void	setTargetLanguageExpansion(java.lang.Boolean targetLanguageExpansion) Sets the target language expansion
void	setTargetLanguages(atg.search.routing.utils.Language[] targetLanguages) Languages of the search results
void	setTopicConfidence(java.lang.Integer topicConfidence) Sets topic confidence
void	setTopicDisables(java.lang.String[] topicDisables)
void	setTopicEnables(java.lang.String[] topicEnables)
void	setTopicInheritance(java.lang.Boolean pTopicInheritance) Controls whether topic inheritance for documents is enabled
void	setTopicMaximum(java.lang.Integer topicMaximum) Sets the topic maximum
void	setTopicPropOnly(java.lang.Boolean topicPropOnly) Sets the topic properties only indicator
void	setTopicRelevance(java.lang.Integer topicRelevance) Sets the topic relevance control
void	setWildcardChars(java.lang.String[] wildcardChars) Maximum expansion of wildcard query term
void	setWildcardMax(java.lang.Integer wildcardMax) Sets the maximum expansion of wildcard query term

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, getRequestEnum, getRequestTag, getSizeInBytes, getStringForHash, getSubscriptionKey, getTimeoutMs, isSynchronous, setContentBytes, setItemDescription, setStringForHash, setSubscriptionKey, setSynchronous, setTimeoutMs, toString

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, getBodyXML, getDefaultXmlBytes, getParentXMLObject, getXmlPath, isPrintedFirstChild, setParentXMLObject, setPrintedFirstChild, toXML, toXML

Methods inherited from class java.lang.Object

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

Methods inherited from interface atg.search.routing.command.SearchEngineRequest

toXML

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

CONTEXT

protected static final java.lang.String CONTEXT

See Also:

Constant Field Values

DELETE

protected static final java.lang.String DELETE

See Also:

Constant Field Values

DOC_NORM_MIN

protected static final java.lang.String DOC_NORM_MIN

See Also:

Constant Field Values

EXPANDED_STEMMING

protected static final java.lang.String EXPANDED_STEMMING

See Also:

Constant Field Values

FEATURE_SENTENCE_TERMS

protected static final java.lang.String FEATURE_SENTENCE_TERMS

See Also:

Constant Field Values

FEATURE_TERMS

protected static final java.lang.String FEATURE_TERMS

See Also:

Constant Field Values

FEATURE_ZONES

protected static final java.lang.String FEATURE_ZONES

See Also:

Constant Field Values

IGNORE_STATEMENT

protected static final java.lang.String IGNORE_STATEMENT

See Also:

Constant Field Values

IGNORE_ZONE

protected static final java.lang.String IGNORE_ZONE

See Also:

Constant Field Values

INDEX

protected static final java.lang.String INDEX

See Also:

Constant Field Values

INDEX_CONTENT_MAX

protected static final java.lang.String INDEX_CONTENT_MAX

See Also:

Constant Field Values

INDEX_SCHEME

protected static final java.lang.String INDEX_SCHEME

See Also:

Constant Field Values

INDEX_ITEM_URLS

protected static final java.lang.String INDEX_ITEM_URLS

See Also:

Constant Field Values

INDEX_IMAGE_FILE

protected static final java.lang.String INDEX_IMAGE_FILE

See Also:

Constant Field Values

INDEX_STOP_THRESH

protected static final java.lang.String INDEX_STOP_THRESH

See Also:

Constant Field Values

INDEX_TERM_MAX

protected static final java.lang.String INDEX_TERM_MAX

See Also:

Constant Field Values

INDEX_TERM_THRESH

protected static final java.lang.String INDEX_TERM_THRESH

See Also:

Constant Field Values

LANGUAGE

protected static final java.lang.String LANGUAGE

See Also:

Constant Field Values

METATAG

protected static final java.lang.String METATAG

See Also:

Constant Field Values

METATAG_DELIM

protected static final java.lang.String METATAG_DELIM

See Also:

Constant Field Values

METATAG_ENUM_PROP

protected static final java.lang.String METATAG_ENUM_PROP

See Also:

Constant Field Values

METATAG_EXCLUDE

protected static final java.lang.String METATAG_EXCLUDE

See Also:

Constant Field Values

METATAG_FLOAT_PROP

protected static final java.lang.String METATAG_FLOAT_PROP

See Also:

Constant Field Values

METATAG_INDEX

protected static final java.lang.String METATAG_INDEX

See Also:

Constant Field Values

METATAG_INFO_PROP

protected static final java.lang.String METATAG_INFO_PROP

See Also:

Constant Field Values

METATAG_NORM

protected static final java.lang.String METATAG_NORM

See Also:

Constant Field Values

METATAG_NUMBER_PROP

protected static final java.lang.String METATAG_NUMBER_PROP

See Also:

Constant Field Values

METATAG_PROP_WEIGHT

protected static final java.lang.String METATAG_PROP_WEIGHT

See Also:

Constant Field Values

METATAG_SEARCHABLE

protected static final java.lang.String METATAG_SEARCHABLE

See Also:

Constant Field Values

METATAG_STRING_PROP

protected static final java.lang.String METATAG_STRING_PROP

See Also:

Constant Field Values

METATAG_SUMMARY

protected static final java.lang.String METATAG_SUMMARY

See Also:

Constant Field Values

METATAG_TERM_PROP

protected static final java.lang.String METATAG_TERM_PROP

See Also:

Constant Field Values

METATAG_TEXT_PROP

protected static final java.lang.String METATAG_TEXT_PROP

See Also:

Constant Field Values

PACKAGE_DISABLE

protected static final java.lang.String PACKAGE_DISABLE

See Also:

Constant Field Values

PROCESS_LEVEL

protected static final java.lang.String PROCESS_LEVEL

See Also:

Constant Field Values

PROPERTY_MAPPING

protected static final java.lang.String PROPERTY_MAPPING

See Also:

Constant Field Values

QUERY_RULE_ENABLE

protected static final java.lang.String QUERY_RULE_ENABLE

See Also:

Constant Field Values

QUERY_RULE_DISABLE

protected static final java.lang.String QUERY_RULE_DISABLE

See Also:

Constant Field Values

RANK_DOC_PROP

protected static final java.lang.String RANK_DOC_PROP

See Also:

Constant Field Values

RULE_ENABLE

protected static final java.lang.String RULE_ENABLE

See Also:

Constant Field Values

SECURITY_ROLE

protected static final java.lang.String SECURITY_ROLE

See Also:

Constant Field Values

SENTENCE_MAX_SIZE

protected static final java.lang.String SENTENCE_MAX_SIZE

See Also:

Constant Field Values

SENTENCE_MIN_SIZE

protected static final java.lang.String SENTENCE_MIN_SIZE

See Also:

Constant Field Values

SPELL_CHECKER

protected static final java.lang.String SPELL_CHECKER

See Also:

Constant Field Values

SPELL_MAX_SUGGESTIONS

protected static final java.lang.String SPELL_MAX_SUGGESTIONS

See Also:

Constant Field Values

SPELL_SPLIT_WORDS

protected static final java.lang.String SPELL_SPLIT_WORDS

See Also:

Constant Field Values

SPELL_SUGGESTION_CUTOFF

protected static final java.lang.String SPELL_SUGGESTION_CUTOFF

See Also:

Constant Field Values

SPELL_SUGGESTION_FACTOR

protected static final java.lang.String SPELL_SUGGESTION_FACTOR

See Also:

Constant Field Values

STORE_SOURCE

protected static final java.lang.String STORE_SOURCE

See Also:

Constant Field Values

TABLE_CELL

protected static final java.lang.String TABLE_CELL

See Also:

Constant Field Values

TABLE_STRUCTURE

protected static final java.lang.String TABLE_STRUCTURE

See Also:

Constant Field Values

TARGET_LANGUAGE

protected static final java.lang.String TARGET_LANGUAGE

See Also:

Constant Field Values

TARGET_LANGUAGE_EXPANSION

protected static final java.lang.String TARGET_LANGUAGE_EXPANSION

See Also:

Constant Field Values

TOPIC_CONFIDENCE

protected static final java.lang.String TOPIC_CONFIDENCE

See Also:

Constant Field Values

TOPIC_DISABLE

protected static final java.lang.String TOPIC_DISABLE

See Also:

Constant Field Values

TOPIC_ENABLE

protected static final java.lang.String TOPIC_ENABLE

See Also:

Constant Field Values

TOPIC_MAXIMUM

protected static final java.lang.String TOPIC_MAXIMUM

See Also:

Constant Field Values

TOPIC_INHERITANCE

protected static final java.lang.String TOPIC_INHERITANCE

See Also:

Constant Field Values

TOPIC_PROP_ONLY

protected static final java.lang.String TOPIC_PROP_ONLY

See Also:

Constant Field Values

TOPIC_RELEVANCE

protected static final java.lang.String TOPIC_RELEVANCE

See Also:

Constant Field Values

WILDCARD_MAX

protected static final java.lang.String WILDCARD_MAX

See Also:

Constant Field Values

WILDCARD_CHAR

protected static final java.lang.String WILDCARD_CHAR

See Also:

Constant Field Values

Constructor Detail

OptionsBase

public OptionsBase()

Method Detail

setContexts

public void setContexts(java.lang.String[] contexts)

Sets the array of context strings. Specify what lexicon extensions should be loaded during indexing. Typically, an adaptor consists of modifications to the term expansions that reflect a different usage of the term in a domain.

Parameters:

contexts - array of context strings. Specify what lexicon extensions should be loaded during indexing. Typically, an adaptor consists of modifications to the term expansions that reflect a different usage of the term in a domain.

setDeletes

public void setDeletes(java.lang.String[] deletes)

Sets whether text within certain tags is deleted (not forwarded to the NLP processing). The text will appear in the document view, but will not be processed or indexed.

Parameters:

deletes - Controls whether text within certain tags is deleted (not forwarded to the NLP processing). The text will appear in the document view, but will not be processed or indexed.

setDocNormMin

public void setDocNormMin(java.lang.Integer docNormMin)

Sets the minimum normalization value for document weighting

Parameters:

docNormMin - Specifies the minimum normalization value for document weighting.

setExpandedStemming

public void setExpandedStemming(OptionsBase.ExpandedStemmingType expandedStemming)

Controls whether an expanded set of stems is used for query processing. A value of 'all' means that all terms in the query are expanded to all stems. A value of 'untagged' means that only terms that have not been POS-tagged are expanded to all stems.

Parameters:

expandedStemming -

getFeatureSentenceTerms

public java.lang.String[] getFeatureSentenceTerms()

Returns the sentence feature term array

Returns:

sentence feature term array

setFeatureSentenceTerms

public void setFeatureSentenceTerms(java.lang.String[] pFeatureSentenceTerms)

These features are stored with the sentence if it contains a word with the feature

Parameters:

pFeatureSentenceTerms - These features are stored with the sentence if it contains a word with the feature

setIndex

public void setIndex(OptionsBase.Index index)

Controls whether the document is actually indexed for retrieval. If none, the document is still stored but it is unretrievable. If sentence, the document's sentences are indexed for retrieval. If document, the document as a whole is indexed, and only titles are retrievable.

Parameters:

index - Controls whether the document is actually indexed for retrieval. If none, the document is still stored but it is unretrievable. If sentence, the document's sentences are indexed for retrieval. If document, the document as a whole is indexed, and only titles are retrievable.

setIndexScheme

public void setIndexScheme(OptionsBase.IndexScheme indexScheme)

Controls whether the index is compressed, uncompressed, or on disk.

Parameters:

indexScheme - Controls whether the index is compressed, uncompressed, or on disk.

setIndexStopThresh

public void setIndexStopThresh(java.lang.Integer indexStopThresh)

Controls what terms are treated as stop-words (skipped during indexing). Words with term weights below this threshold are stop-words, and are not stored or indexed.

Parameters:

indexStopThresh - Controls what terms are treated as stop-words (skipped during indexing). Words with term weights below this threshold are stop-words, and are not stored or indexed.

setIndexTermMax

public void setIndexTermMax(java.lang.Integer indexTermMax)

Limits the maximum number of times a term can be indexed.

Parameters:

indexTermMax - Limits the maximum number of times a term can be indexed.

setIndexTermThresh

public void setIndexTermThresh(java.lang.Integer indexTermThresh)

Controls what terms are stored but not indexed. Words with term weights below this threshold are not indexed, but are stored in the term vectors.

Parameters:

indexTermThresh - Controls what terms are stored but not indexed. Words with term weights below this threshold are not indexed, but are stored in the term vectors.

setLanguage

public void setLanguage(atg.search.routing.utils.Language language)

Sets the language to assume for text processing of documents during indexing or query text.

Parameters:

language - Sets the language to assume for text processing of documents during indexing or query text.

setMetatagNorm

public void setMetatagNorm(java.lang.Boolean metatagNorm)

Sets whether meta tag values should be normalized to lower case

Parameters:

metatagNorm - Whether meta tag values should be normalized to lower case

setSentenceMaxSize

public void setSentenceMaxSize(java.lang.Integer sentenceMaxSize)

Sets the sentence max size

Parameters:

sentenceMaxSize - sentence max size

setSentenceMinSize

public void setSentenceMinSize(java.lang.Integer sentenceMinSize)

Sets the sentence min size

Parameters:

sentenceMinSize - sentence min size

setSpellChecker

public void setSpellChecker(OptionsBase.SpellChecker spellChecker)

Sets the spell checking module

Parameters:

spellChecker - Spell checking module

getSpellSplitWords

public OptionsBase.SpellSplitWords getSpellSplitWords()

Returns the setting for spell-correcting split words

Returns:

the setting for spell-correcting split words

setSpellSplitWords

public void setSpellSplitWords(OptionsBase.SpellSplitWords pSpellSplitWords)

Sets the setting for spell-correcting split words

Parameters:

pSpellSplitWords - the setting for spell-correcting split words

setSpellMaxSuggestions

public void setSpellMaxSuggestions(java.lang.Integer spellMaxSuggestions)

Sets the max spelling suggestions

Parameters:

spellMaxSuggestions - max spelling suggestions

getSpellSuggestionFactor

public java.lang.Integer getSpellSuggestionFactor()

Controls when to return spelling suggestions for query terms that are in the index and thus are not considered misspelled. Normally, no spelling suggestions would be returned. Using this value, any suggestable term with a frequency greater than the original query term's frequency multiplied by this factor, is returned. An unspecified value (that is, null), or a value of 0 disables this functionality.

Returns:

spell suggestion factor

setSpellSuggestionFactor

public void setSpellSuggestionFactor(java.lang.Integer pSpellSuggestionFactor)

Controls when to return spelling suggestions for query terms that are in the index and thus are not considered misspelled. Normally, no spelling suggestions would be returned. Using this value, any suggestable term with a frequency greater than the original query term's frequency multiplied by this factor, is returned. An unspecified value (that is, null), or a value of 0 disables this functionality.

Parameters:

pSpellSuggestionFactor - spell suggestion factor

setSpellSuggestionCutoff

public void setSpellSuggestionCutoff(java.lang.Integer spellSuggestionCutoff)

Score threshold for Wintertree suggestions

Parameters:

spellSuggestionCutoff - Score threshold for Wintertree suggestions

setStoreSource

public void setStoreSource(java.lang.Boolean storeSource)

Enables or disables storage of index item text during indexing. Disabling this will improve performance at the expense of search functionality.

Parameters:

storeSource - if false, document sources will not be stored. ViewDocumentRequests will not return document text.

setIndexContentMax

public void setIndexContentMax(java.lang.Integer indexContentMax)

Sets index max content size in bytes

Parameters:

indexContentMax - max content size in bytes

setTargetLanguageExpansion

public void setTargetLanguageExpansion(java.lang.Boolean targetLanguageExpansion)

Sets the target language expansion

Parameters:

targetLanguageExpansion - target language expansion

setTopicConfidence

public void setTopicConfidence(java.lang.Integer topicConfidence)

Sets topic confidence

Parameters:

topicConfidence - topic confidence

setTopicMaximum

public void setTopicMaximum(java.lang.Integer topicMaximum)

Sets the topic maximum

Parameters:

topicMaximum - the topic maximum

setTopicPropOnly

public void setTopicPropOnly(java.lang.Boolean topicPropOnly)

Sets the topic properties only indicator

Parameters:

topicPropOnly - topic properties only indicator

setTopicRelevance

public void setTopicRelevance(java.lang.Integer topicRelevance)

Sets the topic relevance control

Parameters:

topicRelevance - topic relevance control

setTopicInheritance

public void setTopicInheritance(java.lang.Boolean pTopicInheritance)

Controls whether topic inheritance for documents is enabled

Parameters:

pTopicInheritance - true to enable topic inheritance for documents

setWildcardMax

public void setWildcardMax(java.lang.Integer wildcardMax)

Sets the maximum expansion of wildcard query term

Parameters:

wildcardMax - Maximum expansion of wildcard query term

setProcessLevel

public void setProcessLevel(java.lang.String processLevel)

Sets the process level

Parameters:

processLevel - process level

setTableCell

public void setTableCell(java.lang.String tableCell)

Parameters:

tableCell -

setFeatureTerms

public void setFeatureTerms(java.lang.String[] featureTerms)

Parameters:

featureTerms -

setFeatureZones

public void setFeatureZones(java.lang.String[] featureZones)

If a sentence is contained in a tag name from this list, then the sentence is assigned a feature of that name. A sentence can be assigned multiple features. If a value for this option is of the form tag=X, then the sentence is given the feature X rather than the feature tag.

Parameters:

featureZones - zones

setIgnoreStatements

public void setIgnoreStatements(java.lang.String[] ignoreStatements)

Defines a pattern to match against text statements and exclude them from indexing. Patterns begin with a prefix of either: all:, begins:, ends:, or contains:.

Parameters:

ignoreStatements - statements

setIgnoreZones

public void setIgnoreZones(java.lang.String[] ignoreZones)

Defines an HTML tag that will be ignored within text statements during indexing, but the statement text will be preserved.

Parameters:

ignoreZones - zones

setIndexImageFiles

public void setIndexImageFiles(java.lang.String[] indexImageFiles)

Controls what rich content file extensions will be indexed as images rather than converted text. Enter values in lower-case.

Parameters:

indexImageFiles - files

setIndexItemURLs

public void setIndexItemURLs(java.lang.Boolean pIndexItemURLs)

Controls whether to index the document URL in a special text field called role:url

Parameters:

pIndexItemURLs - urls

setMetatags

public void setMetatags(java.lang.String[] metatags)

Defines meta tag names which will be stored as document sets

Parameters:

metatags - metatags

setMetatagDelims

public void setMetatagDelims(java.lang.String[] metatagDelims)

Lists the characters that will be interpreted as separators for metatag values.

Parameters:

metatagDelims - delimiters

setMetatagEnumProps

public void setMetatagEnumProps(java.lang.String[] metatagEnumProps)

Defines meta tag names which will be stored as enumerated (string) properties

Parameters:

metatagEnumProps - metatag names

setMetatagExcludes

public void setMetatagExcludes(java.lang.String[] metatagExcludes)

Values of metatag names to exclude from document sets

Parameters:

metatagExcludes - names to exclude

setTargetLanguages

public void setTargetLanguages(atg.search.routing.utils.Language[] targetLanguages)

Languages of the search results

Parameters:

targetLanguages - array of languages

setMetatagFloatProps

public void setMetatagFloatProps(java.lang.String[] metatagFloatProps)

Defines meta tag names which will be stored as floating point properties

Parameters:

metatagFloatProps - properties

setMetatagIndexes

public void setMetatagIndexes(java.lang.String[] metatagIndexes)

Defines meta tag names which will be stored as indexed properties

Parameters:

metatagIndexes -

setMetatagInfoProps

public void setMetatagInfoProps(java.lang.String[] metatagInfoProps)

Defines meta tag names which will be stored as information properties in the storage file

Parameters:

metatagInfoProps - properties

setMetatagNumberProps

public void setMetatagNumberProps(java.lang.String[] metatagNumberProps)

Defines meta tag names which will be stored as integer properties

Parameters:

metatagNumberProps -

setMetatagPropWeights

public void setMetatagPropWeights(java.lang.String[] metatagPropWeights)

Sets metatag property weights

Parameters:

metatagPropWeights -

setMetatagSearchables

public void setMetatagSearchables(java.lang.String[] metatagSearchables)

setMetatagStringProps

public void setMetatagStringProps(java.lang.String[] metatagStringProps)

Defines meta tag names which will be stored as string properties

Parameters:

metatagStringProps -

setMetatagSummaries

public void setMetatagSummaries(java.lang.String[] metatagSummaries)

setMetatagTermProps

public void setMetatagTermProps(java.lang.String[] metatagTermProps)

setMetatagTextProps

public void setMetatagTextProps(java.lang.String[] metatagTextProps)

setPackageDisables

public void setPackageDisables(java.lang.String[] packageDisables)

setPropertyMappings

public void setPropertyMappings(java.lang.String[] propertyMappings)

Specifies if an external property name (from a constraint, refinement, or request) should be mapped to an internal property name from an ordered list of choices. The format of this option is: external,internal,internal,...

Parameters:

propertyMappings -

setQueryRuleEnables

public void setQueryRuleEnables(java.lang.String[] queryRuleEnables)

Enables query rule groups

Parameters:

queryRuleEnables -

setQueryRuleDisables

public void setQueryRuleDisables(java.lang.String[] queryRuleDisables)

Disables query rules

Parameters:

queryRuleDisables -

setRankDocProp

public void setRankDocProp(java.lang.String pRankDocProp)

Names of properties to use for document relevancy ranking

Parameters:

pRankDocProp -

setRuleEnables

public void setRuleEnables(java.lang.String[] ruleEnables)

setSecurityRoles

public void setSecurityRoles(java.lang.String[] securityRoles)

Names of security roles or fields to restrict search to

Parameters:

securityRoles -

setTableStructures

public void setTableStructures(java.lang.String[] tableStructures)

setTopicDisables

public void setTopicDisables(java.lang.String[] topicDisables)

setTopicEnables

public void setTopicEnables(java.lang.String[] topicEnables)

setWildcardChars

public void setWildcardChars(java.lang.String[] wildcardChars)

Maximum expansion of wildcard query term

Parameters:

wildcardChars -

getFeatureTerms

public java.lang.String[] getFeatureTerms()

getFeatureZones

public java.lang.String[] getFeatureZones()

getIgnoreStatements

public java.lang.String[] getIgnoreStatements()

getIgnoreZones

public java.lang.String[] getIgnoreZones()

getIndex

public OptionsBase.Index getIndex()

getIndexScheme

public OptionsBase.IndexScheme getIndexScheme()

getIndexImageFiles

public java.lang.String[] getIndexImageFiles()

getIndexStopThresh

public java.lang.Integer getIndexStopThresh()

getIndexTermMax

public java.lang.Integer getIndexTermMax()

getIndexTermThresh

public java.lang.Integer getIndexTermThresh()

getLanguage

public atg.search.routing.utils.Language getLanguage()

getMetatags

public java.lang.String[] getMetatags()

getMetatagDelims

public java.lang.String[] getMetatagDelims()

getMetatagEnumProps

public java.lang.String[] getMetatagEnumProps()

getMetatagExcludes

public java.lang.String[] getMetatagExcludes()

getMetatagNorm

public java.lang.Boolean getMetatagNorm()

getSentenceMaxSize

public java.lang.Integer getSentenceMaxSize()

getSentenceMinSize

public java.lang.Integer getSentenceMinSize()

getSpellChecker

public OptionsBase.SpellChecker getSpellChecker()

getSpellMaxSuggestions

public java.lang.Integer getSpellMaxSuggestions()

getSpellSuggestionCutoff

public java.lang.Integer getSpellSuggestionCutoff()

Returns:

Score threshold for Wintertree suggestions

getStoreSource

public java.lang.Boolean getStoreSource()

getIndexContentMax

public java.lang.Integer getIndexContentMax()

getIndexItemURLs

public java.lang.Boolean getIndexItemURLs()

Indicates whether to index the document URL in a special text field called role:url

Returns:

whether to index the document URL in a special text field called role:url

getTargetLanguages

public atg.search.routing.utils.Language[] getTargetLanguages()

Returns an array of target languages

Returns:

Array of target Languages

getTargetLanguageExpansion

public java.lang.Boolean getTargetLanguageExpansion()

getTopicConfidence

public java.lang.Integer getTopicConfidence()

getTopicMaximum

public java.lang.Integer getTopicMaximum()

getTopicPropOnly

public java.lang.Boolean getTopicPropOnly()

getTopicRelevance

public java.lang.Integer getTopicRelevance()

getWildcardMax

public java.lang.Integer getWildcardMax()

getMetatagFloatProps

public java.lang.String[] getMetatagFloatProps()

getMetatagIndexes

public java.lang.String[] getMetatagIndexes()

getMetatagInfoProps

public java.lang.String[] getMetatagInfoProps()

getMetatagNumberProps

public java.lang.String[] getMetatagNumberProps()

getMetatagPropWeights

public java.lang.String[] getMetatagPropWeights()

getMetatagSearchables

public java.lang.String[] getMetatagSearchables()

getMetatagStringProps

public java.lang.String[] getMetatagStringProps()

getMetatagSummaries

public java.lang.String[] getMetatagSummaries()

getMetatagTermProps

public java.lang.String[] getMetatagTermProps()

getMetatagTextProps

public java.lang.String[] getMetatagTextProps()

getPackageDisables

public java.lang.String[] getPackageDisables()

getProcessLevel

public java.lang.String getProcessLevel()

getPropertyMappings

public java.lang.String[] getPropertyMappings()

getQueryRuleEnables

public java.lang.String[] getQueryRuleEnables()

getQueryRuleDisables

public java.lang.String[] getQueryRuleDisables()

getRankDocProp

public java.lang.String getRankDocProp()

getRuleEnables

public java.lang.String[] getRuleEnables()

getSecurityRoles

public java.lang.String[] getSecurityRoles()

getTableCell

public java.lang.String getTableCell()

getTableStructures

public java.lang.String[] getTableStructures()

getTopicDisables

public java.lang.String[] getTopicDisables()

getTopicEnables

public java.lang.String[] getTopicEnables()

getWildcardChars

public java.lang.String[] getWildcardChars()

getTopicInheritance

public java.lang.Boolean getTopicInheritance()

appendOptionalElemList

protected boolean appendOptionalElemList(java.lang.StringBuilder buf,
                                         java.lang.String tag,
                                         java.util.List vals)

Adds the element once for each non-null element in the array.

Parameters:

buf - buffer for xml

tag - element tag name

vals - element values

Returns:

true if the elements were added

appendOptionalElemList

protected boolean appendOptionalElemList(java.lang.StringBuilder buf,
                                         java.lang.String tag,
                                         java.lang.Object[] vals)

Adds the element once for each non-null element in the array.

Parameters:

buf - buffer for xml

tag - element tag name

vals - element values

Returns:

true if the elements were added

getContexts

public java.lang.String[] getContexts()

String contexts

Returns:

array of Strings

getDeletes

public java.lang.String[] getDeletes()

String delete text

Returns:

List of String

getDocNormMin

public java.lang.Integer getDocNormMin()

getExpandedStemming

public OptionsBase.ExpandedStemmingType getExpandedStemming()

mergeFrom

public void mergeFrom(OptionsBase pOptionsSource)

Merge values from the specified OptionsBase object. Copy over the source values if our property is null or an empty list.

Parameters:

pOptionsSource - the OptionsBase object from which to copy values.

addFromSourceList

protected java.lang.Object addFromSourceList(java.lang.Object[] pParentList)

Add entries from the source List only if our local List is empty.

Parameters:

pParentList - the parent's (merging source's) version

See Also:

isSourceListNeeded(Object[], Object[])

isSourceListNeeded

protected boolean isSourceListNeeded(java.lang.Object[] pLocalList,
                                     java.lang.Object[] pParentList)

Indicates whether the we should take the options from the provided source. Returns true if a) we don't have our own options and b) the source provides some. If this returns true, call addFromSourceList(Object[]).

Parameters:

pLocalList - the local list

pParentList - the source list

Returns:

true if the source options should be used