Packages

package scm

Provides classes for managing a collection of citable resources.

The CiteLibrary class contains metadata about a repository, and may optionally contain TextRepository or other CITE repository objects.

In the JVM branch, the LocalFileConverter object includes methods for creating CEX representations of repositories stored in various formats.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. scm
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class CiteLibrary(name: String, urn: Cite2Urn, license: String, namespaces: Vector[CiteNamespace], textRepository: Option[TextRepository] = None, collectionRepository: Option[CiteCollectionRepository] = None, relationSet: Option[CiteRelationSet] = None, dataModels: Option[Vector[DataModel]] = None) extends Product with Serializable

    A library of citable scholarly resources.

    A library of citable scholarly resources.

    name

    Name of the citable library.

    urn

    URN identifying the library.

    license

    Licensing and rights information.

    namespaces

    Possibly empty vector of CiteNamespaces.

    textRepository

    Optional, cataloged corpus of citable texts.

    collectionRepository

    Optional, cataloged set of CITE Collections. (Not used in current version.)

    relationSet

    Optional set of triple statements.

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

    Extension for exceptions specific to the scm package.

    Extension for exceptions specific to the scm package.

    Annotations
    @JSExportAll()
  3. case class CiteNamespace(abbreviation: String, uri: URI) extends Product with Serializable

    Pairing of abbreviation and namespace URI.

    Pairing of abbreviation and namespace URI.

    abbreviation

    String used for CITE or CTS namespace.

    uri

    Unique URI for namespace.

    Annotations
    @JSExportAll()
  4. case class DSEModel(label: String, passagePropertyUrn: Cite2Urn, imagePropertyUrn: Cite2Urn, surfacePropertyUrn: Cite2Urn) extends Product with Serializable

    Association of a CITE Collection with a citable data model.

    Association of a CITE Collection with a citable data model.

    label

    Human-readable label.

    Annotations
    @JSExportAll()
  5. case class DataModel(collection: Cite2Urn, model: Cite2Urn, label: String, description: String) extends Product with Serializable

    Association of a CITE Collection with a citable data model.

    Association of a CITE Collection with a citable data model.

    collection

    A CITE Collection following a specified data model.

    model

    Identifier for the data model.

    label

    Human-readable label.

    description

    Fuller description of the model, potentially with pointers to external documentation.

    Annotations
    @JSExportAll()

Value Members

  1. def cexData(cex: String, delimiter: String = "\t"): Map[String, String]

    Read required metadata fields from citerepo block of .cex file into a Map.

    Read required metadata fields from citerepo block of .cex file into a Map.

    cex

    Metadata block (!#citerepo) of CEX file.

    delimiter

    String separating keys from values.

  2. object CiteLibrary extends Serializable

    Factory for creating CiteLibrary objects from a String in CEX format.

  3. object CiteLibrarySource

    Factory for CiteLibrary objects.

  4. object DataModel extends Serializable
  5. object LocalFileConverter

    Utility class for reading CITE repositories stored in local files in various formats, and converting their data to universal CITE Exchange format.

Inherited from AnyRef

Inherited from Any

Ungrouped