lucene

Type Members

1. case class AllDocsFilter() extends Filter with Product with Serializable

   

   Case class representing a match all docs filter.

   Case class representing a match all docs filter. This wraps Lucene's QueryWrapperFilter wrapping MatchAllDocsQuery.

2. class BitDocSet extends DocSet

   

   Class implementing DocSet using scala.collection.BitSet

3. class Doc extends AnyRef

   

   Class representing a document in the index.

   Class representing a document in the index. This holds the Lucene document id and term frequency and optionally, positions/offsets information.

4. trait DocSet extends SortedSet[Int]

   

   Trait representing DocSet.

   Trait representing DocSet. This holds Lucene Document IDs. By extending scala.collection.SortedSet, this equips all the set operations provided by Scala collection library.

5. class Document extends AnyRef

   

   Class representing a document.

   Class representing a document. This holds one or more fields.

6. class Field extends AnyRef

   

   Class representing a field attached to a Document.

   Class representing a field attached to a Document. This holds a name and one or more values.

7. class FieldInfo extends AnyRef

   

   Class representing a field.

   Class representing a field. This holds Lucene FieldInfo and Terms for the field internally.

8. case class FieldType(analyzer: Analyzer, indexed: Boolean, stored: Boolean, termVectors: Boolean = false, termPositions: Boolean = false, termOffsets: Boolean = false) extends Product with Serializable

   

   Case class representing field type

   Case class representing field type

   analyzer

   the analyzer. If given null, the field value is recognized as String

   indexed

   set true when the fields associated to this field type should be indexed

   stored

   set true when the fields associated to this field type should be stored

   termVectors

   set true when the fields associated to this field type should have a term vector

   termPositions

   set true when the fields associated to this field type should have term positions with the term vector

   termOffsets

   set true when the fields associated to this field type should have term offsets with the term vector

9. class Filter extends AnyRef

   

   Class representing a filter to get a subset of the index.

   Class representing a filter to get a subset of the index. This is a thin wrapper for Lucene Filter.

10. class IReader extends RawReader

    

    Class representing schema-aware index reader.

    Class representing schema-aware index reader. This is a RawReader with a Schema instance.

11. class ISearcher extends AnyRef

    

    Class representing a searcher for the index.

    Class representing a searcher for the index. This is a thin wrapper for Lucene IndexSearcher.

12. class IWriter extends AnyRef

    

    Class representing schema aware index writer.

    Class representing schema aware index writer. This holds a Lucene IndexWriter internally.

13. class IntDocSet extends DocSet

    

    Class implementing DocSet using scala.collection.SortedSet

14. class InvalidSchemaException extends RuntimeException

    

15. case class PosAndOffset(pos: Int, startOffset: Int, endOffset: Int, payload: String) extends Product with Serializable

    

    Case class representing a position of a term in a document.

    Case class representing a position of a term in a document. Optionally, this also holds start/end offsets and payload.

16. class RawReader extends AnyRef

    

    Class representing a index reader.

    Class representing a index reader. This holds a Lucene LeafReader internally.

17. class Schema extends AnyRef

    

    Class representing schema.

    Class representing schema. This holds a default analyzer and a field types mapping.

18. class SimpleFST extends AnyRef

    

19. class TermDocs extends Seq[Doc]

    

    Class representing sequence of document ids (and optionally, positions/offsets information) associated to given field and a term.

    Class representing sequence of document ids (and optionally, positions/offsets information) associated to given field and a term. This is a sequence of Doc instances. This holds Lucene PostingsEnum for the term internally.

20. case class TermFilter(field: String, value: String) extends Filter with Product with Serializable

    

    Case class representing a term filter.

    Case class representing a term filter. This wraps QueryWrapperFilter wrapping TermQuery.

    field

    the field name for TermQuery

    value

    the value for TermQuery

21. class TermVector extends Map[String, Doc]

    

    Class representing Term Vector for a document

22. class Terms extends Seq[TermDocs]