Links
dtSearch Text Retrieval Engine -- Java API
Options Class
Classes | Legend | Members | Methods
Class Hierarchy
public class Options;
File

Options.java

Description

The Options object enables you to specify how the dtSearch engine will process text being indexed or searched. After changing settings, call save() to apply your changes, or they will have no effect.

Group
Methods
Method 
Description 
get 
Get option settings currently in effect 
Stemming rules for stemming searches (default: "stemming.dat") 
TextFlags value with text-processing options 
Indicates Unicode ranges that are of interest when filtering. 
save 
Applies changes to option settings 
Name of dtSearch alphabet file to use when parsing text into words. 
BinaryFilesSettings value specifying the treatment of files that do not appear to be documents. 
Define characters considered to be text if Options.setBinaryFiles is set to dtsoFilterBinary 
Use to replace the default connectors used in search requests. 
FieldFlags value that controls indexing of metadata 
Name of the file containing a table of filename patterns for file formats that dtSearch cannot detect automatically, such as older versions of WordStar 
Character that enables fuzzy searching for a search term (default "%") 
Directory where the dtSearch Engine and support files are located. 
HyphenSettings value controlling the treatment of hyphens in text. 
If false, any word that begins with a digit will not be indexed. 
Obsolete 
Character that indicates that a search term is a macro (default "@") 
Wildcard character that matches a single digit (default: none) 
Maximum size of a single stored field. Store fields are field data collected during indexing that is returned in search results. 
Words longer than the maxWordLength will be truncated when indexing. The default maxWordLength is 32. The maximum value is 128. 
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. 
List of noise words to skip during indexing (default: "noise.dat") 
Character that enables phonic searching for a search term (default "#") 
A directory that the dtSearch Engine can use to store temporary files. Most applications should not set PrivateDir. 
File segmentation rules, used to split up long text files into logical subdocuments during indexing. 
Character that enables stemming for a search term. 
Stemming rules for stemming searches (default: "stemming.dat") 
Character that enables synonym searching for a search term. 
Name of the file containing rules for extraction of field data from text files based on markers in the next 
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. 
Specifies how each input file is divided into blocks before being filtered. 
Flags controlling the behavior of the Unicode Filtering algorithm. 
Set to true to force all configuration files to be re-read when save() is called. 
User-defined synonym sets. 
Character used to indicate term weighting (example: apple:5) 
Comma-separated list of tags to ignore when indexing XML 
Legend
 
Method 
Links
You are here: Classes > Options Class
Copyright (c) 1998-2008 dtSearch Corp. All rights reserved.