CitableBase.CitableType

A citable unit of any kind is identified by a URN and has a human-readable label.

CitableBase.UrnType

Unique identifiers expressible in the syntax of the IETF's URN specification.

Base.:==Method

Override Base.== for all Urn types.

==(u1, u2)
CitableBase.addversionMethod

Urn subtypes should implement addversion(urn::U, versionid)::U.

addversion(u, versioninfo)
CitableBase.cexMethod

It is an error to invoke the cex function on material that is not CEX serializable.

cex(, x; delimiter)
CitableBase.cexMethod

Delegate cex to specific functions based on type's cextrait value.

cex(x; delimiter)
CitableBase.componentsMethod
components(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.componentsMethod
components(u)

Splits a URN's string representation into top-level components.

CitableBase.dropsubrefMethod
dropsubref(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.fromcexMethod

Implement fromcex using first string parameter for a file name.

fromcex(fname, T, freader; delimiter, configuration, strict)
CitableBase.fromcexMethod

Implement fromcex using first string parameter for raw string data.

fromcex(
    cexsrc,
    T,
    freader;
    delimiter,
    configuration,
    strict
)
CitableBase.fromcexMethod

Implement fromcex using first string parameter for a URL.

fromcex(url, T, ureader; delimiter, configuration, strict)
CitableBase.fromcexMethod

Dispatch fromcex on cextrait of T to instantiate an object of type T from CEX-formatted data cexsrc.

fromcex(cexsrc, T; delimiter, configuration, strict)
CitableBase.fromcexMethod

It is an error to invoke the fromcex function on material that is not CEX serializable.

fromcex(, cex, T; delimiter, configuration, strict)
CitableBase.fromcexMethod

It is an error invoke fromcex function with an unimplemented trait value.

fromcex(
    traitvalue,
    cexsrc,
    T;
    delimiter,
    configuration,
    strict
)
CitableBase.labelMethod

It is an error to invoke the label function on material that is not citable.

label(_, x)
CitableBase.labelMethod

Delegate label to specific functions based on type's citable trait value.

label(x)
CitableBase.partitionbalancedMethod

Segment v into a series of Vectors of size n.

partitionbalanced(v, n)

It dividng v into units of size n does not produce partitions of equal size (i.e., if mod(v, n) is not equal to 0), trailing elements are omitted.

CitableBase.partitionvectMethod

Delegate partitionvect function, catching types that do not implement CitableCollectionTrait.

partitionvect(coll; n)
CitableBase.partitionvectMethod

Segment v into a series of Vectors of size n.

partitionvect(v; n)

The final vector is padded with nothing elements if its size is not equal to n.

CitableBase.partitionvectMethod

Create a vector of objects by sliding a window over a citable collection.

partitionvect(trait, coll; n)
CitableBase.partsMethod
parts(componentString)

Splits a string on periods (seprator for parts within components of URNs).

Examples

julia> parts("tlg0012.tlg001.msA")
CitableBase.slidingwindowMethod

Disipatch function, catching types that do not implement CitableCollectionTrait.

slidingwindow(coll; n, pad)
CitableBase.slidingwindowMethod

Create a Vector of Vectors of type T by sliding a window of size n over v.

slidingwindow(v; n, pad)
CitableBase.slidingwindowMethod

Create a vector of objects by sliding a window over a citable collection.

slidingwindow(trait, coll; n, pad)
CitableBase.str_dropsubrefMethod
str_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.subrefMethod

Urn subtypes should implement dropversion(urn::U)::U.

subref(u)
CitableBase.subrefMethod
subref(u)

Extract subreference from a a URN, or empty string if there is no subreference.

CitableBase.urnMethod

It is an error to invoke the urn function on material that is not citable.

urn(_, x)
CitableBase.urnMethod

Delegate urn to specific functions based on type's citable trait value.

urn(x)
CitableBase.urntypeMethod

It is an error to invoke the urn function on material that is not citable.

urntype(_, x)
CitableBase.urntypeMethod

Delegate urntype to specific functions based on type's citable trait value.

urntype(x)
CitableBase.versionidMethod

Urn subtypes should implement addversion(urn::U, versionid)::U.

versionid(u)