Packages

case class CtsUrn(urnString: String) extends Urn with Product with Serializable

A URN for a canonically citable text or passage of text.

urnString

String representation of CtsUrn validating againt the CtsUrn specification

Annotations
@JSExportAll()
Linear Supertypes
Serializable, Serializable, Product, Equals, Urn, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CtsUrn
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Urn
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CtsUrn(urnString: String)

    create a new CtsUrn

    create a new CtsUrn

    urnString

    String representation of CtsUrn validating againt the CtsUrn specification

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def <(urn: CtsUrn): Boolean

    True if this CtsUrn is contained by a given CtsUrn.

    True if this CtsUrn is contained by a given CtsUrn.

    urn

    CtsUrn to compare with this one.

  4. def <=(urn: CtsUrn): Boolean

    True if this CtsUrn is contained by or equal to a given CtsUrn.

    True if this CtsUrn is contained by or equal to a given CtsUrn.

    urn

    CtsUrn to compare with this one.

  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def >(urn: CtsUrn): Boolean

    True if this CtsUrn contains a given CtsUrn.

    True if this CtsUrn contains a given CtsUrn.

    urn

    CtsUrn to compare with this one.

  7. def ><(u: Urn): Boolean

    True if this CtsUrn is NOT URN-similar to a given Urn.

    True if this CtsUrn is NOT URN-similar to a given Urn. The comparison Urn must be a CtsUrn

    u

    URN to compare.

  8. def ><(urn: CtsUrn): Boolean

    True if this CtsUrn is NOT URN-similar to a given CtsUrn.

    True if this CtsUrn is NOT URN-similar to a given CtsUrn.

    urn

    URN to compare.

  9. def >=(urn: CtsUrn): Boolean

    True if this CtsUrn contains or is equal to a given CtsUrn.

    True if this CtsUrn contains or is equal to a given CtsUrn.

    urn

    CtsUrn to compare with this one.

  10. def addExemplar(ex: String): CtsUrn

    Create a new CtsUrn by adding or replacing the exemplar part of the passage component with a given value.

  11. def addPassage(psg: String): CtsUrn

    Create a new CtsUrn by adding or replacing the passage component with a given value.

    Create a new CtsUrn by adding or replacing the passage component with a given value.

    psg

    String value of new passage reference.

  12. def addVersion(v: String): CtsUrn

    Create a new CtsUrn by adding or replacing the version part of the work hierarchy with a given value.

    Create a new CtsUrn by adding or replacing the version part of the work hierarchy with a given value.

    v

    Version identifier for new URN.

  13. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  14. def citationDepth: Vector[Int]

    Return a Vector of integers representing the citation-depth of the passage component.

    Return a Vector of integers representing the citation-depth of the passage component. May be empty if there is no passage component. Will contain one integer if the URN is not a range; two if it is.

  15. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  16. def collapsePassageBy(i: Int): CtsUrn

    Create a new CtsUrn by collapsing the passage hierarchy by i levels.

    Create a new CtsUrn by collapsing the passage hierarchy by i levels.

    i

    Number of levels to drop from passage hierarchy.

  17. def collapsePassageTo(i: Int): CtsUrn

    Create a new CtsUrn by collapsing the passage hierarchy to a specified level.

    Create a new CtsUrn by collapsing the passage hierarchy to a specified level.

    i

    Number of levels to include in the passage hierarchy.

  18. def componentSyntaxOk: Boolean

    True if URN's syntax for required components is valid.

  19. val components: Array[String]

    Array of top-level, colon-delimited components.

    Array of top-level, colon-delimited components.

    The Array will have 4 elements if the optional passage component is omitted; if will have 5 elements if the passage component is included.

  20. def concrete: Boolean

    True if URN is a version or exemplar.

  21. def dropExemplar: CtsUrn

    Create a new CtsUrn by dropping the exemplar part of the work component, if any.

  22. def dropPassage: CtsUrn

    Create a new CtsUrn by dropping the passage component from this URN.

  23. def dropSubref: CtsUrn

    Create a new CtsUrn by dropping any extended reference parts from this CtsUrn.

  24. def dropVersion: CtsUrn

    Create a new CtsUrn by dropping the version part from the work component.

  25. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. def exemplar: String

    String value of optional exemplar part of work hierarchy.

  27. def exemplarOption: Option[String]

    Optional exemplar part of work hierarchy.

  28. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  29. def fullyValid: Boolean

    True if value submitted to construct this CtsUrn complies fully with the CtsUrn specification.

  30. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  31. def isExemplar: Boolean

    True if URN is an exemplar.

  32. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  33. def isNotional: Boolean

    True if URN is a notional work.

  34. def isPoint: Boolean

    True if the URN refers to a point (leaf node or containing node).

  35. def isRange: Boolean

    True if the passage component refers to a range.

  36. def isTextGroup: Boolean

    True if URN is a notional work.

  37. def isVersion: Boolean

    True if URN is a version.

  38. val namespace: String

    Required namespace component of the URN.

  39. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  40. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  41. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  42. def passageComponent: String

    String value of optional passage component of the URN.

  43. def passageComponentOption: Option[String]

    Optional passage component of the CtsUrn.

  44. def passageContains(urn: CtsUrn): Boolean

    True if passage reference in urn is contained in or equal to the passage reference of this CtsUrn.

    True if passage reference in urn is contained in or equal to the passage reference of this CtsUrn.

    urn

    CtsUrn to compare to this one.

  45. def passageMatch(urn: CtsUrn): Boolean

    True if the passage reference of either this or a given CtsUrn is contained by the other.

    True if the passage reference of either this or a given CtsUrn is contained by the other.

    urn

    CtsUrn to compare to this one

  46. def passageNode: String

    String value of the optional single passage node.

  47. val passageNodeOption: Option[String]

    Optional single passage node.

  48. def passageNodeParts: Array[String]

    Array splitting optional single passage node into reference and extended reference.

  49. def passageNodeRef: String

    String value of reference part of optional passage node.

  50. def passageNodeRefOption: Option[String]

    Reference part of optional passage node.

  51. def passageNodeSubref: String

    String value of optional subference component from optional passage node.

  52. def passageNodeSubrefIndex: Int

    Integer value of 0ptional index of the optional passage node.

  53. def passageNodeSubrefIndexOption: Option[Int]

    Optional index value of the optional passage node.

  54. def passageNodeSubrefOption: Option[String]

    Extract optional subference component from optional passage node using packag object's subrefOption function.

  55. def passageNodeSubrefText: String

    String value of optional indexed text of the optional passage node.

  56. def passageNodeSubrefTextOption: Option[String]

    Optional indexed text of the optional passage node.

  57. def passageParts: Array[String]

    Array of hyphen-separated parts of the passageComponent.

    Array of hyphen-separated parts of the passageComponent.

    The Array will contain 0 elements if passageComponent is empty, 1 element if the passageComponent is a node reference, and 2 elements if the passageComponent is a range reference.

  58. def passageSyntaxOk: Boolean

    True if URN's syntax for optional passage component is valid.

  59. def rangeBegin: String

    String value of first part of an optional range expression in optional passage component.

  60. def rangeBeginOption: Option[String]

    First part of an optional range expression in optional passage component.

  61. def rangeBeginParts: Array[String]

    Array splitting first part of optional range expression into reference and extended reference.

  62. def rangeBeginRef: String

    String value of reference part of first part of range in optional passage node.

  63. def rangeBeginRefOption: Option[String]

    Reference part of first part of range in optional passage node.

  64. def rangeBeginSubref: String

    String value of optional subference component from first part of range in optional passage node.

  65. def rangeBeginSubrefIndex: Int

    Integer value of optional index of the first part of range of optional passage node.

  66. def rangeBeginSubrefIndexOption: Option[Int]

    Optional index value of the first part of range of optional passage node.

  67. def rangeBeginSubrefOption: Option[String]

    Extract optional subference component from first part of ragne in optional passage node using packag object's subrefOption function.

  68. def rangeBeginSubrefText: String

    String value of optional indexed text of the the first part of range of optional passage node.

  69. def rangeBeginSubrefTextOption: Option[String]

    Optional indexed text of the first part of range in optional passage node.

  70. def rangeEnd: String

    String value of second part of an optional range expression in optional passage component.

  71. def rangeEndOption: Option[String]

    Second part of an optional range expression in optional passage component.

  72. def rangeEndParts: Array[String]

    Array splitting second part of optional range expression into reference and extended reference.

  73. def rangeEndRef: String

    String value of reference part of second part of range in optional passage node.

  74. def rangeEndRefOption: Option[String]

    Reference part of second part of range in optional passage node.

  75. def rangeEndSubref: String

    String value of optional subference component from second part of range in optional passage node

  76. def rangeEndSubrefIndex: Int

    Integer value of optional index of the second part of range of optional passage component.

  77. def rangeEndSubrefIndexOption: Option[Int]

    Optional index value of the second part of range of optional passage node.

  78. def rangeEndSubrefOption: Option[String]

    Extract optional subference component from second part of ragne in optional passage node using packag object's subrefOption function

  79. def rangeEndSubrefText: String

    String value of optional indexed text of the second part of range in optional passage node.

  80. def rangeEndSubrefTextOption: Option[String]

    Optional indexed text of the second part of range in optional passage node.

  81. def rangeToUrnVector: Vector[CtsUrn]

    Return a Vector of CtsUrns representing the ends of a range-URN.

    Return a Vector of CtsUrns representing the ends of a range-URN. If the URN is not a range, will return a one-element vector.

  82. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  83. val textGroup: String

    Required textgroup part of work hierarchy.

  84. def toExemplar: CtsUrn

    Create a new CtsUrn identifying this URN's exemplar.

  85. def toString(): String

    Override default toString function.

    Override default toString function.

    Definition Classes
    CtsUrn → AnyRef → Any
  86. def toTextGroup: CtsUrn

    Create a new CtsUrn identifying this URN's text group.

  87. def toVersion: CtsUrn

    Create a new CtsUrn identifying this URN's version.

  88. def toWork: CtsUrn

    Create a new CtsUrn identifying this URN's work.

  89. val urnString: String
  90. def version: String

    String value of optional version part of work hierarchy.

  91. def versionOption: Option[String]

    Optional version part of work hierarchy.

  92. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  93. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  94. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  95. def work: String

    String value of optional work part of work hierarchy.

  96. val workComponent: String

    Required work component of the URN.

  97. def workContains(urn: CtsUrn): Boolean

    True if work reference in urn is contained in or equal to the work reference of this CtsUrn.

    True if work reference in urn is contained in or equal to the work reference of this CtsUrn.

    urn

    CtsUrn to compare to this one.

  98. def workLevel: WorkLevel.Value

    Enumerated WorkLevel for this workComponent.

  99. def workMatch(urn: CtsUrn): Boolean

    true if the passage reference of either urn of this CtsUrn is contained by the other.

    true if the passage reference of either urn of this CtsUrn is contained by the other.

    urn

    CtsUrn to compare to this one

  100. def workOption: Option[String]

    Optional work part of work hierarchy.

  101. val workParts: Array[String]

    Array of dot-separate parts of the workComponent.

  102. def ~~(u: Urn): Boolean

    True if this CtsUrn is URN-similar to a given Urn.

    True if this CtsUrn is URN-similar to a given Urn. Comparison URN must be a CTS URN.

    u

    URN to compare.

    Definition Classes
    CtsUrnUrn
  103. def ~~(urn: CtsUrn): Boolean

    True if this CtsUrn is URN-similar a given CtsUrn.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Urn

Inherited from AnyRef

Inherited from Any

Ungrouped