Class

org.nlp4l.lucene

Doc

Related Doc: package lucene

Permalink

class Doc extends AnyRef

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

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

Instance Constructors

  1. new Doc(docId: Int, freq: Int, text: String, pe: PostingsEnum = null, tvTerm: apache.lucene.index.Terms = null)

    Permalink

    Create a new Doc instance with given document id.

    Create a new Doc instance with given document id.

    docId

    the document id

    freq

    the term frequency in this doc

    text

    the term text

    pe

    the Lucene's PostingsEnum instance

    tvTerm

    the Lucene's Terms instance representing the term vector for this doc

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. val docId: Int

    Permalink

    the document id

  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. val freq: Int

    Permalink

    the term frequency in this doc

  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  12. def hasOffsets: Boolean

    Permalink

    Returns true if this Doc has offsets information else false.

  13. def hasPayloads: Boolean

    Permalink

    Returns true if this Doc has payload else false.

  14. def hasPositions: Boolean

    Permalink

    Returns true if this Doc has positions information else false.

  15. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  16. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  18. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  19. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  20. lazy val posAndOffsets: Seq[PosAndOffset]

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  22. def toString(): String

    Permalink
    Definition Classes
    Doc → AnyRef → Any

  23. lazy val tvPosList: Iterable[PosAndOffset]

    Permalink

  24. final def wait(): Unit

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

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

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

  26. final def wait(arg0: Long): Unit

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

Inherited from AnyRef

Inherited from Any

Ungrouped