Packages

case class OnlineDocument(urn: CtsUrn, format: DocumentFormat, docName: String, namespaces: Option[Map[String, String]] = None, xpathTemplate: Option[String] = None) extends Product with Serializable

Metadata about a citable text in a local file.

urn

CtsUrn for the text.

format

OHCO2 format of the file.

docName

Relative or absolute path to the document.

namespaces

Map of prefix abbreviations to URIs for XML namespaces, or None for non-XML document formats.

xpathTemplate

XPath-like string defining mapping of citation scheme to XML markup, or None for non-XML document formats.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OnlineDocument
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new OnlineDocument(urn: CtsUrn, format: DocumentFormat, docName: String, namespaces: Option[Map[String, String]] = None, xpathTemplate: Option[String] = None)

    urn

    CtsUrn for the text.

    format

    OHCO2 format of the file.

    docName

    Relative or absolute path to the document.

    namespaces

    Map of prefix abbreviations to URIs for XML namespaces, or None for non-XML document formats.

    xpathTemplate

    XPath-like string defining mapping of citation scheme to XML markup, or None for non-XML document formats.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def absolutePath(directory: String): OnlineDocument

    Create a new OnlineDocument with relative document name expanded to an absolute path.

    Create a new OnlineDocument with relative document name expanded to an absolute path.

    directory

    Base directory to prefix to relative document name.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. val docName: String
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. val format: DocumentFormat
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. val namespaces: Option[Map[String, String]]
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. val urn: CtsUrn
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  22. val xpathTemplate: Option[String]

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped