Packages

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

A URN for a citable object in a collection.

urnString

String representation of Cite2Urn validating against the Cite2Urn specification

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

Instance Constructors

  1. new Cite2Urn(urnString: String)

    create a new Cite2Urn.

    create a new Cite2Urn. The long constructor validates a submitted string against the complex syntactic requirements of the CITE2 URN specification, and defines a number of functions for manipulating CITE2 URN values.

    urnString

    String representation of Cite2Urn validating against the Cite2Urn specification

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 addProperty(propertyId: String): Cite2Urn

    Adds a property identifier to the object hierarchy.

    Adds a property identifier to the object hierarchy.

    propertyId

    Identifier for the property.

  5. def addSelector(selectorId: String): Cite2Urn

    Adds an object selector to the URN.

    Adds an object selector to the URN.

    selectorId

    Identifier for the selected object.

  6. def addVersion(versionId: String): Cite2Urn

    Adds a version identifier to the object hierarchy.

    Adds a version identifier to the object hierarchy.

    versionId

    Identifier for the property.

  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  9. val collection: String
  10. val collectionComponent: String

    Required work component of the URN.

  11. def collectionContainedIn(urn: Cite2Urn): Boolean
  12. val collectionParts: Vector[String]
  13. def collectionsMatch(u: Cite2Urn): Boolean
  14. val components: Array[String]

    Array of top-level, colon-delimited components.

  15. macro def debug(message: Any, cause: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingMethods
  16. macro def debug(message: Any): Unit
    Attributes
    protected
    Definition Classes
    LoggingMethods
  17. def debugString: Vector[String]
  18. def dropExtensions: Cite2Urn

    Trims any extended citation components off of passage or range selectors.

  19. def dropProperty: Cite2Urn

    Trims the property identifier off of a URN, if it is present.

    Trims the property identifier off of a URN, if it is present. This effectively converts a property citation to an object citation.

  20. def dropSelector: Cite2Urn

    Trims the selector component off of a URN, if it is present.

    Trims the selector component off of a URN, if it is present. This effectively converts a citation of a single value to a citation of a collection of values (objects or properties).

  21. def dropVersion: Cite2Urn
  22. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. macro def error(message: Any, cause: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingMethods
  24. macro def error(message: Any): Unit
    Attributes
    protected
    Definition Classes
    LoggingMethods
  25. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. macro def info(message: Any, cause: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingMethods
  27. macro def info(message: Any): Unit
    Attributes
    protected
    Definition Classes
    LoggingMethods
  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. val isObject: Boolean

    True if URN includes a selector for a single object.

  30. val isRange: Boolean

    True if URN identifies a range within an ordered collection.

  31. val labels: Vector[String]
  32. macro def logAt(logLevel: LogLevel, message: Any): Unit
    Attributes
    protected
    Definition Classes
    LoggingMethods
  33. lazy val logger: Logger
    Attributes
    protected[this]
    Definition Classes
    LazyLogger
  34. val namespace: String

    Required namespace component of the URN.

  35. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  36. val noObject: Boolean

    True if URN does not include an object selector component.

  37. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  38. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  39. def objectComponent: String

    String value of optional object selector component.

  40. def objectComponentOption: Option[String]

    Optional object selector component.

  41. def objectExtension: String
  42. def objectExtensionOption: Option[String]
  43. val objectOption: Option[String]

    Single object identifier as an Option.

  44. val objectParts: Vector[String]

    For non-empty object component, hyphen-separated parts allowed in ordered collections.

  45. def objectsMatch(u: Cite2Urn): Boolean
  46. def property: String

    String value of optional property part of collection component.

  47. def propertyOption: Option[String]

    Optional property part of collection component.

  48. def rangeBegin: String

    String value of first part of range identifier.

  49. def rangeBeginExtension: String
  50. def rangeBeginExtensionOption: Option[String]
  51. val rangeBeginOption: Option[String]

    First part of range identifier as an Option.

  52. def rangeBeginParts: Vector[String]
  53. def rangeBeginUrn: Cite2Urn
  54. def rangeEnd: String

    String value of second part of range identifier.

  55. def rangeEndExtension: String
  56. def rangeEndExtensionOption: Option[String]
  57. val rangeEndOption: Option[String]

    Second part of range identifier as an Option.

  58. def rangeEndParts: Vector[String]
  59. def rangeEndUrn: Cite2Urn
  60. def singleObjectParts: Vector[String]
  61. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  62. def toString(): String
    Definition Classes
    Cite2Urn → AnyRef → Any
  63. macro def trace(message: Any, cause: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingMethods
  64. macro def trace(message: Any): Unit
    Attributes
    protected
    Definition Classes
    LoggingMethods
  65. val urnString: String
  66. def version: String

    String value of optional version part of collection component.

  67. def versionOption: Option[String]

    Optional version part of collection component.

  68. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  69. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  70. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  71. macro def warn(message: Any, cause: Throwable): Unit
    Attributes
    protected
    Definition Classes
    LoggingMethods
  72. macro def warn(message: Any): Unit
    Attributes
    protected
    Definition Classes
    LoggingMethods
  73. def ~~(u: Cite2Urn): Boolean
  74. def ~~(u: Urn): Boolean
    Definition Classes
    Cite2Urn → Urn

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Product

Inherited from Equals

Inherited from LogSupport

Inherited from LazyLogger

Inherited from LoggingMethods

Inherited from Serializable

Inherited from Serializable

Inherited from Urn

Inherited from AnyRef

Inherited from Any

Ungrouped