clojure.data.xml — org.clojure/data.xml 0.1.0-beta1

Functions to parse XML into lazy sequences and lazy trees and emit these as text.

aggregate-xmlns clj

(aggregate-xmlns xml)

Put all occurring xmlns into the root

alias-ns clj

(alias-ns & {:as alias-nss})

Define a clojure namespace alias for shortened keyword and symbol namespaces. Similar to clojure.core/alias, but if namespace doesn't exist, it is created.

Example

(declare-ns :xml.dav "DAV:") (alias-ns :D :xml.dav) {:tag ::D/propfind :content []}

canonical-name clj

(canonical-name n)

Put (q)name into canonical form as per ns-env

cdata clj

(cdata content)

Create a CData node

declare-ns clj

(declare-ns & {:as cljns-xmlnss})

Define mappings in the global keyword-ns -> qname-uri mapping table. Arguments are pairs of ns-name - qname-uri ns-name must be a string, symbol, keyword or clojure namespace. The canonical form is string. ns-uri must be a string

element clj

(element tag)

(element tag attrs)

(element tag attrs & content)

Create an xml Element from content varargs

element* clj

(element* tag attrs content)

(element* tag attrs content meta)

Create an xml element from a content collection and optional metadata

element-nss clj

(element-nss {:keys [attrs] :as element})

Get xmlns environment from element

emit clj

(emit e writer & {:as opts})

Prints the given Element tree as XML text to stream. Options: :encoding <str> Character encoding to use

emit-str clj

(emit-str e & opts)

Emits the Element to String and returns it

event-seq clj

(event-seq source {:as props})

Parses the XML InputSource source using a pull-parser. Returns a lazy sequence of Event records. Accepts key pairs with XMLInputFactory options, see http://docs.oracle.com/javase/6/docs/api/javax/xml/stream/XMLInputFactory.html and xml-input-factory-props for more information. Defaults coalescing true and supporting-external-entities false. :include-node? can be a set of #{:start-element :end-element :characters :comment}

find-xmlns clj

(find-xmlns xml)

Find all xmlns occuring in a root

indent clj

(indent e writer & opts)

Emits the XML and indents the result. WARNING: this is slow it will emit the XML and read it in again to indent it. Intended for debugging/testing only.

indent-str clj

(indent-str e & opts)

Emits the XML and indents the result. Writes the results to a String and returns it

ns-uri clj

(ns-uri ns)

Look up xmlns uri to keyword namespace

parse clj

(parse source & opts)

Parses the source, which can be an InputStream or Reader, and returns a lazy tree of Element records. Accepts key pairs with XMLInputFactory options, see http://docs.oracle.com/javase/6/docs/api/javax/xml/stream/XMLInputFactory.html and xml-input-factory-props for more information. Defaults coalescing true.

parse-qname clj

parse-str clj

(parse-str s & opts)

Parses the passed in string to Clojure data structures. Accepts key pairs with XMLInputFactory options, see http://docs.oracle.com/javase/6/docs/api/javax/xml/stream/XMLInputFactory.html and xml-input-factory-props for more information. Defaults coalescing true.

qname clj

(qname name)

(qname uri name)

(qname uri name prefix)

qname-local clj

(qname-local qname)

Get the name for this qname

qname-uri clj

(qname-uri qname)

Get the namespace uri for this qname

sexp-as-element clj

(sexp-as-element sexp)

Convert a single sexp into an Element

sexps-as-fragment clj

(sexps-as-fragment)

(sexps-as-fragment sexp)

(sexps-as-fragment sexp & sexps)

Convert a compact prxml/hiccup-style data structure into the more formal tag/attrs/content format. A seq of elements will be returned, which may not be suitable for immediate use as there is no root element. See also sexp-as-element.

The format is [:tag-name attr-map? content*]. Each vector opens a new tag; seqs do not open new tags, and are just used for inserting groups of elements into the parent tag. A bare keyword not in a vector creates an empty element.

To provide XML conversion for your own data types, extend the AsElements protocol to them.

to-qname clj

(to-qname n)

uri-ns clj

(uri-ns uri)

Look up keyword namespace to xmlns uri

xml-comment clj

(xml-comment content)

Create a Comment node