cite

Library for working with canonical identifers used in citing scholarly resources.

Linear Supertypes

AnyRef, Any

Ordering

Inherited

Visibility

trait Citable extends AnyRef
Trait for any citable scholarly resource.
Trait for any citable scholarly resource.
Implementing classes must have a Urn value identifying the object, and a CitableExport function delivering a two-column string labelling URNs with a type.
case class Cite2Urn(urnString: String) extends Urn with LogSupport with Product with Serializable
A URN for a citable object in a collection.
A URN for a citable object in a collection.
urnString
String representation of Cite2Urn validating against the Cite2Urn specification

Annotations
@JSExportAll()
case class CiteException(message: String = "", cause: Option[Throwable] = None) extends Exception with Product with Serializable
class CiteExport extends AnyRef

Annotations
@JSExportTopLevel( "Urn" )
case class CtsUrn(urnString: String) extends Urn with LogSupport with Product with Serializable
A URN for a canonically citable text or passage of text.
A URN for a canonically citable text or passage of text.
urnString
String representation of CtsUrn validating againt the CtsUrn specification

Annotations
@JSExportAll()
abstract class Urn extends AnyRef
The superclass of Urn objects, implemented by CtsUrn and CiteUrn.

def subrefIndexOption(subref: String): Option[Int]
Extracts the explicitly given index of a subref from a passage node value, or the default value of 1.
Extracts the explicitly given index of a subref from a passage node value, or the default value of 1.
The index value must be an integer.
val subrefIndexRE: Regex
Regular expression matching the index part of a subreference on a CTS URN passage node.
def subrefOption(s: String): Option[String]
Extracts the subref from a passage node value.
Extracts the subref from a passage node value.
s
A passage node value, a reference to a single node or to the beginning or ending node of a range reference.
def subrefTextOption(s: String): Option[String]
Extracts the cited text of a subref from a passage node value.
Extracts the cited text of a subref from a passage node value.
s
A passage node value, a reference to a single node or to the beginning or ending node of a range reference.
val subrefTextRE: Regex
Regular expression matching text part of a subreference on a CTS URN passage node.
object Cite2Urn extends Serializable

Annotations
@JSExportAll()
object Main
object WorkLevel extends Enumeration
Enumeration of levels of the CTS work hierarchy.
Enumeration of levels of the CTS work hierarchy.

Annotations
@JSExportTopLevel( "WorkLevel" )

Packages