package
keyword
Type Members
-
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
-
case class
KeywordResult(word: String, wordMatch: WordMatch, score: Double, additionalFields: Map[String, String]) extends Product with Serializable
-
case class
KeywordResults(results: List[KeywordResult], total: Long, maxScore: Double) extends Product with Serializable
-
trait
WordMatch extends AnyRef
-
case class
WordMatched(pre: String, matched: String, post: String) extends WordMatch with Product with Serializable
-
case class
WordNonMatch(word: String) extends WordMatch with Product with Serializable
KeywordIndexing allows the automatic generation of another index specifically for keyword searching without duplicates.
the Lucene instance to apply to
the directory name to derive the storage location from the existing index
the function that extracts the words from the DocumentBuilder for inclusion
a list of additional fields to include from the DocumentBuilder during indexing
a list of exclusion words not to be indexed
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.
removes any of these characters found at the end of the keyword. Primarily useful for removing punctuation. Defaults to ",.?!;".
the minimum length of keywords to be included. defaults to 2.