Description of Configurable properties of Terrier |
Terrier allows the user to configure many different aspects of the framework, in order to be adaptable to the specific needs of different applications. Here, we describe the properties that are used while indexing or retrieving. A sample of how to set up the basic properties can be found in etc/terrier.properties.sample. This page contains many of the properties in Terrier, broken down by category: General, Indexing, Retrieval, Desktop Search and Miscellaneous.
| Property | string.use_utf |
| Used in | uk.ac.gla.terrier.utility.ApplicationSetup |
| Possible values | true,false |
| Default value | true |
| Configures | Enables/Disables UTF support during indexing. |
| Property | terrier.setup |
| Used in | uk.ac.gla.terrier.utility.ApplicationSetup |
| Possible values | Absolute directory path |
| Default value | not specified |
| Configures | Specifies where Terrier finds the terrier.properties file, which is usually in the etc/ directory. Analogous to terrier.etc property |
| Property | terrier.home |
| Used in | uk.ac.gla.terrier.utility.ApplicationSetup |
| Possible values | Absolute directory path |
| Default value | not specified |
| Configures | ApplicationSetup.TERRIER_HOME. Where Terrier is installed. |
| Property | terrier.etc |
| Used in | uk.ac.gla.terrier.utility.ApplicationSetup |
| Possible values | Absolute directory path |
| Default value | TERRIER_HOME + "etc/" |
| Configures | TERRIER_ETC. Where terrier finds it's terrier.properties file if -Dterrier.setup is not specified |
| Property | terrier.share |
| Used in | uk.ac.gla.terrier.utility.ApplicationSetup, uk.ac.gla.terrier.terms.Stopwords |
| Possible values | Absolute directory path |
| Default value | TERRIER_HOME + "share/" |
| Configures | ApplicationSetup.TERRIER_SHARE. Where static distribution files are found, for instance the stopword files. |
| Property | terrier.var |
| Used in | uk.ac.gla.terrier.utility.ApplicationSetup, uk.ac.gla.terrier.applications.desktop.filehandling.WindowsFileOpener, uk.ac.gla.terrier.structures.Index |
| Possible values | Absolute directory path |
| Default value | TERRIER_HOME + "var/" |
| Configures | TERRIER_VAR. Where Terrier puts files that it creates, e.g. indices and results files. |
| Property | terrier.index.path |
| Used in | uk.ac.gla.terrier.utility.ApplicationSetup, uk.ac.gla.terrier.indexing.SimpleFileCollection, uk.ac.gla.terrier.indexing.TRECCollection |
| Possible values | fully path of a directory |
| Default value | TERRIER_VAR + "index/" |
| Configures | TERRIER_INDEX_PATH. The name of the directory in which the data structures created by Terrier are stored |
| Property | terrier.index.prefix |
| Used in | uk.ac.gla.terrier.utility.ApplicationSetup, uk.ac.gla.terrier.indexing.Indexer |
| Possible values | Filename prefix for all the indices |
| Default value | "data" |
| Configures | TERRIER_INDEX_PREFIX. Filename prefix for all the indices. |
| Property | stopwords.filename |
| Used in | uk.ac.gla.terrier.terms.Stopwords |
| Possible values | absolute path to file |
| Default value | TERRIER_SHARE + "stopword-list.txt" |
| Configures | The name of the file which contains a list of stopwords. |
| Property | collection.spec |
| Used in | uk.ac.gla.terrier.utility.ApplicationSetup, uk.ac.gla.terrier.indexing.SimpleFileCollection, uk.ac.gla.terrier.indexing.TRECCollection |
| Possible values | Absolute filename |
| Default value | TERRIER_ETC + value of "collection.spec" |
| Configures | COLLECTION_SPEC. Where the indexing process should find it's configuration for the Collection object. This is often a list of files or directories. |
| Property | ignore.empty.documents |
| Used in | uk.ac.gla.terrier.utility.ApplicationSetup, uk.ac.gla.terrier.indexing.Indexer |
| Possible values | true, false |
| Default value | false |
| Configures | IGNORE_EMPTY_DOCUMENTS. Whether empty documents have an entry in the document index. |
| Property | ???.process |
| Used in | uk.ac.gla.terrier.utility.TagSet |
| Possible values | Comma delimited list of tags to process |
| Default value | not specified |
| Configures | For many of the tokenisers, configures which tags should be processed. ??? can be TrecDocTags or TrecQueryTags, to configure the TREC Collection and Query parsers respectively. ??? as FieldTags specifies the field that should be stored in the index. |
| Property | ???.skip |
| Used in | uk.ac.gla.terrier.utility.TagSet |
| Possible values | Comma delimited list of tags to not process |
| Default value | not specified |
| Configures | For many of the tokenisers, configures which tags should be skipped completely. ??? can be TrecDocTags or TrecQueryTags, to configure the TREC Collection and Query parsers respectively. |
| Property | ???.doctag |
| Used in | uk.ac.gla.terrier.utility.TagSet |
| Possible values | Name of tag that marks the start of the document (trec only) |
| Default value | not specified |
| Configures | For some of the tokenisers, configures which tag which contains the opening tag (or query ID). ??? can be TrecDocTags or TrecQueryTags, to configure the TREC Collection and Query parsers respectively. |
| Property | ???.idtag |
| Used in | uk.ac.gla.terrier.utility.TagSet |
| Possible values | Name of tag that contains the unique identifier (trec only) |
| Default value | not specified |
| Configures | For some of the tokenisers, configures which tag which contains the document ID (or query ID). ??? can be TrecDocTags or TrecQueryTags, to configure the TREC Collection and Query parsers respectively. |
| Property | ???.casesensitive |
| Used in | uk.ac.gla.terrier.utility.TagSet uk.ac.gla.terrier.indexing.TRECCollection |
| Possible values | true or false |
| Default value | true for TrecDocTags, false otherwise |
| Configures | For some of the tokenisers, configures if the tag matching is case-sensitive or not. The default is true for TRECCollection (TrecDocTags), and false for FieldTags and TrecQueryTags (TRECFullTokenizer which is used by the TREC query parser (TRECQuery)). |
| Property | block.indexing |
| Used in | uk.ac.gla.terrier.utility.ApplicationSetup, uk.ac.gla.terrier.applications.TRECIndexing |
| Possible values | true, false |
| Default value | false |
| Configures | ApplicationSetup.BLOCK_INDEXING. Sets whether block positions should be saved during indexing. This is required to do phrasal searches. Client code should examine this to determine whether to use the BasicIndexer or the BlockIndexer. |
| Property | block.size |
| Used in | uk.ac.gla.terrier.utility.ApplicationSetup, uk.ac.gla.terrier.indexing.BlockIndexer |
| Possible values | integer > 0 |
| Default value | 1 |
| Configures | ApplicationSetup.BLOCK_SIZE. The number of terms contained in the same block |
| Property | max.blocks |
| Used in | uk.ac.gla.terrier.utility.ApplicationSetup, uk.ac.gla.terrier.indexing.BlockIndexer |
| Possible values | integer >= 0 |
| Default value | 100000 |
| Configures | MAX_BLOCKS. The maximum number of blocks a document may contain. |
| Property | lowercase |
| Used in | uk.ac.gla.terrier.indexing.HTMLDocument, uk.ac.gla.terrier.indexing.TRECDocument, uk.ac.gla.terrier.indexing.TRECFullTokenizer |
| Possible values | true, or false |
| Default value | true |
| Configures | Whether text is converted to lowercase before parsing |
| Property | indexing.max.tokens |
| Used in | uk.ac.gla.terrier.indexing.Indexer |
| Possible values | integer >=0 |
| Default value | 0 |
| Configures | Sets a limit to the maximum number of tokens indexed for a document. The default value 0 means that there is no limit. |
| Property | indexing.max.docs.per.builder |
| Used in | uk.ac.gla.terrier.indexing.Indexer |
| Possible values | integer >=0 |
| Default value | 18,000,000 |
| Configures | Sets a limit to the maximum number of documents in one index during indexing. After this point, a new index will be created, and at the end, all the indices will be merged. Reasoning: During classical two-pass indexing, memory is constrained by the TermCodes table. If too many different unique terms are indexed, then an OutOfMemoryError will occur. For TREC GOV2 collection, 18 million documents is a good point to start a new index. The special value 0 means that there is no limit. This property also applies for single-pass indexing, although it can be safely set higher. |
| Property | termpipelines |
| Used in | uk.ac.gla.terrier.querying.Manager, uk.ac.gla.terrier.indexing.Indexer |
| Possible values | Comma delimited list of term pipeline entities to pass query terms through. Use blank to denote no termpipeline objects |
| Default value | Stopwords,PorterStemmer |
| Configures | Defines which term pipeline entities to pass query terms through. |
| Property | termcodes.initialcapacity |
| Used in | uk.ac.gla.terrier.utility.TermCodes |
| Possible values | integer value > 0 |
| Default value | 3000000 |
| Configures | Specifes the initial size of the hashmap used for the term->term_id mapping. Setting this appropriately decreases the likelihood of a hashmap grow occurring |
| Property | invertedfile.processterms |
| Used in | uk.ac.gla.terrier.structures.indexing.InvertedIndexBuilder, uk.ac.gla.terrier.structures.indexing.BlockInvertedIndexBuilder |
| Possible values | Integer value > 0 |
| Default value | 75000 |
| Configures | Defines the number of terms that should be processed at once when
building the inverted index. The InvertedIndexBuilder scans the direct index
looking for each of these term, then writes them to inverted index, then
repeats scan for next bunch of terms. Increasing this speeds up inverted
index building for large collections, but uses more memory. Decrease this
if you encounter OutOfMemory errors while building the inverted index.
Deprecated: This option has been deprecated in favour of invertedfile.processpointers For this property to have any effect, invertedfile.processpointers must be set to 0. |
| Property | invertedfile.processpointers |
| Used in | uk.ac.gla.terrier.structures.indexing.InvertedIndexBuilder, uk.ac.gla.terrier.structures.indexing.BlockInvertedIndexBuilder |
| Possible values | Integer value > 0 |
| Default value | 20000000 |
| Configures | Defines the number of pointers that should be processed at once when
building the inverted index. The InvertedIndexBuilder first works out how many terms
correspond to that many pointers, then scans the direct index
looking for each of these term, then writes them to inverted index, then
repeats scan for next bunch of terms. Increasing this speeds up inverted
index building for large collections, but uses more memory. Decrease this
if you encounter OutOfMemory errors while building the inverted index.
Note that for block indexing, the default is lower: 2,000,000 pointers.
This option supersedes invertedfile.processterms. For the invertedfile.processterms strategy to be used, set invertedfile.processpointers to 0. |
| Property | lexicon.builder.templexperdir |
| Used in | uk.ac.gla.terrier.structures.indexing.LexiconBuilder, uk.ac.gla.terrier.structures.indexing.BlockLexiconBuilder |
| Possible values | integer values > 0 |
| Default value | 100 |
| Configures | Number of temporary lexicon files to place in each temporary directory during lexicon building. |
| Property | lexicon.builder.merge.lex.max |
| Used in | uk.ac.gla.terrier.structures.indexing.LexiconBuilder, uk.ac.gla.terrier.structures.indexing.BlockLexiconBuilder |
| Possible values | integer values > 1 |
| Default value | 16 |
| Configures | The number of temporary lexicons to merge at once during indexing. during lexicon building. Bigger is generally faster, but too many open file-handles causes slowness. 16 is a good trade-off. (See also the MERGE_FACTOR in GNU sort source code). |
| Property | lexicon.builder.merge.2lex.attime |
| Used in | uk.ac.gla.terrier.structures.indexing.LexiconBuilder, uk.ac.gla.terrier.structures.indexing.BlockLexiconBuilder |
| Possible values | boolean values true or false |
| Default value | false |
| Configures | Forces the temporary lexicon merging to revert to Terrier 1.0.x behaviour of merging lexicons in pairs. Deprecated This option will be removed in a future release |
| Property | indexing.excel.maxfilesize.mb |
| Used in | uk.ac.gla.terrier.indexing.MSExcelDocument |
| Possible values | size of a file in megabytes |
| Default value | 0.5 |
| Configures | The maximum file size of an Excel spreadsheet to be parsed. |
| Property | indexing.simplefilecollection.extensionsparsers |
| Used in | uk.ac.gla.terrier.indexing.SimpleFileCollection |
| Possible values | comma delimited list of file extensions and associated parsers to use for the corresponding files. |
| Default value | txt:FileDocument,text:FileDocument,tex:FileDocument,bib:FileDocument, pdf:PDFDocument,html:HTMLDocument,htm:HTMLDocument,xhtml:HTMLDocument, xml:HTMLDocument,doc:MSWordDocument,ppt:MSPowerpointDocument,xls:MSExcelDocument |
| Configures | The parsers to be used for processing files with the specified extensions. |
| Property | indexing.simplefilecollection.defaultparser |
| Used in | uk.ac.gla.terrier.indexing.SimpleFileCollection |
| Possible values | fully qualified class name |
| Default value | not specified |
| Configures | The parser to use by default for processing files with unknown extensions |
| Property | trec.blacklist.docids |
| Used in | uk.ac.gla.terrier.indexing.TRECCollection |
| Possible values | full path to filename |
| Default value | not specified |
| Configures | The name of a file that contains a black list of document identifiers to be ignored during indexing |
| Property | trec.collection.class |
| Used in | uk.ac.gla.terrier.applications.TRECIndexing |
| Possible values | a classname implementing Collection interface |
| Default value | TRECCollection |
| Configures | The Collection object to be used to parse the collection. This allows test collection similar but not identical to TREC to be parsed using Terrier's TREC tools. New in Terrier 1.1.0 is the ability to chain Collections. The Collection specified last is the inner-most one of the chain, the first is the outer-most (i.e. instantiation right-to-left). the first collection should have a default constructor (no arguments), while the other collections should take as argument in their constructor the inner-collection class. E.g. trec.collection.class=RemoveSmallDocsCollection,TRECCollection. Instantiation handled by the CollectionFactory class. |
| Property | merge.temp.number |
| Used in | uk.ac.gla.terrier.utility.ApplicationSetup |
| Possible values | Integer values > 0 |
| Default value | 100000 |
| Configures | MERGE_TEMP_NUMBER. Used in temporary lexicon building by the classical two-pass indexers. |
| Property | bundle.size |
| Used in | uk.ac.gla.terrier.utility.ApplicationSetup |
| Possible values | Integer values > 0 |
| Default value | 2000 |
| Configures | BUNDLE_SIZE. During indexing, number of documents to be processed before a new index is created. |
| Property | max.term.length |
| Used in | uk.ac.gla.terrier.utility.ApplicationSetup, uk.ac.gla.terrier.indexing.FileDocument, uk.ac.gla.terrier.indexing.HTMLDocument, uk.ac.gla.terrier.indexing.TRECDocument, uk.ac.gla.terrier.indexing.TRECFullTokenizer, uk.ac.gla.terrier.structures.Lexicon, uk.ac.gla.terrier.structures.BlockLexicon, uk.ac.gla.terrier.structures.BlockLexiconInputStream, uk.ac.gla.terrier.structures.BlockLexiconOutputStream, uk.ac.gla.terrier.structures.LexiconInputStream, uk.ac.gla.terrier.structures.LexiconOutputStream |
| Possible values | Integer value > 0 |
| Default value | 20 |
| Configures | MAX_TERM_LENGTH. The size in the lexicon reserved for a string, i.e. the max length of any term in the index. term. |
| Property | docno.byte.length |
| Used in | uk.ac.gla.terrier.utility.ApplicationSetup, uk.ac.gla.terrier.structures.DocumentIndex, uk.ac.gla.terrier.structures.DocumentIndexEncoded, uk.ac.gla.terrier.structures.DocumentIndexInMemory, uk.ac.gla.terrier.structures.DocumentIndexInputStream, |
| Possible values | Integer value > 0 |
| Default value | 20 |
| Configures | DOCNO_BYTE_LENGTH. The size in the document index reserved for the document number - i.e. no DOCNO can be longer than this. Set this property to 30 for the TREC Blogs06 collection. |
| Property | merge.prefix |
| Used in | uk.ac.gla.terrier.utility.ApplicationSetup |
| Possible values | part of a filename |
| Default value | "MRG_" |
| Configures | MERGE_PREFIX. Prefix of temporary lexicon files created during merging |
| Property | memory.reserved |
| Used in | uk.ac.gla.terrier.indexing.BasicSinglePassIndexer |
| Possible values | integer > 0, probably around 50 million |
| Default value | 50000000 |
| Configures | Free memory threshold that forces a run to be committed to disk in the single-pass indexer. Higher values means less chance of OutOfMemoryError occurring, but slower indexing speed as more runs will be generated. |
| Property | memory.heap.usage |
| Used in | uk.ac.gla.terrier.indexing.BasicSinglePassIndexer |
| Possible values | positive float, range 0.0f - 1.0f |
| Default value | 0.70 |
| Configures | amount of max heap allocated to JVM before a run is committed. Smaller values mean more runs and hence slower indexing. Larger values means more risk of OutOfMemoryError occurrences. |
| Property | docs.check |
| Used in | uk.ac.gla.terrier.indexing.BasicSinglePassIndexer |
| Possible values | positive integer > 0 |
| Default value | 20 |
| Configures | how often to check the amount of free memory. Lower values gives more protection from OutOfMemoryError. |
| Property | inverted2direct.processtokens |
| Used in | uk.ac.gla.terrier.structures.indexing.singlepass.Inverted2DirectIndexBuilder |
| Possible values | positive long > 0 |
| Default value | 100000000, 10000000 for blocks |
| Configures | total number of tokens to attempt each iteration of building the direct index. Use a lower value if OutOfMemoryError occurs. |
| Property | language.model |
| Used in | uk.ac.gla.terrier.applications.TRECLMIndexing, uk.ac.gla.terrier.applications.TRECLMQuerying |
| Possible values | Class names of implemented language models from the package uk.ac.gla.terrier.matching.models.languagemodel |
| Default value | PonteCroft |
| Configures | the language model to be used for indexing and querying the collection. Querying requires collection to have been indexed for language modelling. |
| Property | ignore.low.idf.terms |
| Used in | uk.ac.gla.terrier.matching.Matching, uk.ac.gla.terrier.matching.LMMatching |
| Possible values | true, false |
| Default value | true |
| Configures | Ignores a term that has a low IDF, ie appears in many documents. You may wish to turn this off for small or focused collections. |
| Property | interactive.output.format.length |
| Used in | uk.ac.gla.terrier.applications.InteractiveQuerying |
| Possible values | integer number > 0 |
| Default value | 1000 |
| Configures | the maximum number of results to be displayed for Interactive querying |
| Property | trec.model |
| Used in | uk.ac.gla.terrier.applications.TRECQuerying |
| Possible values | Name of weighting models |
| Default value | <empty> |
| Configures | The weighting model to use during retrieval. If not set, then TRECQuerying iterates through the models found in the trec.models file. |
| Property | trec.models |
| Used in | uk.ac.gla.terrier.utility.ApplicationSetup |
| Possible values | Absolute filename |
| Default value | TERRIER_ETC + value of "trec.models" |
| Configures | TREC_MODELS. What is the location of the file that contains the list of Weighting models to query with |
| Property | trec.results |
| Used in | uk.ac.gla.terrier.utility.ApplicationSetup, TrecTerrier |
| Possible values | Absolute directory path |
| Default value | TERRIER_VAR + value of "trec.results"" |
| Configures | TREC_RESULTS. Where TREC*Querying applications should store their results files and where evaluation files should be placed. |
| Property | trec.topics.list |
| Used in | uk.ac.gla.terrier.utility.ApplicationSetup, uk.ac.gla.terrier.structures.TRECQuery |
| Possible values | Absolute filename |
| Default value | TERRIER_ETC + value of "trec.topics.list" |
| Configures | TREC_TOPICS_LIST. Contains file with list of TREC topics (queries) files to run. |
| Property | trec.qrels |
| Used in | uk.ac.gla.terrier.utility.ApplicationSetup |
| Possible values | Absolute filename |
| Default value | TERRIER_ETC + "trec.qrels" |
| Configures | TREC_QRELS. Contains file with list of TREC qrel files to evaluate with |
| Property | trec.output.format.length |
| Used in | uk.ac.gla.terrier.applications.TRECQuerying, uk.ac.gla.terrier.applications.TRECQueryingExpansion, uk.ac.gla.terrier.applications.TRECLMQuerying |
| Possible values | integer number > 0 |
| Default value | 1000 |
| Configures | the maximum number of results to be displayed for TREC querying |
| Property | trec.iteration |
| Used in | uk.ac.gla.terrier.applications.TRECQuerying, uk.ac.gla.terrier.applications.TRECQueryingExpansion, uk.ac.gla.terrier.applications.TRECLMQuerying |
| Possible values | String |
| Default value | Q |
| Configures | Related to standard format of TREC results |
| Property | trec.matching |
| Used in | uk.ac.gla.terrier.applications.TRECQuerying, uk.ac.gla.terrier.applications.TRECQueryingExpansion, |
| Possible values | String, Class name in uk.ac.gla.terrier.matching |
| Default value | Matching |
| Configures | The Matching class to use during querying |
| Property | trec.manager |
| Used in | uk.ac.gla.terrier.applications.TRECQuerying, uk.ac.gla.terrier.applications.TRECQueryingExpansion, |
| Possible values | String, Class name in uk.ac.gla.terrier.querying |
| Default value | Manager |
| Configures | The Manager class to use during querying |
| Property | parameter.free.expansion |
| Used in | uk.ac.gla.terrier.matching.models.queryexpansion.QueryExpansionModel, uk.ac.gla.terrier.structures.ExpansionTerms |
| Possible values | true or false |
| Default value | true |
| Configures | Whether we apply parameter-free query expansion or not. |
| Property | rocchio_beta |
| Used in | uk.ac.gla.terrier.matching.models.queryexpansion.QueryExpansionModel, uk.ac.gla.terrier.structures.ExpansionTerms |
| Possible values | float |
| Default value | 0.4 |
| Configures | The parameter of Rocchio's automatic query expansion |
| Property | expansion.models |
| Used in | uk.ac.gla.terrier.matching.models.queryexpansion.QueryExpansionModel, uk.ac.gla.terrier.structures.ExpansionTerms |
| Possible values | File name,relative File path, absolute File path |
| Default value | qemodels |
| Configures | The name of the file which contains the query expansion methods used. The corresponding property is expansion.models and the default value is qemodels. If a relative path is given, it is prefixed with TERRIER_ETC. |
| Property | expansion.documents |
| Used in | uk.ac.gla.terrier.matching.models.queryexpansion.QueryExpansionModel, uk.ac.gla.terrier.structures.ExpansionTerms |
| Possible values | integer |
| Default value | 3 |
| Configures | The number of top-ranked documents to be considered in the pseudo relevance set |
| Property | expansion.terms |
| Used in | uk.ac.gla.terrier.matching.models.queryexpansion.QueryExpansionModel, uk.ac.gla.terrier.structures.ExpansionTerms |
| Possible values | integer |
| Default value | 10 |
| Configures | The number of the highest weighted terms from the pseudo relevance set to be added to the original query. There can be overlap between the original query terms and the added terms from the pseudo relevance set |
| Property | expansion.mindocuments |
| Used in | uk.ac.gla.terrier.structures.ExpansionTerms |
| Possible values | integer |
| Default value | 2 |
| Configures | The minimum number of documents a term must exist in before it can be considered to be informative. Defaults to 2. For more information, see Giambattista Amati: Information Theoretic Approach to Information Extraction. FQAS 2006: 519-529 DOI 10.1007/11766254_44 |
| Property | match.empty.query |
| Used in | uk.ac.gla.terrier.matching.Matching, uk.ac.gla.terrier.matching.LMMatching |
| Possible values | true, false |
| Default value | true |
| Configures | If true, return all documents for an empty query. Use this if you have post filter/processes to filter out the documents. E.g. link: site: etc |
| Property | querying.allowed.controls |
| Used in | uk.ac.gla.terrier.querying.Manager |
| Possible values | Comma delimited list of which controls are allowed to be specified on the query. For use in interactive querying. |
| Default value | c, range |
| Configures | Comma delimited list of which controls are allowed to be specified on the query. For use in interactive querying. "String:String" in the query are assumed to be fields unless the first string is an allowed control. An example value would be: c, range, link, site. |
| Property | querying.default.controls |
| Used in | uk.ac.gla.terrier.querying.Manager |
| Possible values | Comma delimited list of control names and values. Names and values are separated by colon. |
| Default value | not specified |
| Configures | Sets the defaults control values for the querying process. Controls are used to control the querying process, and may be used to set matching models, post filters post processes etc. An example value would be: c:10,site:gla.ac.uk |
| Property | querying.postprocesses.order |
| Used in | uk.ac.gla.terrier.querying.Manager |
| Possible values | Comma delimited list of all allowed post processes. |
| Default value | not specified |
| Configures | Specifies the order in which post processes may be be called, and those that may be called. This is because post processes often have inter-dependencies. An example value would be: QueryExpansion,Scope,Site |
| Property | querying.postprocesses.controls |
| Used in | uk.ac.gla.terrier.querying.Manager |
| Possible values | Comma and colon delimited list of control names and post process names. |
| Default value | not specified |
| Configures | Specifies which controls enable which post processes. An example value would be: site:Site,qe:QueryExpansion,scope:Scope |
| Property | querying.postfilters.order |
| Used in | uk.ac.gla.terrier.querying.Manager |
| Possible values | Comma delimited list of all allowed post filters. |
| Default value | not specified |
| Configures | Specifies the order in which post filters may be be called, and those that may be called. This is because post filters often have inter-dependencies. An example value would be: LinkFilter |
| Property | querying.postfilters.controls |
| Used in | uk.ac.gla.terrier.querying.Manager |
| Possible values | Comma and colon delimited list of control names and post filter names. |
| Default value | not specified |
| Configures | Specifies which controls enable which post filters. An example value would be: link:LinkFilter |
| Property | matching.dsms |
| Used in | uk.ac.gla.terrier.matching.Matching, uk.ac.gla.terrier.matching.LMMatching |
| Possible values | Comma delimited names of classes in uk/ac/gla/terrier/matching/dsms, or other fully qualified models |
| Default value | not specified |
| Configures | Specifies the static uk.ac.gla.terrier.matching.dsms.DocumentScoreModifiers that should be applied to all terms of all queries. |
| Property | matching.tsms |
| Used in | uk.ac.gla.terrier.matching.Matching, uk.ac.gla.terrier.matching.LMMatching |
| Possible values | Comma delimited names of classes in uk/ac/gla/terrier/matching/tsms, or other fully qualified models |
| Default value | not specified |
| Configures | Specifies the static uk.ac.gla.terrier.matching.dsms.DocumentScoreModifiers that should be applied for all queries |
| Property | matching.retrieved_set_size |
| Used in | uk.ac.gla.terrier.matching.Matching, uk.ac.gla.terrier.matching.LMMatching |
| Possible values | integer values > 0 |
| Default value | 1000 |
| Configures | Maximum size of the result set. |
| Property | frequency.upper.threshold |
| Used in | uk.ac.gla.terrier.matching.Matching, uk.ac.gla.terrier.matching.LMMatching |
| Possible values | integer values >= 0 |
| Default value | 0 |
| Configures | Sets a maximum value for the document frequency of any term in a document. (Term spam prevention). 0 means no threshold. |
| Property | desktop.file.associations |
| Used in | uk.ac.gla.terrier.applications.desktop.filehandling.AssociationFileOpener |
| Possible values | absolute path to filename |
| Default value | TERRIER_VAR/desktop.fileassoc |
| Configures | the name of the file in which we save the file type associations with applications. If no absolute path is specified it will be presumed by TERRIER_HOME/var |
| Property | desktop.indexing.singlepass |
| Used in | uk.ac.gla.terrier.applications.desktop.DesktopTerrier |
| Possible values | true, false |
| Default value | false |
| Configures | Whether single-pass indexing is used by in the Desktop Terrier. |
| Property | desktop.directories.filelist |
| Used in | uk.ac.gla.terrier.applications.desktop.DesktopTerrier |
| Possible values | absolute path to filename |
| Default value | TERRIER_VAR\index\data.filelist |
| Configures | the name of the file in which we list all files that have been indexed |
| Property | field.modifiers |
| Used in | uk.ac.gla.terrier.utility.FieldScore |
| Possible values | List of double values, comma separated |
| Default value | not specified |
| Configures | Boosts the score assigned to these terms by the given amount when it occurs in the field of the same place |
| Property | termcodes.garbagecollect |
| Used in | uk.ac.gla.terrier.utility.TermCodes |
| Possible values | true, false |
| Default value | true |
| Configures | If true, forces a full Java garbage collection to reclaim memory once the direct index creation has finished, as the hashmap is then no longer required. |
| Property | trec.collection.pointers |
| Used in | uk.ac.gla.terrier.indexing.TRECCollection |
| Possible values | full path to filename |
| Default value | TERRIER_INDEX_PATH + "docpointers.col" | Configures | The name of a file that saves pointers for each file to the original text in the collection files. |
Copyright © 2015 University of Glasgow | All Rights Reserved
