Class/Object

org.clulab.processors

Document

Related Docs: object Document | package processors

Permalink

class Document extends Serializable

Stores all annotations for one document. Written by: Mihai Surdeanu and Gus Hahn-Powell. Last Modified: Add apply method to copy Document.

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

Instance Constructors

  1. new Document(sentences: Array[Sentence])

    Permalink

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. def addAttachment(name: String, attachment: DocumentAttachment): Unit

    Permalink

    Adds an attachment to the document's attachment map

  5. def ambivalenceHash: Int

    Permalink
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. var attachments: Option[HashMap[String, DocumentAttachment]]

    Permalink

    Map of any arbitrary document attachments such as document creation time

    Map of any arbitrary document attachments such as document creation time

    Attributes
    protected
  8. def clear(): Unit

    Permalink

    Clears any internal state potentially constructed by the annotators

  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. var coreferenceChains: Option[CorefChains]

    Permalink

    Clusters of coreferent mentions

  11. var documentCreationTime: Option[String]

    Permalink
    Attributes
    protected
  12. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  14. def equivalenceHash: Int

    Permalink

    Used to compare Documents.

    Used to compare Documents.

    returns

    a hash (Int) based primarily on the sentences, ignoring attachments

  15. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def getAttachment(name: String): Option[DocumentAttachment]

    Permalink

    Retrieves the attachment with the given name

  17. def getAttachmentKeys: Set[String]

    Permalink

    Retrieves keys to all attachments so that the entire collection can be read for purposes including but not limited to serialization.

    Retrieves keys to all attachments so that the entire collection can be read for purposes including but not limited to serialization. If there are no attachments, that is attachments == None, an empty set is returned. This does not distinguish between None and Some(HashMap.empty), especially since the latter should not be possible because of the lazy initialization.

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

    Permalink
    Definition Classes
    AnyRef → Any
  19. def getDCT: Option[String]

    Permalink
  20. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  21. var id: Option[String]

    Permalink

    Unique id for this document, if any

  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  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 prettyPrint(pw: PrintWriter): Unit

    Permalink
  27. def removeAttachment(name: String): Unit

    Permalink
  28. val sentences: Array[Sentence]

    Permalink
  29. def setDCT(dct: String): Unit

    Permalink

    Sets the document creation time using the CoreNLP format.

    Sets the document creation time using the CoreNLP format. See useFixedDate here for more details: https://stanfordnlp.github.io/CoreNLP/ner.html#setting-document-date The DCT will impacts how Sentence.norms are generated for DATE expressions

    dct

    Document creation time

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

    Permalink
    Definition Classes
    AnyRef
  31. var text: Option[String]

    Permalink

    The original text corresponding to this document, if it was preserved by the corresponding processor

  32. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  33. final def wait(): Unit

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

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

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

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped