Packages

case class DseVector(passages: Vector[DsePassage]) extends Product with Serializable

A class for working with an ordered sequence of DsePassage obects.

passages

Vector of DsePassage objects.

Annotations
@JSExportAll()
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DseVector
  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 DseVector(passages: Vector[DsePassage])

    passages

    Vector of DsePassage objects.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def ++(dseVector: DseVector): DseVector

    Concatenate a second DseVector to this one.

    Concatenate a second DseVector to this one.

    dseVector

    Second DseVector to concatenate to this one.

  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def ictForImage(img: Cite2Urn, baseUrl: String = ...): String

    Compose a URL string to display DSE relations for a specified image in the image citation tool developed for the CITE Architecture.

    Compose a URL string to display DSE relations for a specified image in the image citation tool developed for the CITE Architecture. See https://github.com/cite-architecture/ict2.

    img

    The images to illustrate.

    baseUrl

    Home URL, as a String, for an installation of the CITE Image Citation Tool (version 2).

  11. def ictForSurface(surfaceUrn: Cite2Urn, baseUrl: String = ...): String

    Compose a URL string to display DSE relations for a specifice text-bearing surface in the image citation tool developed for the CITE Architecture.

    Compose a URL string to display DSE relations for a specifice text-bearing surface in the image citation tool developed for the CITE Architecture. See https://github.com/cite-architecture/ict2.

    surfaceUrn

    The surface to illustrate.

    baseUrl

    Home URL, as a String, for an installation of the CITE Image Citation Tool (version 2).

  12. def ictForText(psg: CtsUrn, baseUrl: String = ...): String

    Compose a URL string to display DSE relations for an exactly matching specified passage of text in the image citation tool developed for the CITE Architecture.

    Compose a URL string to display DSE relations for an exactly matching specified passage of text in the image citation tool developed for the CITE Architecture. See https://github.com/cite-architecture/ict2.

    psg

    Text passage to illustrate.

    baseUrl

    Home URL, as a String, for an installation of the CITE Image Citation Tool (version 2).

  13. def imageCollections: Set[Cite2Urn]

    Set of image collections in this DSE.

  14. def imageForTbs(surface: Cite2Urn): Cite2Urn

    Reference image illustrating a given surface.

    Reference image illustrating a given surface. All DSE records for a surface should refer to a single image.

    surface

    A text-bearing surface.

  15. def imageForText(psg: CtsUrn): Cite2Urn

    Reference image illustrating a given passage of text.

    Reference image illustrating a given passage of text.

    psg

    A citable node of text.

  16. def imageWRoiForText(psg: CtsUrn): Cite2Urn

    Image citation with RoI illustrating a given passage of text.

    Image citation with RoI illustrating a given passage of text.

    psg

    A citable node of text.

  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. val passages: Vector[DsePassage]
  22. def size: Int

    Number of citable text passages in this data set.

  23. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  24. def tbs: Set[Cite2Urn]

    Set of text-bearing surfaces in this DSE.

  25. def tbsForImage(img: Cite2Urn): Set[Cite2Urn]

    Set of text-bearing surfaces illustrated by a given image.

    Set of text-bearing surfaces illustrated by a given image.

    img

    Illustrative image.

  26. def texts: Set[CtsUrn]

    Set of texts (editions or versions) in this DSE.

  27. def textsForImage(img: Cite2Urn): Vector[CtsUrn]

    Set of texts illustrated by a given image.

    Set of texts illustrated by a given image. Note that this is an unordered set of citable nodes. You need to consult a TextRepository or a Corpus to determine the document order of nodes in this set or construct a range from this set.

    img

    Illustrative image.

  28. def textsForTbs(surf: Cite2Urn): Vector[CtsUrn]

    Vector of texts appearing on a given text-bearing surface.

    Vector of texts appearing on a given text-bearing surface. Ordering of the Vector follows the initial construction of the DseVector.

    surf

    Text-bearing surface.

  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped