Options Class

The Options object enables you to specify how the dtSearch engine will process text being indexed or searched.

File

File: Options.java

Syntax

Java

public class Options;

Methods

Method	Description
get	Get option settings currently in effect
getStemmingRulesFile	Stemming rules for stemming searches (default: "stemming.dat")
getStoredFieldDelimiterChar	Character to insert between multiple instances of a stored field in a single document
getTextFlags	TextFlags value with text-processing options
getUnicodeFilterRanges	Indicates Unicode ranges that are of interest when filtering.
save	Applies changes to option settings
setAlphabetFile	Name of dtSearch alphabet file to use when parsing text into words.
setBinaryFiles	BinaryFilesSettings value specifying the treatment of files that do not appear to be documents.
setBinaryFilterTextChars	Define characters considered to be text if Options.setBinaryFiles is set to dtsoFilterBinary
setBooleanConnectors	Use to replace the default connectors used in search requests.
setFieldFlags	FieldFlags value that controls indexing of metadata
setFileTypeTableFile	Name of the file containing a table of filename patterns for file formats that dtSearch cannot detect automatically, such as older versions of WordStar
setFuzzyChar	Character that enables fuzzy searching for a search term (default "%"); see Redefining Search Operators.
setHomeDir	Directory where the dtSearch Engine and support files are located.
setHyphens	HyphenSettings value controlling the treatment of hyphens in text.
setIndexNumbers	If false, any word that begins with a digit will not be indexed.
setLzwEnableCode	Obsolete
setMacroChar	Character that indicates that a search term is a macro (default "@"); see Redefining Search Operators.
setMatchDigitChar	Wildcard character that matches a single digit (default: none)
setMaxStoredFieldSize	Maximum size of a single stored field. Store fields are field data collected during indexing that is returned in search results.
setMaxWordLength	Words longer than the maxWordLength will be truncated when indexing. The default maxWordLength is 32. The maximum value is 128.
setMaxWordsToRetrieve	Maximum number of words that can be matched in a search. This can be any value from 16 to 256k. The default is 64k. If a search matches more unique words than the maxWordsToRetrieve limit, the error code dtsErMaxWords will be returned.
setNoiseWordFile	List of noise words to skip during indexing (default: "noise.dat")
setPhonicChar	Character that enables phonic searching for a search term (default "#"); see Redefining Search Operators.
setPrivateDir	A directory that the dtSearch Engine can use to store per-user settings and temporary files.
setSegmentationRulesFile	File segmentation rules, used to split up long text files into logical subdocuments during indexing.
setStemmingChar	Character that enables stemming for a search term; see Redefining Search Operators.
setStemmingRulesFile	Stemming rules for stemming searches (default: "stemming.dat")
setStoredFieldDelimiterChar	Character to insert between multiple instances of a stored field in a single document
setSynonymChar	Character that enables synonym searching for a search term; see Redefining Search Operators.
setTempFileDir	Directory to use for temporary files.
setTextFieldsFile	Name of the file containing rules for extraction of field data from text files based on markers in the next
setTextFlags	TextFlags value specifying options for text processing during indexing.
setTitleSize	By default, the dtSearch Engine collects the first 80 characters of text from a file for the title associated with each document. Use this option to change the number of characters stored, up to a maximum of 512.
setUnicodeFilterBlockSize	Specifies how each input file is divided into blocks before being filtered.
setUnicodeFilterFlags	Flags controlling the behavior of the Unicode Filtering algorithm.
setUnicodeFilterRanges	Specifies the Unicode subranges that the filtering algorithm should look for.
setUpdateFiles	Set to true to force all configuration files to be re-read when save() is called.
setUserThesaurusFile	User-defined synonym sets.
setWeightChar	Character used to indicate term weighting (example: apple:5); see Redefining Search Operators.
setXmlIgnoreTags	Comma-separated list of tags to ignore when indexing XML

Remarks

After changing settings, call save() to apply your changes, or they will have no effect. See "Options Overview" in the Overviews section for a description of the purpose of each option setting.

When an Options object is first created, it is populated with the settings currently in effect. After you change one or more settings, call Save() to apply the changes. The new settings will apply to the currently-executing thread and to any newly-created threads. It will not affect other threads that are already running.

Options cannot be changed within a callback function such as DataSource.getNextDoc. This is because dtSearch assumes that the options in effect for a thread at the start of a job will remain in effect until that job completes.

Class Hierarchy

com.dtsearch.engine.Options