diff options
Diffstat (limited to 'java/XMPCore/docs/com/adobe/xmp/XMPMeta.html')
| -rw-r--r-- | java/XMPCore/docs/com/adobe/xmp/XMPMeta.html | 2301 |
1 files changed, 2301 insertions, 0 deletions
diff --git a/java/XMPCore/docs/com/adobe/xmp/XMPMeta.html b/java/XMPCore/docs/com/adobe/xmp/XMPMeta.html new file mode 100644 index 0000000..4c800af --- /dev/null +++ b/java/XMPCore/docs/com/adobe/xmp/XMPMeta.html @@ -0,0 +1,2301 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.5.0_07) on Thu May 03 14:54:49 CEST 2007 --> +<TITLE> +XMPMeta +</TITLE> + +<META NAME="keywords" CONTENT="com.adobe.xmp.XMPMeta interface"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="XMPMeta"; +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> + + +<!-- ========= START OF TOP NAVBAR ======= --> +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XMPMeta.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../com/adobe/xmp/XMPIterator.html" title="interface in com.adobe.xmp"><B>PREV CLASS</B></A> + <A HREF="../../../com/adobe/xmp/XMPMetaFactory.html" title="class in com.adobe.xmp"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../index.html?com/adobe/xmp/XMPMeta.html" target="_top"><B>FRAMES</B></A> + <A HREF="XMPMeta.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +com.adobe.xmp</FONT> +<BR> +Interface XMPMeta</H2> +<DL> +<DT><B>All Superinterfaces:</B> <DD>java.lang.Cloneable</DD> +</DL> +<HR> +<DL> +<DT><PRE>public interface <B>XMPMeta</B><DT>extends java.lang.Cloneable</DL> +</PRE> + +<P> +This class represents the set of XMP metadata as a DOM representation. It has methods to read and + modify all kinds of properties, create an iterator over all properties and serialize the metadata + to a String, byte-array or <code>OutputStream</code>. +<P> + +<P> +<DL> +<DT><B>Since:</B></DT> + <DD>20.01.2006</DD> +</DL> +<HR> + +<P> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#appendArrayItem(java.lang.String, java.lang.String, com.adobe.xmp.options.PropertyOptions, java.lang.String, com.adobe.xmp.options.PropertyOptions)">appendArrayItem</A></B>(java.lang.String schemaNS, + java.lang.String arrayName, + <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html" title="class in com.adobe.xmp.options">PropertyOptions</A> arrayOptions, + java.lang.String itemValue, + <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html" title="class in com.adobe.xmp.options">PropertyOptions</A> itemOptions)</CODE> + +<BR> + Simplifies the construction of an array by not requiring that you pre-create an empty array.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#appendArrayItem(java.lang.String, java.lang.String, java.lang.String)">appendArrayItem</A></B>(java.lang.String schemaNS, + java.lang.String arrayName, + java.lang.String itemValue)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.Object</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#clone()">clone</A></B>()</CODE> + +<BR> + Clones the complete metadata tree.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#countArrayItems(java.lang.String, java.lang.String)">countArrayItems</A></B>(java.lang.String schemaNS, + java.lang.String arrayName)</CODE> + +<BR> + Returns the number of items in the array.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#deleteArrayItem(java.lang.String, java.lang.String, int)">deleteArrayItem</A></B>(java.lang.String schemaNS, + java.lang.String arrayName, + int itemIndex)</CODE> + +<BR> + Deletes the given XMP subtree rooted at the given array item.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#deleteProperty(java.lang.String, java.lang.String)">deleteProperty</A></B>(java.lang.String schemaNS, + java.lang.String propName)</CODE> + +<BR> + Deletes the given XMP subtree rooted at the given property.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#deleteQualifier(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">deleteQualifier</A></B>(java.lang.String schemaNS, + java.lang.String propName, + java.lang.String qualNS, + java.lang.String qualName)</CODE> + +<BR> + Deletes the given XMP subtree rooted at the given qualifier.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#deleteStructField(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">deleteStructField</A></B>(java.lang.String schemaNS, + java.lang.String structName, + java.lang.String fieldNS, + java.lang.String fieldName)</CODE> + +<BR> + Deletes the given XMP subtree rooted at the given struct field.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#doesArrayItemExist(java.lang.String, java.lang.String, int)">doesArrayItemExist</A></B>(java.lang.String schemaNS, + java.lang.String arrayName, + int itemIndex)</CODE> + +<BR> + Tells if the array item exists.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#doesPropertyExist(java.lang.String, java.lang.String)">doesPropertyExist</A></B>(java.lang.String schemaNS, + java.lang.String propName)</CODE> + +<BR> + Returns whether the property exists.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#doesQualifierExist(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">doesQualifierExist</A></B>(java.lang.String schemaNS, + java.lang.String propName, + java.lang.String qualNS, + java.lang.String qualName)</CODE> + +<BR> + DoesQualifierExist tells if the qualifier exists.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#doesStructFieldExist(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">doesStructFieldExist</A></B>(java.lang.String schemaNS, + java.lang.String structName, + java.lang.String fieldNS, + java.lang.String fieldName)</CODE> + +<BR> + DoesStructFieldExist tells if the struct field exists.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#dumpObject()">dumpObject</A></B>()</CODE> + +<BR> + Renders this node and the tree unter this node in a human readable form.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../com/adobe/xmp/properties/XMPProperty.html" title="interface in com.adobe.xmp.properties">XMPProperty</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#getArrayItem(java.lang.String, java.lang.String, int)">getArrayItem</A></B>(java.lang.String schemaNS, + java.lang.String arrayName, + int itemIndex)</CODE> + +<BR> + Provides access to items within an array.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../com/adobe/xmp/properties/XMPProperty.html" title="interface in com.adobe.xmp.properties">XMPProperty</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#getLocalizedText(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">getLocalizedText</A></B>(java.lang.String schemaNS, + java.lang.String altTextName, + java.lang.String genericLang, + java.lang.String specificLang)</CODE> + +<BR> + These functions provide convenient support for localized text properties, including a number + of special and obscure aspects.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#getObjectName()">getObjectName</A></B>()</CODE> + +<BR> + This correlates to the about-attribute, + returns the empty String if no name is set.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../com/adobe/xmp/properties/XMPProperty.html" title="interface in com.adobe.xmp.properties">XMPProperty</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#getProperty(java.lang.String, java.lang.String)">getProperty</A></B>(java.lang.String schemaNS, + java.lang.String propName)</CODE> + +<BR> + The property value getter-methods all take a property specification: the first two parameters + are always the top level namespace URI (the "schema" namespace) and the basic name + of the property being referenced.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> byte[]</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#getPropertyBase64(java.lang.String, java.lang.String)">getPropertyBase64</A></B>(java.lang.String schemaNS, + java.lang.String propName)</CODE> + +<BR> + Convenience method to retrieve the literal value of a property.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.Boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#getPropertyBoolean(java.lang.String, java.lang.String)">getPropertyBoolean</A></B>(java.lang.String schemaNS, + java.lang.String propName)</CODE> + +<BR> + These are very similar to <code>getProperty()</code> and <code>SetProperty()</code> above, + but the value is returned or provided in a literal form instead of as a UTF-8 string.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.Calendar</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#getPropertyCalendar(java.lang.String, java.lang.String)">getPropertyCalendar</A></B>(java.lang.String schemaNS, + java.lang.String propName)</CODE> + +<BR> + Convenience method to retrieve the literal value of a property.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../com/adobe/xmp/XMPDateTime.html" title="interface in com.adobe.xmp">XMPDateTime</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#getPropertyDate(java.lang.String, java.lang.String)">getPropertyDate</A></B>(java.lang.String schemaNS, + java.lang.String propName)</CODE> + +<BR> + Convenience method to retrieve the literal value of a property.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.Double</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#getPropertyDouble(java.lang.String, java.lang.String)">getPropertyDouble</A></B>(java.lang.String schemaNS, + java.lang.String propName)</CODE> + +<BR> + Convenience method to retrieve the literal value of a property.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.Integer</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#getPropertyInteger(java.lang.String, java.lang.String)">getPropertyInteger</A></B>(java.lang.String schemaNS, + java.lang.String propName)</CODE> + +<BR> + Convenience method to retrieve the literal value of a property.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.Long</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#getPropertyLong(java.lang.String, java.lang.String)">getPropertyLong</A></B>(java.lang.String schemaNS, + java.lang.String propName)</CODE> + +<BR> + Convenience method to retrieve the literal value of a property.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#getPropertyString(java.lang.String, java.lang.String)">getPropertyString</A></B>(java.lang.String schemaNS, + java.lang.String propName)</CODE> + +<BR> + Convenience method to retrieve the literal value of a property.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../com/adobe/xmp/properties/XMPProperty.html" title="interface in com.adobe.xmp.properties">XMPProperty</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#getQualifier(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">getQualifier</A></B>(java.lang.String schemaNS, + java.lang.String propName, + java.lang.String qualNS, + java.lang.String qualName)</CODE> + +<BR> + Provides access to a qualifier attached to a property.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../com/adobe/xmp/properties/XMPProperty.html" title="interface in com.adobe.xmp.properties">XMPProperty</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#getStructField(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">getStructField</A></B>(java.lang.String schemaNS, + java.lang.String structName, + java.lang.String fieldNS, + java.lang.String fieldName)</CODE> + +<BR> + Provides access to fields within a nested structure.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#insertArrayItem(java.lang.String, java.lang.String, int, java.lang.String)">insertArrayItem</A></B>(java.lang.String schemaNS, + java.lang.String arrayName, + int itemIndex, + java.lang.String itemValue)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#insertArrayItem(java.lang.String, java.lang.String, int, java.lang.String, com.adobe.xmp.options.PropertyOptions)">insertArrayItem</A></B>(java.lang.String schemaNS, + java.lang.String arrayName, + int itemIndex, + java.lang.String itemValue, + <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html" title="class in com.adobe.xmp.options">PropertyOptions</A> options)</CODE> + +<BR> + Inserts an item into an array previous to the given index.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../com/adobe/xmp/XMPIterator.html" title="interface in com.adobe.xmp">XMPIterator</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#iterator()">iterator</A></B>()</CODE> + +<BR> + Constructs an iterator for the properties within this XMP object.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../com/adobe/xmp/XMPIterator.html" title="interface in com.adobe.xmp">XMPIterator</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#iterator(com.adobe.xmp.options.IteratorOptions)">iterator</A></B>(<A HREF="../../../com/adobe/xmp/options/IteratorOptions.html" title="class in com.adobe.xmp.options">IteratorOptions</A> options)</CODE> + +<BR> + Constructs an iterator for the properties within this XMP object using some options.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../com/adobe/xmp/XMPIterator.html" title="interface in com.adobe.xmp">XMPIterator</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#iterator(java.lang.String, java.lang.String, com.adobe.xmp.options.IteratorOptions)">iterator</A></B>(java.lang.String schemaNS, + java.lang.String propName, + <A HREF="../../../com/adobe/xmp/options/IteratorOptions.html" title="class in com.adobe.xmp.options">IteratorOptions</A> options)</CODE> + +<BR> + Construct an iterator for the properties within an XMP object.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#setArrayItem(java.lang.String, java.lang.String, int, java.lang.String)">setArrayItem</A></B>(java.lang.String schemaNS, + java.lang.String arrayName, + int itemIndex, + java.lang.String itemValue)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#setArrayItem(java.lang.String, java.lang.String, int, java.lang.String, com.adobe.xmp.options.PropertyOptions)">setArrayItem</A></B>(java.lang.String schemaNS, + java.lang.String arrayName, + int itemIndex, + java.lang.String itemValue, + <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html" title="class in com.adobe.xmp.options">PropertyOptions</A> options)</CODE> + +<BR> + Replaces an item within an array.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#setLocalizedText(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)">setLocalizedText</A></B>(java.lang.String schemaNS, + java.lang.String altTextName, + java.lang.String genericLang, + java.lang.String specificLang, + java.lang.String itemValue)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#setLocalizedText(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, com.adobe.xmp.options.PropertyOptions)">setLocalizedText</A></B>(java.lang.String schemaNS, + java.lang.String altTextName, + java.lang.String genericLang, + java.lang.String specificLang, + java.lang.String itemValue, + <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html" title="class in com.adobe.xmp.options">PropertyOptions</A> options)</CODE> + +<BR> + Modifies the value of a selected item in an alt-text array.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#setObjectName(java.lang.String)">setObjectName</A></B>(java.lang.String name)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#setProperty(java.lang.String, java.lang.String, java.lang.Object)">setProperty</A></B>(java.lang.String schemaNS, + java.lang.String propName, + java.lang.Object propValue)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#setProperty(java.lang.String, java.lang.String, java.lang.Object, com.adobe.xmp.options.PropertyOptions)">setProperty</A></B>(java.lang.String schemaNS, + java.lang.String propName, + java.lang.Object propValue, + <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html" title="class in com.adobe.xmp.options">PropertyOptions</A> options)</CODE> + +<BR> + The property value <code>setters</code> all take a property specification, their + differences are in the form of this.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#setPropertyBase64(java.lang.String, java.lang.String, byte[])">setPropertyBase64</A></B>(java.lang.String schemaNS, + java.lang.String propName, + byte[] propValue)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#setPropertyBase64(java.lang.String, java.lang.String, byte[], com.adobe.xmp.options.PropertyOptions)">setPropertyBase64</A></B>(java.lang.String schemaNS, + java.lang.String propName, + byte[] propValue, + <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html" title="class in com.adobe.xmp.options">PropertyOptions</A> options)</CODE> + +<BR> + Convenience method to set a property from a binary <code>byte[]</code>-array, + which is serialized as base64-string.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#setPropertyBoolean(java.lang.String, java.lang.String, boolean)">setPropertyBoolean</A></B>(java.lang.String schemaNS, + java.lang.String propName, + boolean propValue)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#setPropertyBoolean(java.lang.String, java.lang.String, boolean, com.adobe.xmp.options.PropertyOptions)">setPropertyBoolean</A></B>(java.lang.String schemaNS, + java.lang.String propName, + boolean propValue, + <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html" title="class in com.adobe.xmp.options">PropertyOptions</A> options)</CODE> + +<BR> + Convenience method to set a property to a literal <code>boolean</code> value.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#setPropertyCalendar(java.lang.String, java.lang.String, java.util.Calendar)">setPropertyCalendar</A></B>(java.lang.String schemaNS, + java.lang.String propName, + java.util.Calendar propValue)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#setPropertyCalendar(java.lang.String, java.lang.String, java.util.Calendar, com.adobe.xmp.options.PropertyOptions)">setPropertyCalendar</A></B>(java.lang.String schemaNS, + java.lang.String propName, + java.util.Calendar propValue, + <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html" title="class in com.adobe.xmp.options">PropertyOptions</A> options)</CODE> + +<BR> + Convenience method to set a property with a Java Calendar-object, + which is serialized to an ISO8601 date.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#setPropertyDate(java.lang.String, java.lang.String, com.adobe.xmp.XMPDateTime)">setPropertyDate</A></B>(java.lang.String schemaNS, + java.lang.String propName, + <A HREF="../../../com/adobe/xmp/XMPDateTime.html" title="interface in com.adobe.xmp">XMPDateTime</A> propValue)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#setPropertyDate(java.lang.String, java.lang.String, com.adobe.xmp.XMPDateTime, com.adobe.xmp.options.PropertyOptions)">setPropertyDate</A></B>(java.lang.String schemaNS, + java.lang.String propName, + <A HREF="../../../com/adobe/xmp/XMPDateTime.html" title="interface in com.adobe.xmp">XMPDateTime</A> propValue, + <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html" title="class in com.adobe.xmp.options">PropertyOptions</A> options)</CODE> + +<BR> + Convenience method to set a property with an XMPDateTime-object, + which is serialized to an ISO8601 date.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#setPropertyDouble(java.lang.String, java.lang.String, double)">setPropertyDouble</A></B>(java.lang.String schemaNS, + java.lang.String propName, + double propValue)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#setPropertyDouble(java.lang.String, java.lang.String, double, com.adobe.xmp.options.PropertyOptions)">setPropertyDouble</A></B>(java.lang.String schemaNS, + java.lang.String propName, + double propValue, + <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html" title="class in com.adobe.xmp.options">PropertyOptions</A> options)</CODE> + +<BR> + Convenience method to set a property to a literal <code>double</code> value.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#setPropertyInteger(java.lang.String, java.lang.String, int)">setPropertyInteger</A></B>(java.lang.String schemaNS, + java.lang.String propName, + int propValue)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#setPropertyInteger(java.lang.String, java.lang.String, int, com.adobe.xmp.options.PropertyOptions)">setPropertyInteger</A></B>(java.lang.String schemaNS, + java.lang.String propName, + int propValue, + <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html" title="class in com.adobe.xmp.options">PropertyOptions</A> options)</CODE> + +<BR> + Convenience method to set a property to a literal <code>int</code> value.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#setPropertyLong(java.lang.String, java.lang.String, long)">setPropertyLong</A></B>(java.lang.String schemaNS, + java.lang.String propName, + long propValue)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#setPropertyLong(java.lang.String, java.lang.String, long, com.adobe.xmp.options.PropertyOptions)">setPropertyLong</A></B>(java.lang.String schemaNS, + java.lang.String propName, + long propValue, + <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html" title="class in com.adobe.xmp.options">PropertyOptions</A> options)</CODE> + +<BR> + Convenience method to set a property to a literal <code>long</code> value.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#setQualifier(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)">setQualifier</A></B>(java.lang.String schemaNS, + java.lang.String propName, + java.lang.String qualNS, + java.lang.String qualName, + java.lang.String qualValue)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#setQualifier(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, com.adobe.xmp.options.PropertyOptions)">setQualifier</A></B>(java.lang.String schemaNS, + java.lang.String propName, + java.lang.String qualNS, + java.lang.String qualName, + java.lang.String qualValue, + <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html" title="class in com.adobe.xmp.options">PropertyOptions</A> options)</CODE> + +<BR> + Provides access to a qualifier attached to a property.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#setStructField(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)">setStructField</A></B>(java.lang.String schemaNS, + java.lang.String structName, + java.lang.String fieldNS, + java.lang.String fieldName, + java.lang.String fieldValue)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#setStructField(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, com.adobe.xmp.options.PropertyOptions)">setStructField</A></B>(java.lang.String schemaNS, + java.lang.String structName, + java.lang.String fieldNS, + java.lang.String fieldName, + java.lang.String fieldValue, + <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html" title="class in com.adobe.xmp.options">PropertyOptions</A> options)</CODE> + +<BR> + Provides access to fields within a nested structure.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../com/adobe/xmp/XMPMeta.html#sort()">sort</A></B>()</CODE> + +<BR> + Sorts the complete datamodel according to the following rules: + + Schema nodes are sorted by prefix.</TD> +</TR> +</TABLE> + +<P> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="getProperty(java.lang.String, java.lang.String)"><!-- --></A><H3> +getProperty</H3> +<PRE> +<A HREF="../../../com/adobe/xmp/properties/XMPProperty.html" title="interface in com.adobe.xmp.properties">XMPProperty</A> <B>getProperty</B>(java.lang.String schemaNS, + java.lang.String propName) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD>The property value getter-methods all take a property specification: the first two parameters + are always the top level namespace URI (the "schema" namespace) and the basic name + of the property being referenced. See the introductory discussion of path expression usage + for more information. + <p> + All of the functions return an object inherited from <code>PropertyBase</code> or + <code>null</code> if the property does not exists. The result object contains the value of + the property and option flags describing the property. Arrays and the non-leaf levels of + nodes do not have values. + <p> + See <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html" title="class in com.adobe.xmp.options"><CODE>PropertyOptions</CODE></A> for detailed information about the options. + <p> + This is the simplest property getter, mainly for top level simple properties or after using + the path composition functions in XMPPathFactory. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the property. May be <code>null</code> or the empty + string if the first component of the propName path contains a namespace prefix. The + URI must be for a registered namespace.<DD><CODE>propName</CODE> - The name of the property. May be a general path expression, must not be + <code>null</code> or the empty string. Using a namespace prefix on the first + component is optional. If present without a schemaNS value then the prefix specifies + the namespace. The prefix must be for a registered namespace. If both a schemaNS URI + and propName prefix are present, they must be corresponding parts of a registered + namespace. +<DT><B>Returns:</B><DD>Returns a <code>XMPProperty</code> containing the value and the options or + <code>null</code> if the property does not exist. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all errors and exceptions that may occur.</DL> +</DD> +</DL> +<HR> + +<A NAME="getArrayItem(java.lang.String, java.lang.String, int)"><!-- --></A><H3> +getArrayItem</H3> +<PRE> +<A HREF="../../../com/adobe/xmp/properties/XMPProperty.html" title="interface in com.adobe.xmp.properties">XMPProperty</A> <B>getArrayItem</B>(java.lang.String schemaNS, + java.lang.String arrayName, + int itemIndex) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD>Provides access to items within an array. The index is passed as an integer, you need not + worry about the path string syntax for array items, convert a loop index to a string, etc. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the array. Has the same usage as in getProperty.<DD><CODE>arrayName</CODE> - The name of the array. May be a general path expression, must not be + <code>null</code> or the empty string. Has the same namespace prefix usage as + propName in <code>getProperty()</code>.<DD><CODE>itemIndex</CODE> - The index of the desired item. Arrays in XMP are indexed from 1. The + constant <A HREF="../../../com/adobe/xmp/XMPConst.html#ARRAY_LAST_ITEM"><CODE>XMPConst.ARRAY_LAST_ITEM</CODE></A> always refers to the last existing array + item. +<DT><B>Returns:</B><DD>Returns a <code>XMPProperty</code> containing the value and the options or + <code>null</code> if the property does not exist. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all errors and exceptions that may occur.</DL> +</DD> +</DL> +<HR> + +<A NAME="countArrayItems(java.lang.String, java.lang.String)"><!-- --></A><H3> +countArrayItems</H3> +<PRE> +int <B>countArrayItems</B>(java.lang.String schemaNS, + java.lang.String arrayName) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD>Returns the number of items in the array. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the array. Has the same usage as in getProperty.<DD><CODE>arrayName</CODE> - The name of the array. May be a general path expression, must not be + <code>null</code> or the empty string. Has the same namespace prefix usage as + propName in <code>getProperty()</code>. +<DT><B>Returns:</B><DD>Returns the number of items in the array. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all errors and exceptions that may occur.</DL> +</DD> +</DL> +<HR> + +<A NAME="getStructField(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> +getStructField</H3> +<PRE> +<A HREF="../../../com/adobe/xmp/properties/XMPProperty.html" title="interface in com.adobe.xmp.properties">XMPProperty</A> <B>getStructField</B>(java.lang.String schemaNS, + java.lang.String structName, + java.lang.String fieldNS, + java.lang.String fieldName) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD>Provides access to fields within a nested structure. The namespace for the field is passed as + a URI, you need not worry about the path string syntax. + <p> + The names of fields should be XML qualified names, that is within an XML namespace. The path + syntax for a qualified name uses the namespace prefix. This is unreliable since the prefix is + never guaranteed. The URI is the formal name, the prefix is just a local shorthand in a given + sequence of XML text. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the struct. Has the same usage as in getProperty.<DD><CODE>structName</CODE> - The name of the struct. May be a general path expression, must not be + <code>null</code> or the empty string. Has the same namespace prefix usage as + propName in <code>getProperty()</code>.<DD><CODE>fieldNS</CODE> - The namespace URI for the field. Has the same URI and prefix usage as the + schemaNS parameter.<DD><CODE>fieldName</CODE> - The name of the field. Must be a single XML name, must not be + <code>null</code> or the empty string. Has the same namespace prefix usage as the + structName parameter. +<DT><B>Returns:</B><DD>Returns a <code>XMPProperty</code> containing the value and the options or + <code>null</code> if the property does not exist. Arrays and non-leaf levels of + structs do not have values. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all errors and exceptions that may occur.</DL> +</DD> +</DL> +<HR> + +<A NAME="getQualifier(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> +getQualifier</H3> +<PRE> +<A HREF="../../../com/adobe/xmp/properties/XMPProperty.html" title="interface in com.adobe.xmp.properties">XMPProperty</A> <B>getQualifier</B>(java.lang.String schemaNS, + java.lang.String propName, + java.lang.String qualNS, + java.lang.String qualName) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD>Provides access to a qualifier attached to a property. The namespace for the qualifier is + passed as a URI, you need not worry about the path string syntax. In many regards qualifiers + are like struct fields. See the introductory discussion of qualified properties for more + information. + <p> + The names of qualifiers should be XML qualified names, that is within an XML namespace. The + path syntax for a qualified name uses the namespace prefix. This is unreliable since the + prefix is never guaranteed. The URI is the formal name, the prefix is just a local shorthand + in a given sequence of XML text. + <p> + <em>Note:</em> Qualifiers are only supported for simple leaf properties at this time. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the struct. Has the same usage as in getProperty.<DD><CODE>propName</CODE> - The name of the property to which the qualifier is attached. May be a general + path expression, must not be <code>null</code> or the empty string. Has the same + namespace prefix usage as in <code>getProperty()</code>.<DD><CODE>qualNS</CODE> - The namespace URI for the qualifier. Has the same URI and prefix usage as the + schemaNS parameter.<DD><CODE>qualName</CODE> - The name of the qualifier. Must be a single XML name, must not be + <code>null</code> or the empty string. Has the same namespace prefix usage as the + propName parameter. +<DT><B>Returns:</B><DD>Returns a <code>XMPProperty</code> containing the value and the options of the + qualifier or <code>null</code> if the property does not exist. The name of the + qualifier must be a single XML name, must not be <code>null</code> or the empty + string. Has the same namespace prefix usage as the propName parameter. + <p> + The value of the qualifier is only set if it has one (Arrays and non-leaf levels of + structs do not have values). +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all errors and exceptions that may occur.</DL> +</DD> +</DL> +<HR> + +<A NAME="setProperty(java.lang.String, java.lang.String, java.lang.Object, com.adobe.xmp.options.PropertyOptions)"><!-- --></A><H3> +setProperty</H3> +<PRE> +void <B>setProperty</B>(java.lang.String schemaNS, + java.lang.String propName, + java.lang.Object propValue, + <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html" title="class in com.adobe.xmp.options">PropertyOptions</A> options) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD>The property value <code>setters</code> all take a property specification, their + differences are in the form of this. The first two parameters are always the top level + namespace URI (the <code>schema</code> namespace) and the basic name of the property being + referenced. See the introductory discussion of path expression usage for more information. + <p> + All of the functions take a string value for the property and option flags describing the + property. The value must be Unicode in UTF-8 encoding. Arrays and non-leaf levels of structs + do not have values. Empty arrays and structs may be created using appropriate option flags. + All levels of structs that is assigned implicitly are created if necessary. appendArayItem + implicitly creates the named array if necessary. + <p> + See <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html" title="class in com.adobe.xmp.options"><CODE>PropertyOptions</CODE></A> for detailed information about the options. + <p> + This is the simplest property setter, mainly for top level simple properties or after using + the path composition functions in <A HREF="../../../com/adobe/xmp/XMPPathFactory.html" title="class in com.adobe.xmp"><CODE>XMPPathFactory</CODE></A>. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the property. Has the same usage as in getProperty.<DD><CODE>propName</CODE> - The name of the property. + Has the same usage as in <code>getProperty()</code>.<DD><CODE>propValue</CODE> - the value for the property (only leaf properties have a value). + Arrays and non-leaf levels of structs do not have values. + Must be <code>null</code> if the value is not relevant.<br/> + The value is automatically detected: Boolean, Integer, Long, Double, XMPDateTime and + byte[] are handled, on all other <code>toString()</code> is called.<DD><CODE>options</CODE> - Option flags describing the property. See the earlier description. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all errors and exceptions that may occur.</DL> +</DD> +</DL> +<HR> + +<A NAME="setProperty(java.lang.String, java.lang.String, java.lang.Object)"><!-- --></A><H3> +setProperty</H3> +<PRE> +void <B>setProperty</B>(java.lang.String schemaNS, + java.lang.String propName, + java.lang.Object propValue) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI<DD><CODE>propName</CODE> - The name of the property<DD><CODE>propValue</CODE> - the value for the property +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all errors and exceptions<DT><B>See Also:</B><DD><A HREF="../../../com/adobe/xmp/XMPMeta.html#setProperty(java.lang.String, java.lang.String, java.lang.Object, com.adobe.xmp.options.PropertyOptions)"><CODE>setProperty(String, String, Object, PropertyOptions)</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="setArrayItem(java.lang.String, java.lang.String, int, java.lang.String, com.adobe.xmp.options.PropertyOptions)"><!-- --></A><H3> +setArrayItem</H3> +<PRE> +void <B>setArrayItem</B>(java.lang.String schemaNS, + java.lang.String arrayName, + int itemIndex, + java.lang.String itemValue, + <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html" title="class in com.adobe.xmp.options">PropertyOptions</A> options) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD>Replaces an item within an array. The index is passed as an integer, you need not worry about + the path string syntax for array items, convert a loop index to a string, etc. The array + passed must already exist. In normal usage the selected array item is modified. A new item is + automatically appended if the index is the array size plus 1. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the array. Has the same usage as in getProperty.<DD><CODE>arrayName</CODE> - The name of the array. May be a general path expression, must not be + <code>null</code> or the empty string. Has the same namespace prefix usage as + propName in getProperty.<DD><CODE>itemIndex</CODE> - The index of the desired item. Arrays in XMP are indexed from 1. To address + the last existing item, use <A HREF="../../../com/adobe/xmp/XMPMeta.html#countArrayItems(java.lang.String, java.lang.String)"><CODE>countArrayItems(String, String)</CODE></A> to find + out the length of the array.<DD><CODE>itemValue</CODE> - the new value of the array item. Has the same usage as propValue in + <code>setProperty()</code>.<DD><CODE>options</CODE> - the set options for the item. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all errors and exceptions that may occur.</DL> +</DD> +</DL> +<HR> + +<A NAME="setArrayItem(java.lang.String, java.lang.String, int, java.lang.String)"><!-- --></A><H3> +setArrayItem</H3> +<PRE> +void <B>setArrayItem</B>(java.lang.String schemaNS, + java.lang.String arrayName, + int itemIndex, + java.lang.String itemValue) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI<DD><CODE>arrayName</CODE> - The name of the array<DD><CODE>itemIndex</CODE> - The index to insert the new item<DD><CODE>itemValue</CODE> - the new value of the array item +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all errors and exceptions<DT><B>See Also:</B><DD><A HREF="../../../com/adobe/xmp/XMPMeta.html#setArrayItem(java.lang.String, java.lang.String, int, java.lang.String, com.adobe.xmp.options.PropertyOptions)"><CODE>setArrayItem(String, String, int, String, PropertyOptions)</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="insertArrayItem(java.lang.String, java.lang.String, int, java.lang.String, com.adobe.xmp.options.PropertyOptions)"><!-- --></A><H3> +insertArrayItem</H3> +<PRE> +void <B>insertArrayItem</B>(java.lang.String schemaNS, + java.lang.String arrayName, + int itemIndex, + java.lang.String itemValue, + <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html" title="class in com.adobe.xmp.options">PropertyOptions</A> options) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD>Inserts an item into an array previous to the given index. The index is passed as an integer, + you need not worry about the path string syntax for array items, convert a loop index to a + string, etc. The array passed must already exist. In normal usage the selected array item is + modified. A new item is automatically appended if the index is the array size plus 1. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the array. Has the same usage as in getProperty.<DD><CODE>arrayName</CODE> - The name of the array. May be a general path expression, must not be + <code>null</code> or the empty string. Has the same namespace prefix usage as + propName in getProperty.<DD><CODE>itemIndex</CODE> - The index to insert the new item. Arrays in XMP are indexed from 1. Use + <code>XMPConst.ARRAY_LAST_ITEM</code> to append items.<DD><CODE>itemValue</CODE> - the new value of the array item. Has the same usage as + propValue in <code>setProperty()</code>.<DD><CODE>options</CODE> - the set options that decide about the kind of the node. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all errors and exceptions that may occur.</DL> +</DD> +</DL> +<HR> + +<A NAME="insertArrayItem(java.lang.String, java.lang.String, int, java.lang.String)"><!-- --></A><H3> +insertArrayItem</H3> +<PRE> +void <B>insertArrayItem</B>(java.lang.String schemaNS, + java.lang.String arrayName, + int itemIndex, + java.lang.String itemValue) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the array<DD><CODE>arrayName</CODE> - The name of the array<DD><CODE>itemIndex</CODE> - The index to insert the new item<DD><CODE>itemValue</CODE> - the value of the array item +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all errors and exceptions<DT><B>See Also:</B><DD><A HREF="../../../com/adobe/xmp/XMPMeta.html#insertArrayItem(java.lang.String, java.lang.String, int, java.lang.String, com.adobe.xmp.options.PropertyOptions)"><CODE>insertArrayItem(String, String, int, String, PropertyOptions)</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="appendArrayItem(java.lang.String, java.lang.String, com.adobe.xmp.options.PropertyOptions, java.lang.String, com.adobe.xmp.options.PropertyOptions)"><!-- --></A><H3> +appendArrayItem</H3> +<PRE> +void <B>appendArrayItem</B>(java.lang.String schemaNS, + java.lang.String arrayName, + <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html" title="class in com.adobe.xmp.options">PropertyOptions</A> arrayOptions, + java.lang.String itemValue, + <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html" title="class in com.adobe.xmp.options">PropertyOptions</A> itemOptions) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD>Simplifies the construction of an array by not requiring that you pre-create an empty array. + The array that is assigned is created automatically if it does not yet exist. Each call to + appendArrayItem() appends an item to the array. The corresponding parameters have the same + use as setArrayItem(). The arrayOptions parameter is used to specify what kind of array. If + the array exists, it must have the specified form. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the array. Has the same usage as in getProperty.<DD><CODE>arrayName</CODE> - The name of the array. May be a general path expression, must not be null or + the empty string. Has the same namespace prefix usage as propPath in getProperty.<DD><CODE>arrayOptions</CODE> - Option flags describing the array form. The only valid options are + <ul> + <li> <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html#ARRAY"><CODE>PropertyOptions.ARRAY</CODE></A>, + <li> <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html#ARRAY_ORDERED"><CODE>PropertyOptions.ARRAY_ORDERED</CODE></A>, + <li> <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html#ARRAY_ALTERNATE"><CODE>PropertyOptions.ARRAY_ALTERNATE</CODE></A> or + <li> <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html#ARRAY_ALT_TEXT"><CODE>PropertyOptions.ARRAY_ALT_TEXT</CODE></A>. + </ul> + <em>Note:</em> the array options only need to be provided if the array is not + already existing, otherwise you can set them to <code>null</code> or use + <A HREF="../../../com/adobe/xmp/XMPMeta.html#appendArrayItem(java.lang.String, java.lang.String, java.lang.String)"><CODE>appendArrayItem(String, String, String)</CODE></A>.<DD><CODE>itemValue</CODE> - the value of the array item. Has the same usage as propValue in getProperty.<DD><CODE>itemOptions</CODE> - Option flags describing the item to append (<A HREF="../../../com/adobe/xmp/options/PropertyOptions.html" title="class in com.adobe.xmp.options"><CODE>PropertyOptions</CODE></A>) +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all errors and exceptions that may occur.</DL> +</DD> +</DL> +<HR> + +<A NAME="appendArrayItem(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> +appendArrayItem</H3> +<PRE> +void <B>appendArrayItem</B>(java.lang.String schemaNS, + java.lang.String arrayName, + java.lang.String itemValue) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the array<DD><CODE>arrayName</CODE> - The name of the array<DD><CODE>itemValue</CODE> - the value of the array item +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all errors and exceptions<DT><B>See Also:</B><DD><A HREF="../../../com/adobe/xmp/XMPMeta.html#appendArrayItem(java.lang.String, java.lang.String, com.adobe.xmp.options.PropertyOptions, java.lang.String, com.adobe.xmp.options.PropertyOptions)"><CODE>appendArrayItem(String, String, PropertyOptions, String, PropertyOptions)</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="setStructField(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, com.adobe.xmp.options.PropertyOptions)"><!-- --></A><H3> +setStructField</H3> +<PRE> +void <B>setStructField</B>(java.lang.String schemaNS, + java.lang.String structName, + java.lang.String fieldNS, + java.lang.String fieldName, + java.lang.String fieldValue, + <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html" title="class in com.adobe.xmp.options">PropertyOptions</A> options) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD>Provides access to fields within a nested structure. The namespace for the field is passed as + a URI, you need not worry about the path string syntax. The names of fields should be XML + qualified names, that is within an XML namespace. The path syntax for a qualified name uses + the namespace prefix, which is unreliable because the prefix is never guaranteed. The URI is + the formal name, the prefix is just a local shorthand in a given sequence of XML text. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the struct. Has the same usage as in getProperty.<DD><CODE>structName</CODE> - The name of the struct. May be a general path expression, must not be null + or the empty string. Has the same namespace prefix usage as propName in getProperty.<DD><CODE>fieldNS</CODE> - The namespace URI for the field. Has the same URI and prefix usage as the + schemaNS parameter.<DD><CODE>fieldName</CODE> - The name of the field. Must be a single XML name, must not be null or the + empty string. Has the same namespace prefix usage as the structName parameter.<DD><CODE>fieldValue</CODE> - the value of thefield, if the field has a value. + Has the same usage as propValue in getProperty.<DD><CODE>options</CODE> - Option flags describing the field. See the earlier description. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all errors and exceptions that may occur.</DL> +</DD> +</DL> +<HR> + +<A NAME="setStructField(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> +setStructField</H3> +<PRE> +void <B>setStructField</B>(java.lang.String schemaNS, + java.lang.String structName, + java.lang.String fieldNS, + java.lang.String fieldName, + java.lang.String fieldValue) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the struct<DD><CODE>structName</CODE> - The name of the struct<DD><CODE>fieldNS</CODE> - The namespace URI for the field<DD><CODE>fieldName</CODE> - The name of the field<DD><CODE>fieldValue</CODE> - the value of the field +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all errors and exceptions<DT><B>See Also:</B><DD><A HREF="../../../com/adobe/xmp/XMPMeta.html#setStructField(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, com.adobe.xmp.options.PropertyOptions)"><CODE>setStructField(String, String, String, String, String, PropertyOptions)</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="setQualifier(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, com.adobe.xmp.options.PropertyOptions)"><!-- --></A><H3> +setQualifier</H3> +<PRE> +void <B>setQualifier</B>(java.lang.String schemaNS, + java.lang.String propName, + java.lang.String qualNS, + java.lang.String qualName, + java.lang.String qualValue, + <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html" title="class in com.adobe.xmp.options">PropertyOptions</A> options) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD>Provides access to a qualifier attached to a property. The namespace for the qualifier is + passed as a URI, you need not worry about the path string syntax. In many regards qualifiers + are like struct fields. See the introductory discussion of qualified properties for more + information. The names of qualifiers should be XML qualified names, that is within an XML + namespace. The path syntax for a qualified name uses the namespace prefix, which is + unreliable because the prefix is never guaranteed. The URI is the formal name, the prefix is + just a local shorthand in a given sequence of XML text. The property the qualifier + will be attached has to exist. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the struct. Has the same usage as in getProperty.<DD><CODE>propName</CODE> - The name of the property to which the qualifier is attached. Has the same + usage as in getProperty.<DD><CODE>qualNS</CODE> - The namespace URI for the qualifier. Has the same URI and prefix usage as the + schemaNS parameter.<DD><CODE>qualName</CODE> - The name of the qualifier. Must be a single XML name, must not be + <code>null</code> or the empty string. Has the same namespace prefix usage as the + propName parameter.<DD><CODE>qualValue</CODE> - A pointer to the <code>null</code> terminated UTF-8 string that is the + value of the qualifier, if the qualifier has a value. Has the same usage as propValue + in getProperty.<DD><CODE>options</CODE> - Option flags describing the qualifier. See the earlier description. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all errors and exceptions that may occur.</DL> +</DD> +</DL> +<HR> + +<A NAME="setQualifier(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> +setQualifier</H3> +<PRE> +void <B>setQualifier</B>(java.lang.String schemaNS, + java.lang.String propName, + java.lang.String qualNS, + java.lang.String qualName, + java.lang.String qualValue) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the struct<DD><CODE>propName</CODE> - The name of the property to which the qualifier is attached<DD><CODE>qualNS</CODE> - The namespace URI for the qualifier<DD><CODE>qualName</CODE> - The name of the qualifier<DD><CODE>qualValue</CODE> - the value of the qualifier +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all errors and exceptions<DT><B>See Also:</B><DD><A HREF="../../../com/adobe/xmp/XMPMeta.html#setQualifier(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, com.adobe.xmp.options.PropertyOptions)"><CODE>setQualifier(String, String, String, String, String, PropertyOptions)</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="deleteProperty(java.lang.String, java.lang.String)"><!-- --></A><H3> +deleteProperty</H3> +<PRE> +void <B>deleteProperty</B>(java.lang.String schemaNS, + java.lang.String propName)</PRE> +<DL> +<DD>Deletes the given XMP subtree rooted at the given property. It is not an error if the + property does not exist. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the property. Has the same usage as in + <code>getProperty()</code>.<DD><CODE>propName</CODE> - The name of the property. Has the same usage as in getProperty.</DL> +</DD> +</DL> +<HR> + +<A NAME="deleteArrayItem(java.lang.String, java.lang.String, int)"><!-- --></A><H3> +deleteArrayItem</H3> +<PRE> +void <B>deleteArrayItem</B>(java.lang.String schemaNS, + java.lang.String arrayName, + int itemIndex)</PRE> +<DL> +<DD>Deletes the given XMP subtree rooted at the given array item. It is not an error if the array + item does not exist. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the array. Has the same usage as in getProperty.<DD><CODE>arrayName</CODE> - The name of the array. May be a general path expression, must not be + <code>null</code> or the empty string. Has the same namespace prefix usage as + propName in <code>getProperty()</code>.<DD><CODE>itemIndex</CODE> - The index of the desired item. Arrays in XMP are indexed from 1. The + constant <code>XMPConst.ARRAY_LAST_ITEM</code> always refers to the last + existing array item.</DL> +</DD> +</DL> +<HR> + +<A NAME="deleteStructField(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> +deleteStructField</H3> +<PRE> +void <B>deleteStructField</B>(java.lang.String schemaNS, + java.lang.String structName, + java.lang.String fieldNS, + java.lang.String fieldName)</PRE> +<DL> +<DD>Deletes the given XMP subtree rooted at the given struct field. It is not an error if the + field does not exist. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the struct. Has the same usage as in + <code>getProperty()</code>.<DD><CODE>structName</CODE> - The name of the struct. May be a general path expression, must not be + <code>null</code> or the empty string. Has the same namespace prefix usage as + propName in getProperty.<DD><CODE>fieldNS</CODE> - The namespace URI for the field. Has the same URI and prefix usage as the + schemaNS parameter.<DD><CODE>fieldName</CODE> - The name of the field. Must be a single XML name, must not be + <code>null</code> or the empty string. Has the same namespace prefix usage as the + structName parameter.</DL> +</DD> +</DL> +<HR> + +<A NAME="deleteQualifier(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> +deleteQualifier</H3> +<PRE> +void <B>deleteQualifier</B>(java.lang.String schemaNS, + java.lang.String propName, + java.lang.String qualNS, + java.lang.String qualName)</PRE> +<DL> +<DD>Deletes the given XMP subtree rooted at the given qualifier. It is not an error if the + qualifier does not exist. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the struct. Has the same usage as in + <code>getProperty()</code>.<DD><CODE>propName</CODE> - The name of the property to which the qualifier is attached. Has the same + usage as in getProperty.<DD><CODE>qualNS</CODE> - The namespace URI for the qualifier. Has the same URI and prefix usage as the + schemaNS parameter.<DD><CODE>qualName</CODE> - The name of the qualifier. Must be a single XML name, must not be + <code>null</code> or the empty string. Has the same namespace prefix usage as the + propName parameter.</DL> +</DD> +</DL> +<HR> + +<A NAME="doesPropertyExist(java.lang.String, java.lang.String)"><!-- --></A><H3> +doesPropertyExist</H3> +<PRE> +boolean <B>doesPropertyExist</B>(java.lang.String schemaNS, + java.lang.String propName)</PRE> +<DL> +<DD>Returns whether the property exists. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the property. Has the same usage as in + <code>getProperty()</code>.<DD><CODE>propName</CODE> - The name of the property. + Has the same usage as in <code>getProperty()</code>. +<DT><B>Returns:</B><DD>Returns true if the property exists.</DL> +</DD> +</DL> +<HR> + +<A NAME="doesArrayItemExist(java.lang.String, java.lang.String, int)"><!-- --></A><H3> +doesArrayItemExist</H3> +<PRE> +boolean <B>doesArrayItemExist</B>(java.lang.String schemaNS, + java.lang.String arrayName, + int itemIndex)</PRE> +<DL> +<DD>Tells if the array item exists. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the array. Has the same usage as in + <code>getProperty()</code>.<DD><CODE>arrayName</CODE> - The name of the array. May be a general path expression, must not be + <code>null</code> or the empty string. Has the same namespace prefix usage as + propName in <code>getProperty()</code>.<DD><CODE>itemIndex</CODE> - The index of the desired item. Arrays in XMP are indexed from 1. The + constant <code>XMPConst.ARRAY_LAST_ITEM</code> always refers to the last + existing array item. +<DT><B>Returns:</B><DD>Returns <code>true</code> if the array exists, <code>false</code> otherwise.</DL> +</DD> +</DL> +<HR> + +<A NAME="doesStructFieldExist(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> +doesStructFieldExist</H3> +<PRE> +boolean <B>doesStructFieldExist</B>(java.lang.String schemaNS, + java.lang.String structName, + java.lang.String fieldNS, + java.lang.String fieldName)</PRE> +<DL> +<DD>DoesStructFieldExist tells if the struct field exists. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the struct. Has the same usage as in + <code>getProperty()</code>.<DD><CODE>structName</CODE> - The name of the struct. May be a general path expression, must not be + <code>null</code> or the empty string. Has the same namespace prefix usage as + propName in <code>getProperty()</code>.<DD><CODE>fieldNS</CODE> - The namespace URI for the field. Has the same URI and prefix usage as the + schemaNS parameter.<DD><CODE>fieldName</CODE> - The name of the field. Must be a single XML name, must not be + <code>null</code> or the empty string. Has the same namespace prefix usage as the + structName parameter. +<DT><B>Returns:</B><DD>Returns true if the field exists.</DL> +</DD> +</DL> +<HR> + +<A NAME="doesQualifierExist(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> +doesQualifierExist</H3> +<PRE> +boolean <B>doesQualifierExist</B>(java.lang.String schemaNS, + java.lang.String propName, + java.lang.String qualNS, + java.lang.String qualName)</PRE> +<DL> +<DD>DoesQualifierExist tells if the qualifier exists. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the struct. Has the same usage as in + <code>getProperty()</code>.<DD><CODE>propName</CODE> - The name of the property to which the qualifier is attached. Has the same + usage as in <code>getProperty()</code>.<DD><CODE>qualNS</CODE> - The namespace URI for the qualifier. Has the same URI and prefix usage as the + schemaNS parameter.<DD><CODE>qualName</CODE> - The name of the qualifier. Must be a single XML name, must not be + <code>null</code> or the empty string. Has the same namespace prefix usage as the + propName parameter. +<DT><B>Returns:</B><DD>Returns true if the qualifier exists.</DL> +</DD> +</DL> +<HR> + +<A NAME="getLocalizedText(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> +getLocalizedText</H3> +<PRE> +<A HREF="../../../com/adobe/xmp/properties/XMPProperty.html" title="interface in com.adobe.xmp.properties">XMPProperty</A> <B>getLocalizedText</B>(java.lang.String schemaNS, + java.lang.String altTextName, + java.lang.String genericLang, + java.lang.String specificLang) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD>These functions provide convenient support for localized text properties, including a number + of special and obscure aspects. Localized text properties are stored in alt-text arrays. They + allow multiple concurrent localizations of a property value, for example a document title or + copyright in several languages. The most important aspect of these functions is that they + select an appropriate array item based on one or two RFC 3066 language tags. One of these + languages, the "specific" language, is preferred and selected if there is an exact match. For + many languages it is also possible to define a "generic" language that may be used if there + is no specific language match. The generic language must be a valid RFC 3066 primary subtag, + or the empty string. For example, a specific language of "en-US" should be used in the US, + and a specific language of "en-UK" should be used in England. It is also appropriate to use + "en" as the generic language in each case. If a US document goes to England, the "en-US" + title is selected by using the "en" generic language and the "en-UK" specific language. It is + considered poor practice, but allowed, to pass a specific language that is just an RFC 3066 + primary tag. For example "en" is not a good specific language, it should only be used as a + generic language. Passing "i" or "x" as the generic language is also considered poor practice + but allowed. Advice from the W3C about the use of RFC 3066 language tags can be found at: + http://www.w3.org/International/articles/language-tags/ + <p> + <em>Note:</em> RFC 3066 language tags must be treated in a case insensitive manner. The XMP + Toolkit does this by normalizing their capitalization: + <ul> + <li> The primary subtag is lower case, the suggested practice of ISO 639. + <li> All 2 letter secondary subtags are upper case, the suggested practice of ISO 3166. + <li> All other subtags are lower case. The XMP specification defines an artificial language, + <li>"x-default", that is used to explicitly denote a default item in an alt-text array. + </ul> + The XMP toolkit normalizes alt-text arrays such that the x-default item is the first item. + The SetLocalizedText function has several special features related to the x-default item, see + its description for details. The selection of the array item is the same for GetLocalizedText + and SetLocalizedText: + <ul> + <li> Look for an exact match with the specific language. + <li> If a generic language is given, look for a partial match. + <li> Look for an x-default item. + <li> Choose the first item. + </ul> + A partial match with the generic language is where the start of the item's language matches + the generic string and the next character is '-'. An exact match is also recognized as a + degenerate case. It is fine to pass x-default as the specific language. In this case, + selection of an x-default item is an exact match by the first rule, not a selection by the + 3rd rule. The last 2 rules are fallbacks used when the specific and generic languages fail to + produce a match. <code>getLocalizedText</code> returns information about a selected item in + an alt-text array. The array item is selected according to the rules given above. + + <em>Note:</em> In a future version of this API a method + using Java <code>java.lang.Locale</code> will be added. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the alt-text array. Has the same usage as in + <code>getProperty()</code>.<DD><CODE>altTextName</CODE> - The name of the alt-text array. May be a general path expression, must not + be <code>null</code> or the empty string. Has the same namespace prefix usage as + propName in <code>getProperty()</code>.<DD><CODE>genericLang</CODE> - The name of the generic language as an RFC 3066 primary subtag. May be + <code>null</code> or the empty string if no generic language is wanted.<DD><CODE>specificLang</CODE> - The name of the specific language as an RFC 3066 tag. Must not be + <code>null</code> or the empty string. +<DT><B>Returns:</B><DD>Returns an <code>XMPProperty</code> containing the value, the actual language and + the options if an appropriate alternate collection item exists, <code>null</code> + if the property. + does not exist. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all errors and exceptions that may occur.</DL> +</DD> +</DL> +<HR> + +<A NAME="setLocalizedText(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, com.adobe.xmp.options.PropertyOptions)"><!-- --></A><H3> +setLocalizedText</H3> +<PRE> +void <B>setLocalizedText</B>(java.lang.String schemaNS, + java.lang.String altTextName, + java.lang.String genericLang, + java.lang.String specificLang, + java.lang.String itemValue, + <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html" title="class in com.adobe.xmp.options">PropertyOptions</A> options) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD>Modifies the value of a selected item in an alt-text array. Creates an appropriate array item + if necessary, and handles special cases for the x-default item. If the selected item is from + a match with the specific language, the value of that item is modified. If the existing value + of that item matches the existing value of the x-default item, the x-default item is also + modified. If the array only has 1 existing item (which is not x-default), an x-default item + is added with the given value. If the selected item is from a match with the generic language + and there are no other generic matches, the value of that item is modified. If the existing + value of that item matches the existing value of the x-default item, the x-default item is + also modified. If the array only has 1 existing item (which is not x-default), an x-default + item is added with the given value. If the selected item is from a partial match with the + generic language and there are other partial matches, a new item is created for the specific + language. The x-default item is not modified. If the selected item is from the last 2 rules + then a new item is created for the specific language. If the array only had an x-default + item, the x-default item is also modified. If the array was empty, items are created for the + specific language and x-default. + + <em>Note:</em> In a future version of this API a method + using Java <code>java.lang.Locale</code> will be added. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the alt-text array. Has the same usage as in + <code>getProperty()</code>.<DD><CODE>altTextName</CODE> - The name of the alt-text array. May be a general path expression, must not + be <code>null</code> or the empty string. Has the same namespace prefix usage as + propName in <code>getProperty()</code>.<DD><CODE>genericLang</CODE> - The name of the generic language as an RFC 3066 primary subtag. May be + <code>null</code> or the empty string if no generic language is wanted.<DD><CODE>specificLang</CODE> - The name of the specific language as an RFC 3066 tag. Must not be + <code>null</code> or the empty string.<DD><CODE>itemValue</CODE> - A pointer to the <code>null</code> terminated UTF-8 string that is the new + value for the appropriate array item.<DD><CODE>options</CODE> - Option flags, none are defined at present. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all errors and exceptions that may occur.</DL> +</DD> +</DL> +<HR> + +<A NAME="setLocalizedText(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> +setLocalizedText</H3> +<PRE> +void <B>setLocalizedText</B>(java.lang.String schemaNS, + java.lang.String altTextName, + java.lang.String genericLang, + java.lang.String specificLang, + java.lang.String itemValue) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the alt-text array<DD><CODE>altTextName</CODE> - The name of the alt-text array<DD><CODE>genericLang</CODE> - The name of the generic language<DD><CODE>specificLang</CODE> - The name of the specific language<DD><CODE>itemValue</CODE> - the new value for the appropriate array item +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all errors and exceptions<DT><B>See Also:</B><DD><A HREF="../../../com/adobe/xmp/XMPMeta.html#setLocalizedText(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, com.adobe.xmp.options.PropertyOptions)"><CODE>setLocalizedText(String, String, String, String, String, PropertyOptions)</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="getPropertyBoolean(java.lang.String, java.lang.String)"><!-- --></A><H3> +getPropertyBoolean</H3> +<PRE> +java.lang.Boolean <B>getPropertyBoolean</B>(java.lang.String schemaNS, + java.lang.String propName) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD>These are very similar to <code>getProperty()</code> and <code>SetProperty()</code> above, + but the value is returned or provided in a literal form instead of as a UTF-8 string. + The path composition functions in <code>XMPPathFactory</code> may be used to compose an path + expression for fields in nested structures, items in arrays, or qualifiers. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the property. Has the same usage as in + <code>getProperty()</code>.<DD><CODE>propName</CODE> - The name of the property. + Has the same usage as in <code>getProperty()</code>. +<DT><B>Returns:</B><DD>Returns a <code>Boolean</code> value or <code>null</code> + if the property does not exist. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all exceptions that may occur, + especially conversion errors.</DL> +</DD> +</DL> +<HR> + +<A NAME="getPropertyInteger(java.lang.String, java.lang.String)"><!-- --></A><H3> +getPropertyInteger</H3> +<PRE> +java.lang.Integer <B>getPropertyInteger</B>(java.lang.String schemaNS, + java.lang.String propName) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD>Convenience method to retrieve the literal value of a property. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the property. Has the same usage as in + <code>getProperty()</code>.<DD><CODE>propName</CODE> - The name of the property. + Has the same usage as in <code>getProperty()</code>. +<DT><B>Returns:</B><DD>Returns an <code>Integer</code> value or <code>null</code> + if the property does not exist. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all exceptions that may occur, + especially conversion errors.</DL> +</DD> +</DL> +<HR> + +<A NAME="getPropertyLong(java.lang.String, java.lang.String)"><!-- --></A><H3> +getPropertyLong</H3> +<PRE> +java.lang.Long <B>getPropertyLong</B>(java.lang.String schemaNS, + java.lang.String propName) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD>Convenience method to retrieve the literal value of a property. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the property. Has the same usage as in + <code>getProperty()</code>.<DD><CODE>propName</CODE> - The name of the property. + Has the same usage as in <code>getProperty()</code>. +<DT><B>Returns:</B><DD>Returns a <code>Long</code> value or <code>null</code> + if the property does not exist. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all exceptions that may occur, + especially conversion errors.</DL> +</DD> +</DL> +<HR> + +<A NAME="getPropertyDouble(java.lang.String, java.lang.String)"><!-- --></A><H3> +getPropertyDouble</H3> +<PRE> +java.lang.Double <B>getPropertyDouble</B>(java.lang.String schemaNS, + java.lang.String propName) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD>Convenience method to retrieve the literal value of a property. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the property. Has the same usage as in + <code>getProperty()</code>.<DD><CODE>propName</CODE> - The name of the property. + Has the same usage as in <code>getProperty()</code>. +<DT><B>Returns:</B><DD>Returns a <code>Double</code> value or <code>null</code> + if the property does not exist. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all exceptions that may occur, + especially conversion errors.</DL> +</DD> +</DL> +<HR> + +<A NAME="getPropertyDate(java.lang.String, java.lang.String)"><!-- --></A><H3> +getPropertyDate</H3> +<PRE> +<A HREF="../../../com/adobe/xmp/XMPDateTime.html" title="interface in com.adobe.xmp">XMPDateTime</A> <B>getPropertyDate</B>(java.lang.String schemaNS, + java.lang.String propName) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD>Convenience method to retrieve the literal value of a property. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the property. Has the same usage as in + <code>getProperty()</code>.<DD><CODE>propName</CODE> - The name of the property. + Has the same usage as in <code>getProperty()</code>. +<DT><B>Returns:</B><DD>Returns a <code>XMPDateTime</code>-object or <code>null</code> + if the property does not exist. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all exceptions that may occur, + especially conversion errors.</DL> +</DD> +</DL> +<HR> + +<A NAME="getPropertyCalendar(java.lang.String, java.lang.String)"><!-- --></A><H3> +getPropertyCalendar</H3> +<PRE> +java.util.Calendar <B>getPropertyCalendar</B>(java.lang.String schemaNS, + java.lang.String propName) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD>Convenience method to retrieve the literal value of a property. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the property. Has the same usage as in + <code>getProperty()</code>.<DD><CODE>propName</CODE> - The name of the property. + Has the same usage as in <code>getProperty()</code>. +<DT><B>Returns:</B><DD>Returns a Java <code>Calendar</code>-object or <code>null</code> + if the property does not exist. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all exceptions that may occur, + especially conversion errors.</DL> +</DD> +</DL> +<HR> + +<A NAME="getPropertyBase64(java.lang.String, java.lang.String)"><!-- --></A><H3> +getPropertyBase64</H3> +<PRE> +byte[] <B>getPropertyBase64</B>(java.lang.String schemaNS, + java.lang.String propName) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD>Convenience method to retrieve the literal value of a property. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the property. Has the same usage as in + <code>getProperty()</code>.<DD><CODE>propName</CODE> - The name of the property. + Has the same usage as in <code>getProperty()</code>. +<DT><B>Returns:</B><DD>Returns a <code>byte[]</code>-array contained the decoded base64 value + or <code>null</code> if the property does not exist. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all exceptions that may occur, + especially conversion errors.</DL> +</DD> +</DL> +<HR> + +<A NAME="getPropertyString(java.lang.String, java.lang.String)"><!-- --></A><H3> +getPropertyString</H3> +<PRE> +java.lang.String <B>getPropertyString</B>(java.lang.String schemaNS, + java.lang.String propName) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD>Convenience method to retrieve the literal value of a property. + <em>Note:</em> There is no <code>setPropertyString()</code>, + because <code>setProperty()</code> sets a string value. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the property. Has the same usage as in + <code>getProperty()</code>.<DD><CODE>propName</CODE> - The name of the property. + Has the same usage as in <code>getProperty()</code>. +<DT><B>Returns:</B><DD>Returns a <code>String</code> value or <code>null</code> + if the property does not exist. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all exceptions that may occur, + especially conversion errors.</DL> +</DD> +</DL> +<HR> + +<A NAME="setPropertyBoolean(java.lang.String, java.lang.String, boolean, com.adobe.xmp.options.PropertyOptions)"><!-- --></A><H3> +setPropertyBoolean</H3> +<PRE> +void <B>setPropertyBoolean</B>(java.lang.String schemaNS, + java.lang.String propName, + boolean propValue, + <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html" title="class in com.adobe.xmp.options">PropertyOptions</A> options) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD>Convenience method to set a property to a literal <code>boolean</code> value. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the property. Has the same usage as in + <code>setProperty()</code>.<DD><CODE>propName</CODE> - The name of the property. + Has the same usage as in <code>getProperty()</code>.<DD><CODE>propValue</CODE> - the literal property value as <code>boolean</code>.<DD><CODE>options</CODE> - options of the property to set (optional). +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all exceptions that may occur.</DL> +</DD> +</DL> +<HR> + +<A NAME="setPropertyBoolean(java.lang.String, java.lang.String, boolean)"><!-- --></A><H3> +setPropertyBoolean</H3> +<PRE> +void <B>setPropertyBoolean</B>(java.lang.String schemaNS, + java.lang.String propName, + boolean propValue) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the property<DD><CODE>propName</CODE> - The name of the property<DD><CODE>propValue</CODE> - the literal property value as <code>boolean</code> +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all exceptions<DT><B>See Also:</B><DD><A HREF="../../../com/adobe/xmp/XMPMeta.html#setPropertyBoolean(java.lang.String, java.lang.String, boolean, com.adobe.xmp.options.PropertyOptions)"><CODE>setPropertyBoolean(String, String, boolean, PropertyOptions)</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="setPropertyInteger(java.lang.String, java.lang.String, int, com.adobe.xmp.options.PropertyOptions)"><!-- --></A><H3> +setPropertyInteger</H3> +<PRE> +void <B>setPropertyInteger</B>(java.lang.String schemaNS, + java.lang.String propName, + int propValue, + <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html" title="class in com.adobe.xmp.options">PropertyOptions</A> options) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD>Convenience method to set a property to a literal <code>int</code> value. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the property. Has the same usage as in + <code>setProperty()</code>.<DD><CODE>propName</CODE> - The name of the property. + Has the same usage as in <code>getProperty()</code>.<DD><CODE>propValue</CODE> - the literal property value as <code>int</code>.<DD><CODE>options</CODE> - options of the property to set (optional). +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all exceptions that may occur.</DL> +</DD> +</DL> +<HR> + +<A NAME="setPropertyInteger(java.lang.String, java.lang.String, int)"><!-- --></A><H3> +setPropertyInteger</H3> +<PRE> +void <B>setPropertyInteger</B>(java.lang.String schemaNS, + java.lang.String propName, + int propValue) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the property<DD><CODE>propName</CODE> - The name of the property<DD><CODE>propValue</CODE> - the literal property value as <code>int</code> +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all exceptions<DT><B>See Also:</B><DD><A HREF="../../../com/adobe/xmp/XMPMeta.html#setPropertyInteger(java.lang.String, java.lang.String, int, com.adobe.xmp.options.PropertyOptions)"><CODE>setPropertyInteger(String, String, int, PropertyOptions)</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="setPropertyLong(java.lang.String, java.lang.String, long, com.adobe.xmp.options.PropertyOptions)"><!-- --></A><H3> +setPropertyLong</H3> +<PRE> +void <B>setPropertyLong</B>(java.lang.String schemaNS, + java.lang.String propName, + long propValue, + <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html" title="class in com.adobe.xmp.options">PropertyOptions</A> options) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD>Convenience method to set a property to a literal <code>long</code> value. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the property. Has the same usage as in + <code>setProperty()</code>.<DD><CODE>propName</CODE> - The name of the property. + Has the same usage as in <code>getProperty()</code>.<DD><CODE>propValue</CODE> - the literal property value as <code>long</code>.<DD><CODE>options</CODE> - options of the property to set (optional). +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all exceptions that may occur.</DL> +</DD> +</DL> +<HR> + +<A NAME="setPropertyLong(java.lang.String, java.lang.String, long)"><!-- --></A><H3> +setPropertyLong</H3> +<PRE> +void <B>setPropertyLong</B>(java.lang.String schemaNS, + java.lang.String propName, + long propValue) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the property<DD><CODE>propName</CODE> - The name of the property<DD><CODE>propValue</CODE> - the literal property value as <code>long</code> +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all exceptions<DT><B>See Also:</B><DD><A HREF="../../../com/adobe/xmp/XMPMeta.html#setPropertyLong(java.lang.String, java.lang.String, long, com.adobe.xmp.options.PropertyOptions)"><CODE>setPropertyLong(String, String, long, PropertyOptions)</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="setPropertyDouble(java.lang.String, java.lang.String, double, com.adobe.xmp.options.PropertyOptions)"><!-- --></A><H3> +setPropertyDouble</H3> +<PRE> +void <B>setPropertyDouble</B>(java.lang.String schemaNS, + java.lang.String propName, + double propValue, + <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html" title="class in com.adobe.xmp.options">PropertyOptions</A> options) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD>Convenience method to set a property to a literal <code>double</code> value. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the property. Has the same usage as in + <code>setProperty()</code>.<DD><CODE>propName</CODE> - The name of the property. + Has the same usage as in <code>getProperty()</code>.<DD><CODE>propValue</CODE> - the literal property value as <code>double</code>.<DD><CODE>options</CODE> - options of the property to set (optional). +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all exceptions that may occur.</DL> +</DD> +</DL> +<HR> + +<A NAME="setPropertyDouble(java.lang.String, java.lang.String, double)"><!-- --></A><H3> +setPropertyDouble</H3> +<PRE> +void <B>setPropertyDouble</B>(java.lang.String schemaNS, + java.lang.String propName, + double propValue) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the property<DD><CODE>propName</CODE> - The name of the property<DD><CODE>propValue</CODE> - the literal property value as <code>double</code> +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all exceptions<DT><B>See Also:</B><DD><A HREF="../../../com/adobe/xmp/XMPMeta.html#setPropertyDouble(java.lang.String, java.lang.String, double, com.adobe.xmp.options.PropertyOptions)"><CODE>setPropertyDouble(String, String, double, PropertyOptions)</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="setPropertyDate(java.lang.String, java.lang.String, com.adobe.xmp.XMPDateTime, com.adobe.xmp.options.PropertyOptions)"><!-- --></A><H3> +setPropertyDate</H3> +<PRE> +void <B>setPropertyDate</B>(java.lang.String schemaNS, + java.lang.String propName, + <A HREF="../../../com/adobe/xmp/XMPDateTime.html" title="interface in com.adobe.xmp">XMPDateTime</A> propValue, + <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html" title="class in com.adobe.xmp.options">PropertyOptions</A> options) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD>Convenience method to set a property with an XMPDateTime-object, + which is serialized to an ISO8601 date. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the property. Has the same usage as in + <code>setProperty()</code>.<DD><CODE>propName</CODE> - The name of the property. + Has the same usage as in <code>getProperty()</code>.<DD><CODE>propValue</CODE> - the property value as <code>XMPDateTime</code>.<DD><CODE>options</CODE> - options of the property to set (optional). +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all exceptions that may occur.</DL> +</DD> +</DL> +<HR> + +<A NAME="setPropertyDate(java.lang.String, java.lang.String, com.adobe.xmp.XMPDateTime)"><!-- --></A><H3> +setPropertyDate</H3> +<PRE> +void <B>setPropertyDate</B>(java.lang.String schemaNS, + java.lang.String propName, + <A HREF="../../../com/adobe/xmp/XMPDateTime.html" title="interface in com.adobe.xmp">XMPDateTime</A> propValue) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the property<DD><CODE>propName</CODE> - The name of the property<DD><CODE>propValue</CODE> - the property value as <code>XMPDateTime</code> +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all exceptions<DT><B>See Also:</B><DD><A HREF="../../../com/adobe/xmp/XMPMeta.html#setPropertyDate(java.lang.String, java.lang.String, com.adobe.xmp.XMPDateTime, com.adobe.xmp.options.PropertyOptions)"><CODE>setPropertyDate(String, String, XMPDateTime, PropertyOptions)</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="setPropertyCalendar(java.lang.String, java.lang.String, java.util.Calendar, com.adobe.xmp.options.PropertyOptions)"><!-- --></A><H3> +setPropertyCalendar</H3> +<PRE> +void <B>setPropertyCalendar</B>(java.lang.String schemaNS, + java.lang.String propName, + java.util.Calendar propValue, + <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html" title="class in com.adobe.xmp.options">PropertyOptions</A> options) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD>Convenience method to set a property with a Java Calendar-object, + which is serialized to an ISO8601 date. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the property. Has the same usage as in + <code>setProperty()</code>.<DD><CODE>propName</CODE> - The name of the property. + Has the same usage as in <code>getProperty()</code>.<DD><CODE>propValue</CODE> - the property value as Java <code>Calendar</code>.<DD><CODE>options</CODE> - options of the property to set (optional). +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all exceptions that may occur.</DL> +</DD> +</DL> +<HR> + +<A NAME="setPropertyCalendar(java.lang.String, java.lang.String, java.util.Calendar)"><!-- --></A><H3> +setPropertyCalendar</H3> +<PRE> +void <B>setPropertyCalendar</B>(java.lang.String schemaNS, + java.lang.String propName, + java.util.Calendar propValue) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the property<DD><CODE>propName</CODE> - The name of the property<DD><CODE>propValue</CODE> - the property value as <code>Calendar</code> +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all exceptions<DT><B>See Also:</B><DD><A HREF="../../../com/adobe/xmp/XMPMeta.html#setPropertyCalendar(java.lang.String, java.lang.String, java.util.Calendar, com.adobe.xmp.options.PropertyOptions)"><CODE>setPropertyCalendar(String, String, Calendar, PropertyOptions)</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="setPropertyBase64(java.lang.String, java.lang.String, byte[], com.adobe.xmp.options.PropertyOptions)"><!-- --></A><H3> +setPropertyBase64</H3> +<PRE> +void <B>setPropertyBase64</B>(java.lang.String schemaNS, + java.lang.String propName, + byte[] propValue, + <A HREF="../../../com/adobe/xmp/options/PropertyOptions.html" title="class in com.adobe.xmp.options">PropertyOptions</A> options) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD>Convenience method to set a property from a binary <code>byte[]</code>-array, + which is serialized as base64-string. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the property. Has the same usage as in + <code>setProperty()</code>.<DD><CODE>propName</CODE> - The name of the property. + Has the same usage as in <code>getProperty()</code>.<DD><CODE>propValue</CODE> - the literal property value as byte array.<DD><CODE>options</CODE> - options of the property to set (optional). +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all exceptions that may occur.</DL> +</DD> +</DL> +<HR> + +<A NAME="setPropertyBase64(java.lang.String, java.lang.String, byte[])"><!-- --></A><H3> +setPropertyBase64</H3> +<PRE> +void <B>setPropertyBase64</B>(java.lang.String schemaNS, + java.lang.String propName, + byte[] propValue) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - The namespace URI for the property<DD><CODE>propName</CODE> - The name of the property<DD><CODE>propValue</CODE> - the literal property value as byte array +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all exceptions<DT><B>See Also:</B><DD><A HREF="../../../com/adobe/xmp/XMPMeta.html#setPropertyBase64(java.lang.String, java.lang.String, byte[], com.adobe.xmp.options.PropertyOptions)"><CODE>setPropertyBase64(String, String, byte[], PropertyOptions)</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="iterator()"><!-- --></A><H3> +iterator</H3> +<PRE> +<A HREF="../../../com/adobe/xmp/XMPIterator.html" title="interface in com.adobe.xmp">XMPIterator</A> <B>iterator</B>() + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD>Constructs an iterator for the properties within this XMP object. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>Returns an <code>XMPIterator</code>. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all errors and exceptions that may occur.<DT><B>See Also:</B><DD><A HREF="../../../com/adobe/xmp/XMPMeta.html#iterator(java.lang.String, java.lang.String, com.adobe.xmp.options.IteratorOptions)"><CODE>iterator(String, String, IteratorOptions)</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="iterator(com.adobe.xmp.options.IteratorOptions)"><!-- --></A><H3> +iterator</H3> +<PRE> +<A HREF="../../../com/adobe/xmp/XMPIterator.html" title="interface in com.adobe.xmp">XMPIterator</A> <B>iterator</B>(<A HREF="../../../com/adobe/xmp/options/IteratorOptions.html" title="class in com.adobe.xmp.options">IteratorOptions</A> options) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD>Constructs an iterator for the properties within this XMP object using some options. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>options</CODE> - Option flags to control the iteration. +<DT><B>Returns:</B><DD>Returns an <code>XMPIterator</code>. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all errors and exceptions that may occur.<DT><B>See Also:</B><DD><A HREF="../../../com/adobe/xmp/XMPMeta.html#iterator(java.lang.String, java.lang.String, com.adobe.xmp.options.IteratorOptions)"><CODE>iterator(String, String, IteratorOptions)</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="iterator(java.lang.String, java.lang.String, com.adobe.xmp.options.IteratorOptions)"><!-- --></A><H3> +iterator</H3> +<PRE> +<A HREF="../../../com/adobe/xmp/XMPIterator.html" title="interface in com.adobe.xmp">XMPIterator</A> <B>iterator</B>(java.lang.String schemaNS, + java.lang.String propName, + <A HREF="../../../com/adobe/xmp/options/IteratorOptions.html" title="class in com.adobe.xmp.options">IteratorOptions</A> options) + throws <A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></PRE> +<DL> +<DD>Construct an iterator for the properties within an XMP object. The general operation of an + XMP object iterator was. According to the parameters it iterates the entire data tree, + properties within a specific schema, or a subtree rooted at a specific node. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>schemaNS</CODE> - Optional schema namespace URI to restrict the iteration. Omitted (visit all + schema) by passing <code>null</code> or empty String.<DD><CODE>propName</CODE> - Optional property name to restrict the iteration. May be an arbitrary path + expression. Omitted (visit all properties) by passing <code>null</code> or empty + String. If no schema URI is given, it is ignored.<DD><CODE>options</CODE> - Option flags to control the iteration. See <A HREF="../../../com/adobe/xmp/options/IteratorOptions.html" title="class in com.adobe.xmp.options"><CODE>IteratorOptions</CODE></A> for + details. +<DT><B>Returns:</B><DD>Returns an <code>XMPIterator</code> for this <code>XMPMeta</code>-object + considering the given options. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../com/adobe/xmp/XMPException.html" title="class in com.adobe.xmp">XMPException</A></CODE> - Wraps all errors and exceptions that may occur.</DL> +</DD> +</DL> +<HR> + +<A NAME="getObjectName()"><!-- --></A><H3> +getObjectName</H3> +<PRE> +java.lang.String <B>getObjectName</B>()</PRE> +<DL> +<DD>This correlates to the about-attribute, + returns the empty String if no name is set. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>Returns the name of the XMP object.</DL> +</DD> +</DL> +<HR> + +<A NAME="setObjectName(java.lang.String)"><!-- --></A><H3> +setObjectName</H3> +<PRE> +void <B>setObjectName</B>(java.lang.String name)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>name</CODE> - Sets the name of the XMP object.</DL> +</DD> +</DL> +<HR> + +<A NAME="clone()"><!-- --></A><H3> +clone</H3> +<PRE> +java.lang.Object <B>clone</B>()</PRE> +<DL> +<DD>Clones the complete metadata tree. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>Returns a deep copy of this instance.</DL> +</DD> +</DL> +<HR> + +<A NAME="sort()"><!-- --></A><H3> +sort</H3> +<PRE> +void <B>sort</B>()</PRE> +<DL> +<DD>Sorts the complete datamodel according to the following rules: + <ul> + <li>Schema nodes are sorted by prefix. + <li>Properties at top level and within structs are sorted by full name, that is + prefix + local name. + <li>Array items are not sorted, even if they have no certain order such as bags. + <li>Qualifier are sorted, with the exception of "xml:lang" and/or "rdf:type" + that stay at the top of the list in that order. + </ul> +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="dumpObject()"><!-- --></A><H3> +dumpObject</H3> +<PRE> +java.lang.String <B>dumpObject</B>()</PRE> +<DL> +<DD>Renders this node and the tree unter this node in a human readable form. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>Returns a multiline string containing the dump.</DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<HR> + + +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XMPMeta.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../com/adobe/xmp/XMPIterator.html" title="interface in com.adobe.xmp"><B>PREV CLASS</B></A> + <A HREF="../../../com/adobe/xmp/XMPMetaFactory.html" title="class in com.adobe.xmp"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../index.html?com/adobe/xmp/XMPMeta.html" target="_top"><B>FRAMES</B></A> + <A HREF="XMPMeta.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> +<i>Copyright © 2006-2007 Adobe Systems Inc. All Rights Reserved.</i> +</BODY> +</HTML> |