KeywordIndexing

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.

Linear Supertypes

Serializable, Serializable, Product, Equals, LuceneListener, AnyRef, Any

Instance Constructors

new 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)

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.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val allowedCharacters: String

a String containing all the characters allowed.
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.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def commit(): Unit

Definition Classes
KeywordIndexing → LuceneListener
def delete(): Unit

Definition Classes
KeywordIndexing → LuceneListener
val directoryName: String

the directory name to derive the storage location from the existing index
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val includeFields: List[Field[_]]

a list of additional fields to include from the DocumentBuilder during indexing
def index(words: List[String], additionalValues: List[FieldAndValue[_]]): Unit
def indexed(builder: DocumentBuilder): Unit

Definition Classes
KeywordIndexing → LuceneListener
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val lucene: Lucene

the Lucene instance to apply to
val minimumLength: Int

the minimum length of keywords to be included.
the minimum length of keywords to be included. defaults to 2.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val removeEndsWithCharacters: String

removes any of these characters found at the end of the keyword.
removes any of these characters found at the end of the keyword. Primarily useful for removing punctuation. Defaults to ",.?!;".
def search(queryString: String = "", limit: Int = 10): KeywordResults
val stopWords: Set[String]

a list of exclusion words not to be indexed
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
val wordsFromBuilder: (DocumentBuilder) ⇒ List[String]

the function that extracts the words from the DocumentBuilder for inclusion

Related Docs: object KeywordIndexing | package keyword

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val allowedCharacters: String

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def commit(): Unit

def delete(): Unit

val directoryName: String

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

val includeFields: List[Field[_]]

def index(words: List[String], additionalValues: List[FieldAndValue[_]]): Unit

def indexed(builder: DocumentBuilder): Unit

final def isInstanceOf[T0]: Boolean

val lucene: Lucene

val minimumLength: Int

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val removeEndsWithCharacters: String

def search(queryString: String = "", limit: Int = 10): KeywordResults

val stopWords: Set[String]

final def synchronized[T0](arg0: ⇒ T0): T0

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

val wordsFromBuilder: (DocumentBuilder) ⇒ List[String]

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from LuceneListener

Inherited from AnyRef

Inherited from Any

Ungrouped