Liking cljdoc? Tell your friends :D

adl-support.utils

Application Description Language support library - utility functions.

Application Description Language support library - utility functions.

*locale*

The locale for which files will be generated.

The locale for which files will be generated.
raw docstring

*output-path*

The path to which generated files will be written.

The path to which generated files will be written.
raw docstring

*verbosity*

The verbosity of output from the generator.

The verbosity of output from the generator.
raw docstring

all-propertiesmacro

(all-properties entity)

Return all properties of this entity (including key properties).

Return all properties of this `entity` (including key properties).
raw docstring

attributes

(attributes element)
(attributes element predicate)

Return the attributes of this element; if predicate is passed, return only those attributes satisfying the predicate.

Return the attributes of this `element`; if `predicate` is passed, return only those
attributes satisfying the predicate.
raw docstring

base-type

(base-type property application)

capitalise

(capitalise s)

Return a string like s but with each token capitalised.

Return a string like `s` but with each token capitalised.
raw docstring

child

(child element predicate)

Return the first child of this element satisfying this predicate.

Return the first child of this `element` satisfying this `predicate`.
raw docstring

child-with-tag

(child-with-tag element tag)
(child-with-tag element tag predicate)

Return the first child of this element which has this tag; if element is nil, return nil. If predicate is supplied, return only the first child with the specified tag which satisfies the predicate.

Return the first child of this `element` which has this `tag`;
if `element` is `nil`, return `nil`. If `predicate` is supplied,
return only the first child with the specified `tag` which satisfies
the `predicate`.
raw docstring

children

(children element)
(children element predicate)

Return the children of this element; if predicate is passed, return only those children satisfying the predicate.

Return the children of this `element`; if `predicate` is passed, return only those
children satisfying the predicate.
raw docstring

children-with-tag

(children-with-tag element tag)
(children-with-tag element tag predicate)

Return all children of this element which have this tag; if element is nil, return nil. If predicate is supplied, return only those children with the specified tag which satisfy the predicate.

Return all children of this `element` which have this `tag`;
if `element` is `nil`, return `nil`. If `predicate` is supplied,
return only those children with the specified `tag` which satisfy
the `predicate`.
raw docstring

descendant-with-tag

(descendant-with-tag element tag)
(descendant-with-tag element tag predicate)

Return the first descendant of this element, recursively, which has this tag. If predicate is specified, return the first also satisfying this predicate.

Return the first descendant of this `element`, recursively, which has this `tag`.
If `predicate` is specified, return the first also satisfying this `predicate`.
raw docstring

descendants-with-tag

(descendants-with-tag element tag)
(descendants-with-tag element tag predicate)

Return all descendants of this element, recursively, which have this tag. If predicate is specified, return only those also satisfying this predicate.

Return all descendants of this `element`, recursively, which have this `tag`.
If `predicate` is specified, return only those also satisfying this `predicate`.
raw docstring

distinct-properties

(distinct-properties entity)

editor-name

(editor-name entity application)

Return the path-part of the editor form for this entity. Note: assumes the editor form is the first form listed for the entity.

Return the path-part of the editor form for this `entity`. Note:
assumes the editor form is the first form listed for the entity.
raw docstring

element?

(element? o)

True if o is a Clojure representation of an XML element.

True if `o` is a Clojure representation of an XML element.
raw docstring

emit-header

(emit-header prefix & content)

Emit this content as a sequence of wrapped lines each prefixed with prefix, and the whole delimited by rules.

Emit this `content` as a sequence of wrapped lines each prefixed with
`prefix`, and the whole delimited by rules.
raw docstring

entity-for-property

(entity-for-property property application)

If this property references an entity, return that entity from this application

If this `property` references an entity, return that entity from this `application`
raw docstring

entity?

(entity? x)

Return true if x is an ADL entity.

Return true if `x` is an ADL entity.
raw docstring

find-permissions

(find-permissions & elements)

Return appropriate the permissions of the first of these elements which has permissions.

Return appropriate the permissions of the first of these `elements` which
has permissions.
raw docstring

formal-primary-key?

(formal-primary-key? prop-or-name entity)

Does this prop-or-name appear to be a property (or the name of a property) which is a formal primary key of this entity?

Does this `prop-or-name` appear to be a property (or the name of a property)
which is a formal primary key of this entity?
raw docstring

has-non-key-properties?

(has-non-key-properties? entity)

has-primary-key?

(has-primary-key? entity)

insertable-key-propertiesmacro

(insertable-key-properties entity)

insertable-propertiesmacro

(insertable-properties entity)

Return all the properties of this entity (including key properties) into which user-supplied data can be inserted

Return all the properties of this `entity` (including key properties) into
which user-supplied data can be inserted
raw docstring

insertable?

(insertable? property)

Return true it the value of this property may be set from user-supplied data.

Return `true` it the value of this `property` may be set from user-supplied data.
raw docstring

is-quotable-type?

(is-quotable-type? property application)

True if the value for this field should be quoted.

True if the value for this field should be quoted.
raw docstring

key-names

(key-names entity)
(key-names entity as-keywords?)

key-propertiesmacro

(key-properties entity)

(link-table-name e1 e2)
(link-table-name property e1 e2)

Canonical name of a link table between entity e1 and entity e2. However, there may be different links between the same two tables with different semantics; if property is specified, and if more than one property in e1 links to e2, generate a more specific link name.

Canonical name of a link table between entity `e1` and entity `e2`. However, there
may be different links between the same two tables with different semantics; if
`property` is specified, and if more than one property in `e1` links to `e2`, generate
a more specific link name.
raw docstring

(link-table? entity)

Return true if this entity represents a link table.

Return true if this `entity` represents a link table.
raw docstring

path-part

(path-part form entity application)

Return the URL path part for this form of this entity within this application. Note that form may be a Clojure XML representation of a form, list or page ADL element, or may be one of the keywords :form, :list, :page in which case the first child of the entity of the specified type will be used.

Return the URL path part for this `form` of this `entity` within this `application`.
Note that `form` may be a Clojure XML representation of a `form`, `list` or `page`
ADL element, or may be one of the keywords `:form`, `:list`, `:page` in which case the
first child of the `entity` of the specified type will be used.
raw docstring

permission-groups

(permission-groups permissions predicate)

Return a list of names of groups to which this predicate is true of some permission taken from these permissions, else nil.

Return a list of names of groups to which this `predicate` is true of
some permission taken from these `permissions`, else nil.
raw docstring

pretty-name

(pretty-name entity)

prompt

(prompt field-or-property form entity application)

Return an appropriate prompt for the given field-or-property taken from this form of this entity of this application, in the context of the current binding of *locale*. TODO: something more sophisticated about i18n

Return an appropriate prompt for the given `field-or-property` taken from this
`form` of this `entity` of this `application`, in the context of the current
binding of `*locale*`. TODO: something more sophisticated about i18n
raw docstring

propertiesmacro

(properties entity)

Return all the properties of this entity.

Return all the properties of this `entity`.
raw docstring

property-for-field

(property-for-field field entity)

Return the property within this entity which matches this field.

Return the property within this `entity` which matches this `field`.
raw docstring

property?

(property? o)

True if o is a property.

True if `o` is a property.
raw docstring

safe-name

(safe-name o)
(safe-name o convention)

Return a safe name for the object o, given the specified convention. o is expected to be either a string or an element.

Return a safe name for the object `o`, given the specified `convention`.
`o` is expected to be either a string or an element.
raw docstring

singularise

(singularise string)

Attempt to construct an idiomatic English-language singular of this string.

Attempt to construct an idiomatic English-language singular of this string.
raw docstring

sort-by-name

(sort-by-name elements)

type-for-defined

(type-for-defined property application)

typedef

(typedef property application)

If this property is of type defined, return its type definition from this application, else nil.

If this `property` is of type `defined`, return its type definition from
this `application`, else nil.
raw docstring

user-distinct-properties

(user-distinct-properties entity)

Return the properties of this entity which are user distinct

Return the properties of this `entity` which are user distinct
raw docstring

user-distinct-property-names

(user-distinct-property-names entity)

Return, as a set, the names of properties which are user distinct

Return, as a set, the names of properties which are user distinct
raw docstring

visible-to

(visible-to permissions)

Return a list of names of groups to which are granted read access, given these permissions, else nil.

Return a list of names of groups to which are granted read access,
given these `permissions`, else nil.
raw docstring

volatility

(volatility entity)

Return the cache ttl in seconds for records of this entity.

Return the cache ttl in seconds for records of this `entity`.
raw docstring

wrap-lines

(wrap-lines text)
(wrap-lines width text)

Wrap lines in this text to this width; return a list of lines.

Wrap lines in this `text` to this `width`; return a list of lines.
raw docstring

writeable-by

(writeable-by permissions)
(writeable-by permissions has-value?)

Return a list of names of groups to which are granted write access, given these permissions, else nil. TODO: TOTHINKABOUT: properties are also writeable by insert and noedit, but only if the current value is nil.

Return a list of names of groups to which are granted write access,
given these `permissions`, else nil.
TODO: TOTHINKABOUT: properties are also writeable by `insert` and `noedit`, but only if the
current value is nil.
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close