Class FileDictionary

Dictionary represented by a text file.

Format allowed: 1 entry per line:

An entry can be:

  1. suggestion
  2. suggestion Lucene.Net.Search.Suggest.FileDictionary.fieldDelimiter weight
  3. suggestion Lucene.Net.Search.Suggest.FileDictionary.fieldDelimiter weight Lucene.Net.Search.Suggest.FileDictionary.fieldDelimiter payload
where the default Lucene.Net.Search.Suggest.FileDictionary.fieldDelimiter is DEFAULT_FIELD_DELIMITER (a tab)

NOTE:

  1. In order to have payload enabled, the first entry has to have a payload
  2. If the weight for an entry is not specified then a value of 1 is used
  3. A payload cannot be specified without having the weight specified for an entry
  4. If the payload for an entry is not specified (assuming payload is enabled) then an empty payload is returned
  5. An entry cannot have more than two Lucene.Net.Search.Suggest.FileDictionary.fieldDelimiters

Example:

word1 word2 TAB 100 TAB payload1

word3 TAB 101

word4 word3 TAB 102

Inheritance
System.Object
FileDictionary
Assembly: Lucene.Net.Suggest.dll
Syntax
public class FileDictionary : object, IDictionary

Constructors

Name Description
FileDictionary(Stream)

Creates a dictionary based on an inputstream. Using DEFAULT_FIELD_DELIMITER as the field seperator in a line.

NOTE: content is treated as UTF-8

FileDictionary(Stream, String)

Creates a dictionary based on an inputstream. Using fieldDelimiter to seperate out the fields in a line.

NOTE: content is treated as UTF-8

FileDictionary(TextReader)

Creates a dictionary based on a reader. Using DEFAULT_FIELD_DELIMITER as the field seperator in a line.
FileDictionary(TextReader, String)

Creates a dictionary based on a reader. Using fieldDelimiter to seperate out the fields in a line.

Fields

Name Description
DEFAULT_FIELD_DELIMITER

Tab-delimited fields are most common thus the default, but one can override this via the constructor

Methods

Name Description
GetEntryIterator()

Extension Methods