CitableBase.CexSerializable
— TypeValue for the CexTrait for serializable content.
CitableBase.CexTrait
— TypeTrait for objects serializable in CEX format.
CitableBase.Citable
— TypeA citable unit of any kind is identified by a URN and has a human-readable label.
CitableBase.CitableCollectionTrait
— TypeAbstraction of values for a citable library collection trait.
CitableBase.CitableTrait
— TypeAbstraction of values for a citable trait.
CitableBase.FileReader
— TypeSingleton identifying string as file source for CEX data to parse.
CitableBase.NotCexSerializable
— TypeValue for the CexTrait for content not serializable to CEX format.
CitableBase.NotCitable
— TypeValue for the CitableTrait for everything not citable.
CitableBase.NotCitableCollection
— TypeValue for the CitableCollectionTrait for evertything that is not a citable library collection.
CitableBase.NotUrnComparable
— TypeValue of the UrnComparisonTrait for evertything that can NOT be compared using URN logic.
CitableBase.ReaderType
— TypeTrait for how to parse strings into blocks
CitableBase.StringReader
— TypeSingleton identifying string as CEX data to parse.
CitableBase.UrlReader
— TypeSingleton identifying string as URL source for CEX data to parse.
CitableBase.Urn
— TypeUnique identifiers expressible in the syntax of the IETF's URN specification.
CitableBase.UrnComparisonTrait
— TypeAbstraction of values for URN manipulation.
Base.:==
— MethodOverride Base.== for all Urn
types.
==(u1, u2)
CitableBase.addversion
— MethodUrn subtypes should implement addversion(urn::U, versionid)::U
.
addversion(u, versioninfo)
CitableBase.cex
— MethodIt is an error to invoke the cex
function on material that is not CEX serializable.
cex(, x; delimiter)
CitableBase.cex
— MethodDelegate cex
to specific functions based on type's cextrait
value.
cex(x; delimiter)
CitableBase.cexserializable
— MethodTrue if type T
is serializable to CEX format
cexserializable(x)
CitableBase.cextrait
— MethodSubtypes of Citable
are CexSerializable
.
cextrait(_)
CitableBase.cextrait
— MethodThe default value of CexTrait
is NotCexSerializable
.
cextrait(_)
CitableBase.citable
— MethodTrue if x
is a citable object.
CitableBase.citablecollection
— MethodTrue if x
has the value CitableCollection
for the CitableCollectionTrait
.
citablecollection(x)
CitableBase.citablecollectiontrait
— MethodDefine default value of CitableCollectionTrait as NotCitableCollection.
CitableBase.citabletrait
— MethodDefine default value of CitableTrait as NotCitable.
CitableBase.components
— Methodcomponents(uString)
Splits a string on colons (separator for top-level components of URNs).
Examples
julia> components("urn:cts:greekLit:tlg0012.tlg001.msA:1.1")
CitableBase.components
— Methodcomponents(u)
Splits a URN's string representation into top-level components.
CitableBase.dropsubref
— MethodUrn subtypes should implement dropversion(urn::U)::U
.
dropsubref(u)
CitableBase.dropsubref
— Methoddropsubref(u)
Remove any subreferences in URN u
. If u
is a range, separately drop subreference from each of range-begin and range-end parts.
CitableBase.dropversion
— MethodUrn subtypes should implement dropversion(urn::U)::U
.
dropversion(u)
CitableBase.fromcex
— MethodImplement fromcex
using first string parameter for a file name.
fromcex(fname, T, freader; delimiter, configuration, strict)
CitableBase.fromcex
— MethodImplement fromcex
using first string parameter for raw string data.
fromcex(
cexsrc,
T,
freader;
delimiter,
configuration,
strict
)
CitableBase.fromcex
— MethodImplement fromcex
using first string parameter for a URL.
fromcex(url, T, ureader; delimiter, configuration, strict)
CitableBase.fromcex
— MethodDispatch fromcex
on cextrait
of T
to instantiate an object of type T
from CEX-formatted data cexsrc
.
fromcex(cexsrc, T; delimiter, configuration, strict)
CitableBase.fromcex
— MethodIt is an error to invoke the fromcex
function on material that is not CEX serializable.
fromcex(, cex, T; delimiter, configuration, strict)
CitableBase.fromcex
— MethodIt is an error invoke fromcex
function with an unimplemented trait value.
fromcex(
traitvalue,
cexsrc,
T;
delimiter,
configuration,
strict
)
CitableBase.hassubref
— MethodTrue for URN types that support subreferences.
hassubref(u)
CitableBase.hassubref
— MethodTrue if last component of u
has a sub-reference.
hassubref(u)
CitableBase.isrange
— MethodTrue if u
is a range-type URN.
isrange(u)
CitableBase.label
— MethodIt is an error to invoke the label
function on material that is not citable.
label(_, x)
CitableBase.label
— MethodDelegate label
to specific functions based on type's citable trait value.
label(x)
CitableBase.parts
— Methodparts(componentString)
Splits a string on periods (seprator for parts within components of URNs).
Examples
julia> parts("tlg0012.tlg001.msA")
CitableBase.range_begin
— Methodrange_begin(u)
Extract first part from a range expression in URN u
.
CitableBase.range_end
— Methodrange_end(u)
Extract second part from a range expression in URN u
.
CitableBase.str_dropsubref
— Methodstr_dropsubref(s)
Remove any subreference substrings in a string. If s
is a range expression, separately drop subreference from each of range-begin and range-end parts.
CitableBase.str_hassubref
— Methodstr_hassubref(s)
True if s
has a subreference pattern.
CitableBase.str_isrange
— MethodTrue if s
has a range pattern.
str_isrange(s)
CitableBase.str_range_begin
— Methodstr_range_begin(s)
Extract first part from a range expression in s
.
CitableBase.str_range_end
— Methodstr_range_end(s)
Extract second part from a range expression.
CitableBase.str_subref
— Methodstr_subref(s)
Extract subreference from a string.
CitableBase.subref
— MethodUrn subtypes should implement dropversion(urn::U)::U
.
subref(u)
CitableBase.subref
— Methodsubref(u)
Extract subreference from a a URN, or empty string if there is no subreference.
CitableBase.supportssubref
— MethodTrue for URN types that support subreferences.
supportssubref(u)
CitableBase.supportsversion
— MethodTrue for URN types that support versioning.
supportsversion(u)
CitableBase.urn
— MethodIt is an error to invoke the urn
function on material that is not citable.
urn(_, x)
CitableBase.urn
— MethodDelegate urn
to specific functions based on type's citable trait value.
urn(x)
CitableBase.urncomparable
— MethodTrue if type T
implements the UrnComparisonTrait
.
urncomparable(u)
CitableBase.urncomparisontrait
— MethodDefault value of UrnComparisonTrait
is NotUrnComparable
.
CitableBase.urncontains
— MethodURN-comparable objects must implement urncontains
.
urncontains(x, y)
CitableBase.urnequals
— MethodURN-comparable objects must implement urnequals
.
urnequals(x, y)
CitableBase.urnequals
— MethodFor subtypes of Urn
, implement urnequals
concretely.
urnequals(u1, u2)
CitableBase.urnsimilar
— MethodURN-comparable objects must implement urnsimilar
.
urnsimilar(x, y)
CitableBase.urntype
— MethodIt is an error to invoke the urn
function on material that is not citable.
urntype(_, x)
CitableBase.urntype
— MethodDelegate urntype
to specific functions based on type's citable trait value.
urntype(x)
CitableBase.versionid
— MethodUrn subtypes should implement addversion(urn::U, versionid)::U
.
versionid(u)