keyword

Type Members

1. case class KeywordIndexing(lucene: Lucene, directoryName: String, wordsFromBuilder: (DocumentBuilder) ⇒ List[String] = ..., includeFields: List[Field[_]] = Nil, stopWords: Set[String] = KeywordIndexing.DefaultStopWords, allowedCharacters: String = ..., removeEndsWithCharacters: String = ..., minimumLength: Int = 2) extends LuceneListener with Product with Serializable

   

   KeywordIndexing allows the automatic generation of another index specifically for keyword searching without duplicates.

   KeywordIndexing allows the automatic generation of another index specifically for keyword searching without duplicates.

   lucene

   the Lucene instance to apply to

   directoryName

   the directory name to derive the storage location from the existing index

   wordsFromBuilder

   the function that extracts the words from the DocumentBuilder for inclusion

   includeFields

   a list of additional fields to include from the DocumentBuilder during indexing

   stopWords

   a list of exclusion words not to be indexed

   allowedCharacters

   a String containing all the characters allowed. This defaults to a-z, A-Z, 0-9, period and space. Keywords are filtered to remove any characters not allowed.

   removeEndsWithCharacters

   removes any of these characters found at the end of the keyword. Primarily useful for removing punctuation. Defaults to ",.?!;".

   minimumLength

   the minimum length of keywords to be included. defaults to 2.

2. case class KeywordResult(word: String, wordMatch: WordMatch, score: Double, additionalFields: Map[String, String]) extends Product with Serializable

   

3. case class KeywordResults(results: List[KeywordResult], total: Long, maxScore: Double) extends Product with Serializable

   

4. trait WordMatch extends AnyRef

   

5. case class WordMatched(pre: String, matched: String, post: String) extends WordMatch with Product with Serializable

   

6. case class WordNonMatch(word: String) extends WordMatch with Product with Serializable