Class/Object

org.nlp4l.lucene

Document

Related Docs: object Document | package lucene

Permalink

class Document extends AnyRef

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

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

Instance Constructors

  1. new Document(fields: Set[Field], docId: Int = 1)

    Permalink

    Create a new Document instance with set of Fields and optionally, the corresponding Lucene document id.

    Create a new Document instance with set of Fields and optionally, the corresponding Lucene document id.

    fields

    the field set

    docId

    the Lucene document id

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 Lucene 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. val fields: Set[Field]

    Permalink

    the field set

  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  11. def get(fName: String): Option[Field]

    Permalink

    Returns the Field instance for given field name.

    Returns the Field instance for given field name.

    fName

    the field name

    returns

    the field or None if the requested field does not exist.

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

    Permalink
    Definition Classes
    AnyRef → Any

  13. def getValue(fName: String): Option[Seq[String]]

    Permalink

    Returns the string representation for the value of given field name.

    Returns the string representation for the value of given field name.

    fName

    the field name

    returns

    the field values or None if the requested field does not exist.

  14. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  16. def luceneDocument(schema: Schema): apache.lucene.document.Document

    Permalink

    Generate an Lucene Document instance from this document with given schema.

    Generate an Lucene Document instance from this document with given schema.

    schema

    the schema holding field type mapping

    returns

    a new Lucene Document instance

  17. val map: Map[String, Field]

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  19. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  20. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  22. def toString(): String

    Permalink
    Definition Classes
    Document → AnyRef → Any

  23. final def wait(): Unit

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped