com.adobe.xmp.core

Interface XMPMetadata

All Superinterfaces:

java.lang.Iterable<XMPNode>, XMPNode, XMPStruct

public interface XMPMetadata
extends XMPStruct

This class represents the set of XMP metadata as a DOM representation. It represents the root node of the XMP tree. An XMPParser always creates an XMPMetadata object and a serializer only works on XMPMetadata objects. The root node is always an XMPStruct and the children are other XMPNodes.

Method Summary

Modifier and Type	Method and Description
XMPMetadata	clone() Deep clone of the XMP tree
java.lang.String	dump() returns a human readable version of this node tree (recursive)
XMPNode	get(XMPPath path) Return the node of the given path, relative to this node.
java.lang.String	getAboutURI() This correlates to the about-attribute, returns the empty String if no name is set.
XMPArray	getArray(XMPPath path) Returns an array from the given path, relative to this node.
XMPLanguageAlternative	getLanguageAlternative(XMPPath path) Returns a language Alternative from the given path, relative to this node.
XMPSimple	getSimple(XMPPath path) Returns a simple property from the given path, relative to this node.
XMPStruct	getStruct(XMPPath path) Returns a struct property from the given path, relative to this node.
XMPPath	getXMPPath() Return the path of this XMPNode
XMPNode	remove(XMPPath path) Remove a node at a given path, relative to this node
void	setAboutURI(java.lang.String name) Sets the value of rdf:about attribute for the XMP object.

Methods inherited from interface com.adobe.xmp.core.XMPStruct

copy, copy, copy, get, getArray, getLanguageAlternative, getNamespaceProperties, getSimple, getStruct, getUsedNamespaces, remove, renameField, setArray, setLanguageAlternative, setSimple, setStruct

Methods inherited from interface com.adobe.xmp.core.XMPNode

accept, accessQualifiers, adaptTo, copyReplace, getName, getNamespace, getParent, hasQualifiers, isArrayItem, iterator, size

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getAboutURI

java.lang.String getAboutURI()

This correlates to the about-attribute, returns the empty String if no name is set.

Returns:

Returns the value of rdf:about attribute for XMP object.

setAboutURI

void setAboutURI(java.lang.String name)

Sets the value of rdf:about attribute for the XMP object.

Parameters:

name - value to be set.

clone

XMPMetadata clone()

Deep clone of the XMP tree

Returns:

returns a deeply cloned copy of the XMP tree

getXMPPath

XMPPath getXMPPath()

Return the path of this XMPNode

Returns:

the path of this XMPNode

get

XMPNode get(XMPPath path)

Return the node of the given path, relative to this node.

Parameters:

path - the path to the desired node relative to this node

Returns:

the node at the path position or null if it could not be found

remove

XMPNode remove(XMPPath path)
        throws XMPException

Remove a node at a given path, relative to this node

Parameters:

path - the path to the node that shall be deleted

Returns:

the removed node or null, if nothing is removed

Throws:

XMPException - throws in case the remove path points to an xml:lang qualifier of a Language Alternative

getSimple

XMPSimple getSimple(XMPPath path)

Returns a simple property from the given path, relative to this node.

Parameters:

path - the path to the simple property, relative to this node.

Returns:

the desired simple property or null if there was none (or the type is different)

getStruct

XMPStruct getStruct(XMPPath path)

Returns a struct property from the given path, relative to this node.

Parameters:

path - the path to the struct property, relative to this node.

Returns:

the desired struct property or null if there was none (or the type is different)

getArray

XMPArray getArray(XMPPath path)

Returns an array from the given path, relative to this node.

Parameters:

path - the path to the array, relative to this node.

Returns:

the desired array or null if there was none (or the type is different)

getLanguageAlternative

XMPLanguageAlternative getLanguageAlternative(XMPPath path)

Returns a language Alternative from the given path, relative to this node.

Parameters:

path - the path to the langAlt, relative to this node.

Returns:

the desired langAlt or null if there was none (or the type is different)

dump

java.lang.String dump()

returns a human readable version of this node tree (recursive)

Returns:

returns a human readable version of this node tree (recursive)