Class

org.nlp4l.lucene

FieldInfo

Related Doc: package lucene

Permalink

class FieldInfo extends AnyRef

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

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FieldInfo
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FieldInfo(info: apache.lucene.index.FieldInfo, luceneTerms: apache.lucene.index.Terms, liveDocs: Bits, reader: RawReader)

    Permalink

    Creates a new FieldInfo instance

    Creates a new FieldInfo instance

    info

    the Lucene FieldInfo instance

    luceneTerms

    the Lucene Terms instance

    liveDocs

    the Bits representing live docs

    reader

    the RawReader instance

Value Members

  1. final def !=(arg0: Any): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def docCount: Int

    Permalink

    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

  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  11. def hasFreqs: Boolean

    Permalink

    Returns true if documents in this field store per-document term frequency

  12. def hasNorms: Boolean

    Permalink

    Returns true if this field actually has any norms.

  13. def hasOffsets: Boolean

    Permalink

    Returns true if documents in this field store offsets

  14. def hasPayloads: Boolean

    Permalink

    Returns true if any payloads exist for this field.

  15. def hasPositions: Boolean

    Permalink

    Returns true if documents in this field store positions.

  16. def hasVectors: Boolean

    Permalink

    Returns true if any term vectors exist for this field.

  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  18. def indexOptions: IndexOptions

    Permalink

    Returns the IndexOption instance for this field

  19. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  20. def maxTerm: String

    Permalink

    Returns string representation for the largest term (in lexicographic order) in the field

  21. def minTerm: String

    Permalink

    Returns string representation for the smallest term (in lexicographic order) in the field.

  22. def name: String

    Permalink

    Returns the field name

  23. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  24. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  26. def number: Int

    Permalink

    Returns the Lucene internal field number

  27. def omitNorms: Boolean

    Permalink

    Returns true if norms are explicitly omitted for this field.

  28. val reader: RawReader

    Permalink

    the RawReader instance

  29. def sumDocFreq: Long

    Permalink

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

  30. def sumTotalTermFreq: Long

    Permalink

    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)

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

    Permalink
    Definition Classes
    AnyRef
  32. def term(text: String): Option[TermDocs]

    Permalink

    Returns the TermDocs instance with given string representation.

    Returns the TermDocs instance with given string representation.

    text

    the string representation for the term

    returns

    the TermDocs or None if this term does not exist

  33. def terms: Stream[TermDocs]

    Permalink

    Returns terms and associated docs information this field contains

    Returns terms and associated docs information this field contains

    returns

    the Iterable for TermDocs

  34. def toString(): String

    Permalink
    Definition Classes
    FieldInfo → AnyRef → Any
  35. def uniqTerms: Long

    Permalink

    Returns the number of unique terms for the field.

  36. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped