javax.imageio.metadata.IIOMetadataNode — clojure-interop/javax.imageio 1.0.5

A class representing a node in a meta-data tree, which implements the org.w3c.dom.Element interface and additionally allows for the storage of non-textual objects via the getUserObject and setUserObject methods.

This class is not intended to be used for general XML processing. In particular, Element nodes created within the Image I/O API are not compatible with those created by Sun's standard implementation of the org.w3.dom API. In particular, the implementation is tuned for simple uses and may not perform well for intensive processing.

Namespaces are ignored in this implementation. The terms "tag name" and "node name" are always considered to be synonymous.

Note: The DOM Level 3 specification added a number of new methods to the Node, Element and Attr interfaces that are not of value to the IIOMetadataNode implementation or specification.

Calling such methods on an IIOMetadataNode, or an Attr instance returned from an IIOMetadataNode will result in a DOMException being thrown.

->iio-metadata-node clj

(->iio-metadata-node)

(->iio-metadata-node node-name)

Constructor.

Constructs an IIOMetadataNode with a given node name.

node-name - the name of the node, as a String. - java.lang.String

append-child clj

(append-child this new-child)

Adds the node newChild to the end of the list of children of this node.

new-child - the Node to insert. - org.w3c.dom.Node

returns: the node added. - org.w3c.dom.Node

throws: java.lang.IllegalArgumentException - if newChild is null.

clone-node clj

(clone-node this deep)

Returns a duplicate of this node. The duplicate node has no parent (getParentNode returns null). If a shallow clone is being performed (deep is false), the new node will not have any children or siblings. If a deep clone is being performed, the new node will form the root of a complete cloned subtree.

deep - if true, recursively clone the subtree under the specified node; if false, clone only the node itself. - boolean

returns: the duplicate node. - org.w3c.dom.Node

compare-document-position clj

(compare-document-position this other)

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

other - The node to compare against the reference node. - org.w3c.dom.Node

returns: Returns how the node is positioned relatively to the reference node. - short

throws: org.w3c.dom.DOMException - - always.

default-namespace? clj

(default-namespace? this namespace-uri)

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

namespace-uri - The namespace URI to look for. - java.lang.String

returns: Returns true if the specified namespaceURI is the default namespace, false otherwise. - boolean

throws: org.w3c.dom.DOMException - - always.

equal-node? clj

(equal-node? this node)

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

node - The node to compare equality with. - org.w3c.dom.Node

returns: Returns true if the nodes are equal, false otherwise. - boolean

throws: org.w3c.dom.DOMException - - always.

get-attribute clj

(get-attribute this name)

Retrieves an attribute value by name.

name - The name of the attribute to retrieve. - java.lang.String

returns: The Attr value as a string, or the empty string if that attribute does not have a specified or default value. - java.lang.String

get-attribute-node clj

(get-attribute-node this name)

Description copied from interface: Element

name - The name (nodeName) of the attribute to retrieve. - java.lang.String

returns: The Attr node with the specified name ( nodeName) or null if there is no such attribute. - org.w3c.dom.Attr

get-attribute-node-ns clj

(get-attribute-node-ns this namespace-uri local-name)

Equivalent to getAttributeNode(localName).

namespace-uri - The namespace URI of the attribute to retrieve. - java.lang.String local-name - The local name of the attribute to retrieve. - java.lang.String

returns: The Attr node with the specified attribute local name and namespace URI or null if there is no such attribute. - org.w3c.dom.Attr

get-attribute-ns clj

(get-attribute-ns this namespace-uri local-name)

Equivalent to getAttribute(localName).

namespace-uri - The namespace URI of the attribute to retrieve. - java.lang.String local-name - The local name of the attribute to retrieve. - java.lang.String

returns: The Attr value as a string, or the empty string if that attribute does not have a specified or default value. - java.lang.String

get-attributes clj

(get-attributes this)

Returns a NamedNodeMap containing the attributes of this node.

returns: a NamedNodeMap containing the attributes of this node. - org.w3c.dom.NamedNodeMap

get-base-uri clj

(get-base-uri this)

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

returns: java.lang.String

throws: org.w3c.dom.DOMException - - always.

get-child-nodes clj

(get-child-nodes this)

Returns a NodeList that contains all children of this node. If there are no children, this is a NodeList containing no nodes.

returns: the children as a NodeList - org.w3c.dom.NodeList

get-elements-by-tag-name clj

(get-elements-by-tag-name this name)

Description copied from interface: Element

name - The name of the tag to match on. The special value "*" matches all tags. - java.lang.String

returns: A list of matching Element nodes. - org.w3c.dom.NodeList

get-elements-by-tag-name-ns clj

(get-elements-by-tag-name-ns this namespace-uri local-name)

Equivalent to getElementsByTagName(localName).

namespace-uri - The namespace URI of the elements to match on. The special value "" matches all namespaces. - java.lang.String local-name - The local name of the elements to match on. The special value "" matches all local names. - java.lang.String

returns: A new NodeList object containing all the matched Elements. - org.w3c.dom.NodeList

get-feature clj

(get-feature this feature version)

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

feature - The name of the feature requested. Note that any plus sign "+" prepended to the name of the feature will be ignored since it is not significant in the context of this method. - java.lang.String version - This is the version number of the feature to test. - java.lang.String

returns: Returns an object which implements the specialized APIs of the specified feature and version, if any, or null if there is no object which implements interfaces associated with that feature. If the DOMObject returned by this method implements the Node interface, it must delegate to the primary core Node and not return results inconsistent with the primary core Node such as attributes, childNodes, etc. - java.lang.Object

throws: org.w3c.dom.DOMException - - always.

get-first-child clj

(get-first-child this)

Returns the first child of this node, or null if the node has no children.

returns: the first child, as a Node, or null - org.w3c.dom.Node

get-last-child clj

(get-last-child this)

Returns the last child of this node, or null if the node has no children.

returns: the last child, as a Node, or null. - org.w3c.dom.Node

get-length clj

(get-length this)

Description copied from interface: NodeList

returns: int

get-local-name clj

(get-local-name this)

Equivalent to getNodeName.

returns: the node name, as a String. - java.lang.String

get-namespace-uri clj

(get-namespace-uri this)

Returns null, since namespaces are not supported.

returns: java.lang.String

throws: org.w3c.dom.DOMException

get-next-sibling clj

(get-next-sibling this)

Returns the next sibling of this node, or null if the node has no next sibling.

returns: the next sibling, as a Node, or null. - org.w3c.dom.Node

get-node-name clj

(get-node-name this)

Returns the node name associated with this node.

returns: the node name, as a String. - java.lang.String

get-node-type clj

(get-node-type this)

Returns the node type, which is always ELEMENT_NODE.

returns: the short value ELEMENT_NODE. - short

get-node-value clj

(get-node-value this)

Returns the value associated with this node.

returns: the node value, as a String. - java.lang.String

get-owner-document clj

(get-owner-document this)

Returns null, since IIOMetadataNodes do not belong to any Document.

returns: null. - org.w3c.dom.Document

get-parent-node clj

(get-parent-node this)

Returns the parent of this node. A null value indicates that the node is the root of its own tree. To add a node to an existing tree, use one of the insertBefore, replaceChild, or appendChild methods.

returns: the parent, as a Node. - org.w3c.dom.Node

get-prefix clj

(get-prefix this)

Returns null, since namespaces are not supported.

returns: null. - java.lang.String

get-previous-sibling clj

(get-previous-sibling this)

Returns the previous sibling of this node, or null if this node has no previous sibling.

returns: the previous sibling, as a Node, or null. - org.w3c.dom.Node

get-schema-type-info clj

(get-schema-type-info this)

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

returns: org.w3c.dom.TypeInfo

throws: org.w3c.dom.DOMException - - always.

get-tag-name clj

(get-tag-name this)

Equivalent to getNodeName.

returns: the node name, as a String - java.lang.String

get-text-content clj

(get-text-content this)

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

returns: java.lang.String

throws: org.w3c.dom.DOMException - - always.

get-user-data clj

(get-user-data this key)

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

key - The key the object is associated to. - java.lang.String

returns: Returns the DOMUserData associated to the given key on this node, or null if there was none. - java.lang.Object

throws: org.w3c.dom.DOMException - - always.

get-user-object clj

(get-user-object this)

Returns the Object value associated with this node.

returns: the user Object. - java.lang.Object

has-attribute-ns? clj

(has-attribute-ns? this namespace-uri local-name)

Equivalent to hasAttribute(localName).

namespace-uri - The namespace URI of the attribute to look for. - java.lang.String local-name - The local name of the attribute to look for. - java.lang.String

returns: true if an attribute with the given local name and namespace URI is specified or has a default value on this element, false otherwise. - boolean

has-attribute? clj

(has-attribute? this name)

Description copied from interface: Element

name - The name of the attribute to look for. - java.lang.String

returns: true if an attribute with the given name is specified on this element or has a default value, false otherwise. - boolean

has-attributes? clj

(has-attributes? this)

Description copied from interface: Node

returns: Returns true if this node has any attributes, false otherwise. - boolean

has-child-nodes? clj

(has-child-nodes? this)

Returns true if this node has child nodes.

returns: true if this node has children. - boolean

insert-before clj

(insert-before this new-child ref-child)

Inserts the node newChild before the existing child node refChild. If refChild is null, insert newChild at the end of the list of children.

new-child - the Node to insert. - org.w3c.dom.Node ref-child - the reference Node. - org.w3c.dom.Node

returns: the node being inserted. - org.w3c.dom.Node

throws: java.lang.IllegalArgumentException - if newChild is null.

item clj

(item this index)

Description copied from interface: NodeList

index - Index into the collection. - int

returns: The node at the indexth position in the NodeList, or null if that is not a valid index. - org.w3c.dom.Node

lookup-namespace-uri clj

(lookup-namespace-uri this prefix)

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

prefix - The prefix to look for. If this parameter is null, the method will return the default namespace URI if any. - java.lang.String

returns: Returns the associated namespace URI or null if none is found. - java.lang.String

throws: org.w3c.dom.DOMException - - always.

lookup-prefix clj

(lookup-prefix this namespace-uri)

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

namespace-uri - The namespace URI to look for. - java.lang.String

returns: Returns an associated namespace prefix if found or null if none is found. If more than one prefix are associated to the namespace prefix, the returned namespace prefix is implementation dependent. - java.lang.String

throws: org.w3c.dom.DOMException - - always.

normalize clj

(normalize this)

Does nothing, since IIOMetadataNodes do not contain Text children.

remove-attribute clj

(remove-attribute this name)

Description copied from interface: Element

name - The name of the attribute to remove. - java.lang.String

remove-attribute-node clj

(remove-attribute-node this old-attr)

Description copied from interface: Element

old-attr - The Attr node to remove from the attribute list. - org.w3c.dom.Attr

returns: The Attr node that was removed. - org.w3c.dom.Attr

remove-attribute-ns clj

(remove-attribute-ns this namespace-uri local-name)

Equivalent to removeAttribute(localName).

namespace-uri - The namespace URI of the attribute to remove. - java.lang.String local-name - The local name of the attribute to remove. - java.lang.String

remove-child clj

(remove-child this old-child)

Removes the child node indicated by oldChild from the list of children, and returns it.

old-child - the Node to be removed. - org.w3c.dom.Node

returns: the node removed. - org.w3c.dom.Node

throws: java.lang.IllegalArgumentException - if oldChild is null.

replace-child clj

(replace-child this new-child old-child)

Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.

new-child - the Node to insert. - org.w3c.dom.Node old-child - the Node to be replaced. - org.w3c.dom.Node

returns: the node replaced. - org.w3c.dom.Node

throws: java.lang.IllegalArgumentException - if newChild is null.

same-node? clj

(same-node? this node)

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

node - The node to test against. - org.w3c.dom.Node

returns: Returns true if the nodes are the same, false otherwise. - boolean

throws: org.w3c.dom.DOMException - - always.

set-attribute clj

(set-attribute this name value)

Description copied from interface: Element

name - The name of the attribute to create or alter. - java.lang.String value - Value to set in string form. - java.lang.String

set-attribute-node clj

(set-attribute-node this new-attr)

Description copied from interface: Element

new-attr - The Attr node to add to the attribute list. - org.w3c.dom.Attr

returns: If the newAttr attribute replaces an existing attribute, the replaced Attr node is returned, otherwise null is returned. - org.w3c.dom.Attr

throws: org.w3c.dom.DOMException - WRONG_DOCUMENT_ERR: Raised if newAttr was created from a different document than the one that created the element. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. INUSE_ATTRIBUTE_ERR: Raised if newAttr is already an attribute of another Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements.

set-attribute-node-ns clj

(set-attribute-node-ns this new-attr)

Equivalent to setAttributeNode(newAttr).

new-attr - The Attr node to add to the attribute list. - org.w3c.dom.Attr

returns: If the newAttr attribute replaces an existing attribute with the same local name and namespace URI, the replaced Attr node is returned, otherwise null is returned. - org.w3c.dom.Attr

set-attribute-ns clj

(set-attribute-ns this namespace-uri qualified-name value)

Equivalent to setAttribute(qualifiedName, value).

namespace-uri - The namespace URI of the attribute to create or alter. - java.lang.String qualified-name - The qualified name of the attribute to create or alter. - java.lang.String value - The value to set in string form. - java.lang.String

set-id-attribute clj

(set-id-attribute this name is-id)

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

name - The name of the attribute. - java.lang.String is-id - Whether the attribute is a of type ID. - boolean

throws: org.w3c.dom.DOMException - - always.

set-id-attribute-node clj

(set-id-attribute-node this id-attr is-id)

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

id-attr - The attribute node. - org.w3c.dom.Attr is-id - Whether the attribute is a of type ID. - boolean

throws: org.w3c.dom.DOMException - - always.

set-id-attribute-ns clj

(set-id-attribute-ns this namespace-uri local-name is-id)

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

namespace-uri - The namespace URI of the attribute. - java.lang.String local-name - The local name of the attribute. - java.lang.String is-id - Whether the attribute is a of type ID. - boolean

throws: org.w3c.dom.DOMException - - always.

set-node-value clj

(set-node-value this node-value)

Sets the String value associated with this node.

node-value - java.lang.String

set-prefix clj

(set-prefix this prefix)

Does nothing, since namespaces are not supported.

prefix - a String, which is ignored. - java.lang.String

set-text-content clj

(set-text-content this text-content)

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

text-content - java.lang.String

throws: org.w3c.dom.DOMException - - always.

set-user-data clj

(set-user-data this key data handler)

This DOM Level 3 method is not supported for IIOMetadataNode and will throw a DOMException.

key - The key to associate the object to. - java.lang.String data - The object to associate to the given key, or null to remove any existing association to that key. - java.lang.Object handler - The handler to associate to that key, or null. - org.w3c.dom.UserDataHandler

returns: Returns the DOMUserData previously associated to the given key on this node, or null if there was none. - java.lang.Object

throws: org.w3c.dom.DOMException - - always.

set-user-object clj

(set-user-object this user-object)

Sets the value associated with this node.

user-object - the user Object. - java.lang.Object

supported? clj

(supported? this feature version)

Returns false since DOM features are not supported.

feature - a String, which is ignored. - java.lang.String version - a String, which is ignored. - java.lang.String

returns: false. - boolean