clj-annotations.core — swvist/clj-annotations 0.2.2+fixnil2

Access and manipulate annotations.

Annotations are arbitrary properties associated with values that can be used for a variety of use cases. Typically you define a "schema" using defschema specifying its attributes Each of the schemas and attributes can have arbitrary properties - key/value pairs - associated with them.

This namespace provides functions and macros to define and access annotations.

defschema clj macro

(defschema name & kvs)

Define a schema and binds it to name.

kvs are key-value pairs. The following keys are defined:

:include: Specifies another schema or a collection of schemas to be merged in to this schema. :include s1 will merge all properties of s1 in to this schema, properties specified in this schema wins in case of conflicts. Similarly, :include [s1 s2] will merge all properties from s1 and s2 in to this schema. Properties of s1, s2, and this schema will win in that order in case of conflicts. :name: A short name for this schema used for documentation purposes. :description: A description for this schema used for documentation purposes. :attributes: A map from attribute IDs to attribute annotations.

get-annotations clj

(get-annotations schema)

(get-annotations schema attr)

(get-annotations schema attr prop)

(get-annotations schema attr prop not-found)

Access the annotations associated with a schema, an attribute, and a property. Returns all properties if only schema and attribute are provided. Returns nil if the specified property does not exist, or the not-found value if supplied.

make-schema clj

(make-schema {:keys [include attributes] :as m})

merge-attrs clj

(merge-attrs a1 a2)

a1 and a2 are annotation attribute maps of the form {:attr1 m1, :attr2 m2, ...} and {:attr1 n1, :attr2 n2, ...}. merge-attrs produces a map of the form {:attr1 (merge m1 n1), :attr2 (merge m2 n2), ...}. If an attribute exists only in one map, that value is used.

scan-attributes clj

(scan-attributes schema prop value)

Fetch a sequence of attribute ids of a schema having a specified property set to the specified value.