IReader

Instance Constructors

new IReader(path: Path, schema: Schema)

Create a new IReader instance with given index path and schema.
Create a new IReader instance with given index path and schema.
path
the path for index directory
schema
the schema

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
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

Close the index.
Close the index.

Definition Classes
RawReader
var closed: Boolean

Definition Classes
RawReader
def docCount(fName: String): Long

Returns the number of documents that have at least one term for this field, or -1 if this measure isn't stored by the codec.
Returns the number of documents that have at least one term for this field, or -1 if this measure isn't stored by the codec.
fName
the field name

Definition Classes
RawReader
def docFreq(fName: String, text: String): Int

Returns the number of documents containing the term in the given field.
Returns the number of documents containing the term in the given field.
fName
the field name
text
the string representation for the term

Definition Classes
RawReader
def document(docId: Int): Option[Document]

Returns the Document instance for the given document id.
Returns the Document instance for the given document id.
docId
the Lucene's internal document id
returns
the Document or None if the corresponding document does not exist

Definition Classes
RawReader
val dr: DirectoryReader

Definition Classes
RawReader
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def field(fName: String): Option[FieldInfo]

Returns the FieldInfo instance holding information of the field with given field name.
Returns the FieldInfo instance holding information of the field with given field name.
fName
the field name
returns
the FieldInfo instance or None if the corresponding field does not exist

Definition Classes
RawReader
lazy val fieldMap: Map[String, FieldInfo]

Definition Classes
RawReader
def fieldNames: Seq[String]

Definition Classes
RawReader
def fields: Seq[FieldInfo]

Definition Classes
RawReader
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def getAnalyzer(fName: String): Option[Analyzer]

Returns the analyzer for given field name.
Returns the analyzer for given field name.
fName
the field name
returns
the analyzer or None if the requested field does not exist
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getFieldType(fName: String): Option[FieldType]

Returns the field type for given field name.
Returns the field type for given field name.
fName
the field name
returns
the field type or None if the requested field does not exist
def getTermVector(docId: Int, fName: String): Option[TermVector]

Returns the TermVector for the given document id and field name.
Returns the TermVector for the given document id and field name.
docId
the document id
fName
the field name
returns
a new TermVector instance or None if the term vector is not stored in the index

Definition Classes
RawReader
def hasDeletions: Boolean

Returns true if any documents have been deleted.
Returns true if any documents have been deleted.

Definition Classes
RawReader
def hashCode(): Int

Definition Classes
AnyRef → Any
val ir: LeafReader

Definition Classes
RawReader
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
lazy val liveDocs: Bits

Definition Classes
RawReader
def maxDoc: Int

Returns one greater than the largest possible document number.
Returns one greater than the largest possible document number.

Definition Classes
RawReader
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def numDeletedDocs: Int

Returns the number of deleted documents.
Returns the number of deleted documents.

Definition Classes
RawReader
def numDocs: Int

Returns the number of documents in this index.
Returns the number of documents in this index.

Definition Classes
RawReader
lazy val numFields: Int

Definition Classes
RawReader
val path: Path

the path for index directory
the path for index directory

Definition Classes
RawReader
def subset(filter: Filter): DocSet

Returns index subset with given filter.
Returns index subset with given filter.
filter
the Filter instance
returns
a new DocSet instance

Definition Classes
RawReader
def sumDocFreq(fName: String): Long

Returns the sum of document frequency for all terms in this field, or -1 if this measure isn't stored by the codec.
Returns the sum of document frequency for all terms in this field, or -1 if this measure isn't stored by the codec.
fName
the field name

Definition Classes
RawReader
def sumTotalTermFreq(fName: String): Long

Returns the sum of total term frequencies for all terms in this field, or -1 if this measure isn't stored by the codec (or if this fields omits term freq and positions).
Returns the sum of total term frequencies for all terms in this field, or -1 if this measure isn't stored by the codec (or if this fields omits term freq and positions).
fName
the field name

Definition Classes
RawReader
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def termDocs(fName: String, text: String): Option[TermDocs]

Returns the TermDocs instance holding document ids (and optionally, positions/offsets information) associated to given field and term.
Returns the TermDocs instance holding document ids (and optionally, positions/offsets information) associated to given field and term.
fName
the field name
text
the string representation for the term.
returns
the TermDocs instance or None if the corresponding term does not exist

Definition Classes
RawReader
def toString(): String

Definition Classes
RawReader → AnyRef → Any
def topTermsByDocFreq(field: String, numTerms: Int = 20): Seq[(String, Int, Long)]

Returns top high frequent terms (based document frequencies) and associated frequencies.
Returns top high frequent terms (based document frequencies) and associated frequencies.
field
the field name
numTerms
max terms to be returned
returns
the Tuple of the term, document frequency, total term frequency associated to this term)

Definition Classes
RawReader
def topTermsByTotalTermFreq(field: String, numTerms: Int = 20): Seq[(String, Int, Long)]

Returns top high frequent terms (based total term frequencies) and associated frequencies.
Returns top high frequent terms (based total term frequencies) and associated frequencies.
field
the field name
numTerms
max terms to be returned
returns
the Tuple of the term, document frequency, total term frequency associated to this term)

Definition Classes
RawReader
def totalTermFreq(fName: String, text: String): Long

Returns the total number of occurrences of term across all documents.
Returns the total number of occurrences of term across all documents.
fName
the field name
text
the string representation for the term

Definition Classes
RawReader
def universalset(): DocSet

Returns whole index as DocSet.
Returns whole index as DocSet.
returns
a new DocSet instance holding all document ids in the index

Definition Classes
RawReader
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( ... )

Related Docs: object IReader | package lucene

class IReader extends RawReader

Instance Constructors

new IReader(path: Path, schema: Schema)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def close: Unit

var closed: Boolean

def docCount(fName: String): Long

def docFreq(fName: String, text: String): Int

def document(docId: Int): Option[Document]

val dr: DirectoryReader

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def field(fName: String): Option[FieldInfo]

lazy val fieldMap: Map[String, FieldInfo]

def fieldNames: Seq[String]

def fields: Seq[FieldInfo]

def finalize(): Unit

def getAnalyzer(fName: String): Option[Analyzer]

final def getClass(): Class[_]

def getFieldType(fName: String): Option[FieldType]

def getTermVector(docId: Int, fName: String): Option[TermVector]

def hasDeletions: Boolean

def hashCode(): Int

val ir: LeafReader

final def isInstanceOf[T0]: Boolean

lazy val liveDocs: Bits

def maxDoc: Int

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def numDeletedDocs: Int

def numDocs: Int

lazy val numFields: Int

val path: Path

def subset(filter: Filter): DocSet

def sumDocFreq(fName: String): Long

def sumTotalTermFreq(fName: String): Long

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

def termDocs(fName: String, text: String): Option[TermDocs]

def toString(): String

def topTermsByDocFreq(field: String, numTerms: Int = 20): Seq[(String, Int, Long)]

def topTermsByTotalTermFreq(field: String, numTerms: Int = 20): Seq[(String, Int, Long)]

def totalTermFreq(fName: String, text: String): Long

def universalset(): DocSet

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from RawReader

Inherited from AnyRef

Inherited from Any

Ungrouped