package citeobj
- Alphabetic
- By Inheritance
- citeobj
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
trait
BaseCitable extends AnyRef
Trait defining the minimum functionality of a discrete citable object.
-
case class
CiteCatalog(collections: Vector[CiteCollectionDef]) extends Product with Serializable
Catalog defining structure of all collections in a repository.
Catalog defining structure of all collections in a repository.
- collections
Defintions of structure of individual collections.
- Annotations
- @JSExportAll()
-
case class
CiteCollectionData(data: Vector[CitePropertyValue]) extends LogSupport with Product with Serializable
Data values for a repository of citable objects and properties.
Data values for a repository of citable objects and properties. The data are organized as a Vector of CitePropertyValues. URN twiddling on this Vector can be used to construct any other valid sets of values, such as all values in a given collection, or all values used to create an individual CiteObject.
- data
vector of property values. Because CitePropertyValues have URNs, they can be grouped by object using URN twiddling.
- Annotations
- @JSExportAll()
-
case class
CiteCollectionDef(urn: Cite2Urn, collectionLabel: String, propertyDefs: Vector[CitePropertyDef], license: String = "public domain", labellingProperty: Option[Cite2Urn] = None, orderingProperty: Option[Cite2Urn] = None) extends Product with Serializable
Catalog entry defining a single CITE Collection.
Catalog entry defining a single CITE Collection.
- urn
URN for the collection.
- collectionLabel
Readable label for the collection.
- propertyDefs
CitePropertyDefs for all properties appearing in the collection.
- license
Statement of licensing terms applying to the collection as a whole.
- labellingProperty
Optionally specified URN for property labelling individual objects. If None, a default will be created by the labelProperty function.
- orderingProperty
URN for the property sequencing objects, if the collection is ordered.
- Annotations
- @JSExportAll()
-
case class
CiteCollectionRepository(data: CiteCollectionData, objects: CiteObjectMap, catalog: CiteCatalog) extends LogSupport with Product with Serializable
A cataloged collection of citable data.
A cataloged collection of citable data. In initialization, the constructor validates every object in the data against the structure defined in the catalog.
- data
Collection of data values.
- catalog
Documentation of the structure of each collection.
- Annotations
- @JSExportAll()
-
case class
CiteObject(urn: Cite2Urn, label: String, propertyList: Vector[CitePropertyImplementation]) extends BaseCitable with Product with Serializable
Representation of a single citable object.
Representation of a single citable object. Note that this can easily be constructed from the properties in a set of CiteCollectionData by URN twiddling, but since the CiteObject representation elevates
urn
andlabel
properties into object members, itspropertyList
will have two items fewer than the properties resulting from twiddling on a CiteCollectionData or from consulting the CiteCatalog corresponding to the CiteCollectionData.- urn
Identifier required by BaseCitable trait.
- label
Human-readable string required by BaseCitable trait.
- propertyList
Possibly empty vector of any further CitePropertyValues belonging to this object.
- Annotations
- @JSExportAll()
-
case class
CiteObjectException(message: String = "", cause: Option[Throwable] = None) extends Exception with Product with Serializable
Extension for exceptions specific to the
citeobj
package.Extension for exceptions specific to the
citeobj
package.- Annotations
- @JSExportAll()
-
case class
CiteObjectMap(objectMap: Map[Cite2Urn, CiteObject]) extends LogSupport with Product with Serializable
Map of Object-URN -> CiteObject for a repository of citable objects and properties.
Map of Object-URN -> CiteObject for a repository of citable objects and properties. The data are organized as a Map[Cite2Urn,CiteObject].
- objectMap
map of (object)-urns to cite2 objects.
- Annotations
- @JSExportAll()
-
case class
CitePropertyDef(urn: Cite2Urn, label: String, propertyType: CitePropertyType, vocabularyList: Vector[String] = Vector.empty) extends Product with Serializable
Definition of the structure of single CITE property.
Definition of the structure of single CITE property.
- urn
URN for the property. Note that this must include a collection component at the property level, and must *not* include an object selector.
- label
Human-readable label for the property.
- propertyType
CitePropertyType applying to this property.
- vocabularyList
Possibly empty Vector with a controlled vocabulary list for this property. Note that the list can only be non-empty if the CitePropertyType for this property is
StringType
.
- Annotations
- @JSExportAll()
-
case class
CitePropertyImplementation(urn: Cite2Urn, propertyDef: CitePropertyDef, propertyValue: Any) extends Product with Serializable
Definition of the structure of single CITE property.
Definition of the structure of single CITE property.
- urn
URN for the property. Note that this must include a collection component at the property level, and must *not* include an object selector.
- Annotations
- @JSExportAll()
-
sealed
trait
CitePropertyType extends AnyRef
Sealed trait for explicit enumeration of CITE property types.
-
case class
CitePropertyValue(urn: Cite2Urn, propertyValue: Any) extends Product with Serializable
An instance of a property value.
An instance of a property value.
- urn
URN identifying this value. Note that the URN must include an object selector, and its collection component must be at the property level.
- propertyValue
A value. Its type must be valid for the property type cataloged for the property of which this is an instance.
- Annotations
- @JSExportAll()
Value Members
-
def
mapsForDelimited(src: String, delimiter: String = "#"): Vector[Map[String, String]]
Creates a Vector of maps from a delimited text file with header line.
Creates a Vector of maps from a delimited text file with header line. Values of the header line serve as keys to the maps. Each entry in the vector maps a single row's values from column header to corresponding value.
- src
Delimited text data, including a header line.
- delimiter
String defining columns.
-
def
validValue(propertyValue: Any, propertyDef: CitePropertyDef): Boolean
True if propertyValue is valid for propertyType.
True if propertyValue is valid for propertyType.
- propertyValue
Value for a CITE Collection property.
-
object
BooleanType extends CitePropertyType with Product with Serializable
Type of all boolean values.
-
object
Cite2UrnType extends CitePropertyType with Product with Serializable
Type of all Cite2Urn values.
-
object
CiteCatalog extends Serializable
Object providing factory methods for creating CiteCatalog instances from various kinds of sources.
-
object
CiteCollectionData extends LogSupport
Factory for creating CiteCollectionData from source data in CEX format.
-
object
CiteCollectionRepository extends Serializable
Factory for creating CiteCollectionRepository from a CEX source.
-
object
CiteObjectMap extends LogSupport
Factory for creating CiteCollectionData from source data in CEX format.
-
object
CitePropertyValue extends Serializable
Factory for creating values from string serializations.
-
object
CiteRepositorySource
Factory for creating CiteCollectionRepository.
-
object
ControlledVocabType extends CitePropertyType with Product with Serializable
Type of all String values limited to values in an explicitly defined set of values (or vocabulary list).
-
object
CtsUrnType extends CitePropertyType with Product with Serializable
Type of all CtsUrn values.
-
object
NumericType extends CitePropertyType with Product with Serializable
Type of all numeric values.
-
object
StringType extends CitePropertyType with Product with Serializable
Type of all unconstrained String values.
Deprecated Value Members
-
object
CiteDataSource
Factory for creating CiteCollectionData.
Factory for creating CiteCollectionData.
- Annotations
- @deprecated
- Deprecated
(Since version 3.0.0) CiteDataSource deprecated in favor of CiteRepositorySource