case class CiteCollectionRepository(data: CiteCollectionData, objects: CiteObjectMap, catalog: CiteCatalog) extends Product with Serializable
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()
- Alphabetic
- By Inheritance
- CiteCollectionRepository
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
CiteCollectionRepository(data: CiteCollectionData, objects: CiteObjectMap, catalog: CiteCatalog)
- data
Collection of data values.
- catalog
Documentation of the structure of each collection.
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- val catalog: CiteCatalog
-
def
citableObject(objUrn: Cite2Urn): CiteObject
Retreive a citable object for an identifying URN from the objectMap
Retreive a citable object for an identifying URN from the objectMap
- objUrn
Cite2Urn
-
def
citableObjectFromProperties(objUrn: Cite2Urn): CiteObject
Construct a citable object for an identifying URN from the vector of properties
-
def
citableObjectFromProperties(objUrn: Cite2Urn, labelPropertyUrn: Cite2Urn): CiteObject
Construct a citable object for an identifying URN out of the vectdor of properties.
Construct a citable object for an identifying URN out of the vectdor of properties.
- labelPropertyUrn
URN of property to elevate to required label of a CiteObject.
-
val
citableObjects: Vector[CiteObject]
Hold a vector of CiteObjects
-
def
citableObjectsFromProperties: Vector[CiteObject]
Convert all data to a Vector of CiteObjects.
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
def
collectionData(collUrn: Cite2Urn): CiteCollectionData
Find data set for a given collection.
Find data set for a given collection.
- collUrn
Collection's URN.
-
def
collectionDefinition(collUrn: Cite2Urn): Option[CiteCollectionDef]
Find catalog entry for a given collection.
Find catalog entry for a given collection.
- collUrn
Collection's URN.
-
def
collections: Set[Cite2Urn]
Set of all cataloged collections in the repository, identified by URN.
-
val
collectionsMap: Map[Cite2Urn, Vector[Cite2Urn]]
A Map of (collection-level) URNs -> Vectors of URNs for that collection For ordered collections, the Vector[Cite2Urn] will be in the correct order for unordered collections, the Vector[Cite2Urn] will be in any old order
- val data: CiteCollectionData
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
first(coll: Cite2Urn): CiteObject
Find first citable object in an ordered collection.
Find first citable object in an ordered collection.
- coll
Collection URN.
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
indexOf(obj: CiteObject): Int
Index of a citable object in an ordered collection.
Index of a citable object in an ordered collection.
- obj
A citable object in an ordered collection.
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isOrdered(coll: Cite2Urn): Boolean
True if collection is ordered.
True if collection is ordered.
- coll
Collection to test.
-
def
last(coll: Cite2Urn): CiteObject
Find last citable object in an ordered collection.
Find last citable object in an ordered collection.
- coll
Collection URN.
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
next(obj: CiteObject): Option[CiteObject]
Find following citable object in an ordered collection.
Find following citable object in an ordered collection.
- obj
Find object following this.
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
numericGreaterThan(propertyUrn: Cite2Urn, pValue: Double): Vector[CiteObject]
Find all citable objects with a given property value greater than a given value.
Find all citable objects with a given property value greater than a given value.
- propertyUrn
Property to examine.
- pValue
Value to compare.
-
def
numericGreaterThan(pValue: Double): Vector[CiteObject]
Find all citable objects with a numeric property value greater than a given value.
Find all citable objects with a numeric property value greater than a given value.
- pValue
Value to compare.
-
def
numericGreaterThanOrEqual(propertyUrn: Cite2Urn, pValue: Double): Vector[CiteObject]
Find all citable objects with a given property value greater than or equal to a given value.
Find all citable objects with a given property value greater than or equal to a given value.
- propertyUrn
Property to examine.
- pValue
Value to compare.
-
def
numericGreaterThanOrEqual(pValue: Double): Vector[CiteObject]
Find all citable objects with a numeric property value greater or equal to than a given value.
Find all citable objects with a numeric property value greater or equal to than a given value.
- pValue
Value to compare.
-
def
numericLessThan(propertyUrn: Cite2Urn, pValue: Double): Vector[CiteObject]
Find citable objects with a given numeric property having a value less than a given value.
Find citable objects with a given numeric property having a value less than a given value.
- propertyUrn
Property to examine.
- pValue
Value to compare.
-
def
numericLessThan(pValue: Double): Vector[CiteObject]
Find all citable objects with a numeric property value less than a given value.
Find all citable objects with a numeric property value less than a given value.
- pValue
Value to compare.
-
def
numericLessThanOrEqual(propertyUrn: Cite2Urn, pValue: Double): Vector[CiteObject]
Find all citable objects with a numeric property value less than or equal to a given value.
Find all citable objects with a numeric property value less than or equal to a given value.
- propertyUrn
Property to examine.
- pValue
Value to compare.
-
def
numericLessThanOrEqual(pValue: Double): Vector[CiteObject]
Find all citable objects with a numeric property value less than or equal to a given value.
Find all citable objects with a numeric property value less than or equal to a given value.
- pValue
Value to compare.
-
def
numericWithin(propertyUrn: Cite2Urn, n1: Double, n2: Double): Vector[CiteObject]
Find all citable objects with a given property value falling within a given range.
Find all citable objects with a given property value falling within a given range.
- propertyUrn
Property to examine.
- n1
Lower bound,inclusive.
- n2
Upperbound, inclusive.
-
def
numericWithin(n1: Double, n2: Double): Vector[CiteObject]
Find all citable objects with a numeric property value within a given range.
Find all citable objects with a numeric property value within a given range.
- n1
Lower bound,inclusive.
- n2
Upperbound, inclusive.
-
def
objectMatchesCatalog(citeObj: CiteObject, collectionDef: CiteCollectionDef): Boolean
True if the given CiteObject validates against the collection's definition.
True if the given CiteObject validates against the collection's definition. In actuality, won't ever return false, but will throw an Exception if requirements checked by
assert
statements are violated, otherwise returns true.- citeObj
Citable object to evaluate.
- collectionDef
Collection definition to use in evaulating object.
-
def
objectValidates(objectUrn: Cite2Urn): Boolean
True if we can construct a valid object for a URN, confirm 1<->1 relation of cataloged properties and actual properties, and validate the type of each property value.
True if we can construct a valid object for a URN, confirm 1<->1 relation of cataloged properties and actual properties, and validate the type of each property value.
- objectUrn
URN uniquely identifyiing an object. It is an assertion exception if the URN does not match 1 and only 1 entry in the catalog.
- val objects: CiteObjectMap
-
def
objectsForCollection(urn: Cite2Urn): Vector[CiteObject]
Make a Vector of CiteObjects for a collection.
Make a Vector of CiteObjects for a collection. If the collection is ordered, the resulting Vector will be sorted by the collection's ordering property.
-
def
objectsForCollectionFromProperties(coll: Cite2Urn): Vector[CiteObject]
Make a Vector of CiteObjects for a collection, from the vector of properties.
Make a Vector of CiteObjects for a collection, from the vector of properties. If the collection is ordered, the resulting Vector will be sorted by the collection's ordering property.
- coll
Collection URN.
-
def
prev(obj: CiteObject): Option[CiteObject]
Find preceding citable object in an ordered collection.
Find preceding citable object in an ordered collection.
- obj
Find object preceding this.
-
def
properties: Set[Cite2Urn]
Set of all properties in the repository, identified by URN.
-
def
propertyValue(propertyUrn: Cite2Urn): Any
Find value of a given property.
Find value of a given property.
- propertyUrn
Property to find value for.
-
def
rangeFilter(filterUrn: Cite2Urn): Vector[CiteObject]
Find Vector of CiteObjects identified by URNs matching a given range URN.
Find Vector of CiteObjects identified by URNs matching a given range URN.
- filterUrn
URN to match.
-
def
regexMatch(propertyUrn: Cite2Urn, re: String): Vector[CiteObject]
Find citable objects with a given property matching a given regular expression.
Find citable objects with a given property matching a given regular expression.
- propertyUrn
Property to examine.
- re
Regular expression to match.
-
def
regexMatch(re: String): Vector[CiteObject]
Find all citable objects with a property matching a given regular expression.
Find all citable objects with a property matching a given regular expression.
- re
Regular expression to match.
-
def
sortValue(obj: CiteObject): Double
Look up value of ordering property for a citable object.
Look up value of ordering property for a citable object.
- obj
Citable object.
-
def
sortValue(obj: CiteObject, propertyKey: Cite2Urn): Double
Look up value of ordering property for a citable object.
Look up value of ordering property for a citable object.
- obj
Citable object.
- propertyKey
URN identifying its ordering property.
-
def
stringContains(propertyUrn: Cite2Urn, s: String, caseSensitive: Boolean): Vector[CiteObject]
Find citable objects with a given property containing a given substring, optionally taking case into consideration.
Find citable objects with a given property containing a given substring, optionally taking case into consideration.
- propertyUrn
Property to examine.
- s
Value to search for.
- caseSensitive
True if case should be considered in comparing strings.
-
def
stringContains(s: String, caseSensitive: Boolean = true): Vector[CiteObject]
Find all citable objects with a property containing a given substring, optionally taking case into consideration.
Find all citable objects with a property containing a given substring, optionally taking case into consideration.
- s
Value to search for.
- caseSensitive
True if case should be considered in comparing strings.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
urnMatch(propertyUrn: Cite2Urn, u: Urn): Vector[CiteObject]
Find citable objects with a given property matching a given regular expression.
Find citable objects with a given property matching a given regular expression.
- propertyUrn
Property to examine.
- u
URN to match.
-
def
urnMatch(u: Urn): Vector[CiteObject]
Find all citable objects with a property matching a given URN.
Find all citable objects with a property matching a given URN.
- u
URN to match.
-
def
urnsForCollectionFromProperties(urn: Cite2Urn): Vector[Cite2Urn]
Make a Vector of CiteObjects for a collection, from the vector of properties.
Make a Vector of CiteObjects for a collection, from the vector of properties. If the collection is ordered, the resulting Vector will be sorted by the collection's ordering property.
-
def
validateAll: Boolean
Validate that data and catalog agree.
- def valueEquals(propertyUrn: Cite2Urn, pValue: Any): Vector[CiteObject]
-
def
valueEquals(pValue: Any): Vector[CiteObject]
Find all citable objects with a given property value.
Find all citable objects with a given property value.
- pValue
Value to search for.
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
def
~~(filterUrn: Cite2Urn): Vector[CiteObject]
Find Vector of CiteObjects identified by URNs matching a given URN.
Find Vector of CiteObjects identified by URNs matching a given URN.
- filterUrn
URN to match.