diff options
Diffstat (limited to 'java/XMPCore/docs/com/adobe/xmp/XMPIterator.html')
| -rw-r--r-- | java/XMPCore/docs/com/adobe/xmp/XMPIterator.html | 304 |
1 files changed, 304 insertions, 0 deletions
diff --git a/java/XMPCore/docs/com/adobe/xmp/XMPIterator.html b/java/XMPCore/docs/com/adobe/xmp/XMPIterator.html new file mode 100644 index 0000000..8231e93 --- /dev/null +++ b/java/XMPCore/docs/com/adobe/xmp/XMPIterator.html @@ -0,0 +1,304 @@ +<!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> +XMPIterator +</TITLE> + +<META NAME="keywords" CONTENT="com.adobe.xmp.XMPIterator interface"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="XMPIterator"; +} +</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/XMPIterator.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/XMPException.html" title="class in com.adobe.xmp"><B>PREV CLASS</B></A> + <A HREF="../../../com/adobe/xmp/XMPMeta.html" title="interface 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/XMPIterator.html" target="_top"><B>FRAMES</B></A> + <A HREF="XMPIterator.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 XMPIterator</H2> +<DL> +<DT><B>All Superinterfaces:</B> <DD>java.util.Iterator</DD> +</DL> +<HR> +<DL> +<DT><PRE>public interface <B>XMPIterator</B><DT>extends java.util.Iterator</DL> +</PRE> + +<P> +Interface for the <code>XMPMeta</code> iteration services. + <code>XMPIterator</code> provides a uniform means to iterate over the + schema and properties within an XMP object. + <p> + The iteration over the schema and properties within an XMP object is very + complex. It is helpful to have a thorough understanding of the XMP data tree. + One way to learn this is to create some complex XMP and examine the output of + <code>XMPMeta#toString</code>. This is also described in the XMP + Specification, in the XMP Data Model chapter. + <p> + The top of the XMP data tree is a single root node. This does not explicitly + appear in the dump and is never visited by an iterator (that is, it is never + returned from <code>XMPIterator#next()</code>). Beneath the root are + schema nodes. These are just collectors for top level properties in the same + namespace. They are created and destroyed implicitly. Beneath the schema + nodes are the property nodes. The nodes below a property node depend on its + type (simple, struct, or array) and whether it has qualifiers. + <p> + An <code>XMPIterator</code> is created by XMPMeta#interator() constructor + defines a starting point for the iteration and options that control how it + proceeds. By default the iteration starts at the root and visits all nodes + beneath it in a depth first manner. The root node is not visited, the first + visited node is a schema node. You can provide a schema name or property path + to select a different starting node. By default this visits the named root + node first then all nodes beneath it in a depth first manner. + <p> + The <code>XMPIterator#next()</code> method delivers the schema URI, path, + and option flags for the node being visited. If the node is simple it also + delivers the value. Qualifiers for this node are visited next. The fields of + a struct or items of an array are visited after the qualifiers of the parent. + <p> + The options to control the iteration are: + <ul> + <li>JUST_CHILDREN - Visit just the immediate children of the root. Skip + the root itself and all nodes below the immediate children. This omits the + qualifiers of the immediate children, the qualifier nodes being below what + they qualify, default is to visit the complete subtree. + <li>UST_LEAFNODES - Visit just the leaf property nodes and their + qualifiers. + <li>JUST_LEAFNAME - Return just the leaf component of the node names. + The default is to return the full xmp path. + <li>OMIT_QUALIFIERS - Do not visit the qualifiers. + <li>INCLUDE_ALIASES - Adds known alias properties to the properties in the iteration. + <em>Note:</em> Not supported in Java XMPCore! + </ul> + <p> + <code>next()</code> returns <code>XMPPropertyInfo</code>-objects and throws + a <code>NoSuchElementException</code> if there are no more properties to + return. +<P> + +<P> +<DL> +<DT><B>Since:</B></DT> + <DD>25.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/XMPIterator.html#skipSiblings()">skipSiblings</A></B>()</CODE> + +<BR> + Skip the subtree below and remaining siblings of the current node when + <code>next()</code> is called.</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/XMPIterator.html#skipSubtree()">skipSubtree</A></B>()</CODE> + +<BR> + Skip the subtree below the current node when <code>next()</code> is + called.</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.util.Iterator"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from interface java.util.Iterator</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>hasNext, next, remove</CODE></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="skipSubtree()"><!-- --></A><H3> +skipSubtree</H3> +<PRE> +void <B>skipSubtree</B>()</PRE> +<DL> +<DD>Skip the subtree below the current node when <code>next()</code> is + called. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="skipSiblings()"><!-- --></A><H3> +skipSiblings</H3> +<PRE> +void <B>skipSiblings</B>()</PRE> +<DL> +<DD>Skip the subtree below and remaining siblings of the current node when + <code>next()</code> is called. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</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/XMPIterator.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/XMPException.html" title="class in com.adobe.xmp"><B>PREV CLASS</B></A> + <A HREF="../../../com/adobe/xmp/XMPMeta.html" title="interface 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/XMPIterator.html" target="_top"><B>FRAMES</B></A> + <A HREF="XMPIterator.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> |