/[debian]/libjempbox-java/branches/upstream/current/docs/javadoc/org/jempbox/xmp/XMPMetadata.html
ViewVC logotype

Contents of /libjempbox-java/branches/upstream/current/docs/javadoc/org/jempbox/xmp/XMPMetadata.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 427 - (show annotations)
Fri Nov 17 21:04:18 2006 UTC (14 years, 8 months ago) by gregoa
File MIME type: text/html
File size: 29858 byte(s)
[svn-inject] Installing original source of libjempbox-java
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by javadoc (build 1.4.2_07) on Wed Apr 19 20:38:26 EDT 2006 -->
6 <TITLE>
7 XMPMetadata (JempBox-0.1.0-dev API)
8 </TITLE>
9
10 <META NAME="keywords" CONTENT="org.jempbox.xmp.XMPMetadata class">
11
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
13
14 <SCRIPT type="text/javascript">
15 function windowTitle()
16 {
17 parent.document.title="XMPMetadata (JempBox-0.1.0-dev API)";
18 }
19 </SCRIPT>
20
21 </HEAD>
22
23 <BODY BGCOLOR="white" onload="windowTitle();">
24
25
26 <!-- ========= START OF TOP NAVBAR ======= -->
27 <A NAME="navbar_top"><!-- --></A>
28 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
30 <TR>
31 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32 <A NAME="navbar_top_firstrow"><!-- --></A>
33 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34 <TR ALIGN="center" VALIGN="top">
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XMPMetadata.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
43 </TR>
44 </TABLE>
45 </TD>
46 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
47 </EM>
48 </TD>
49 </TR>
50
51 <TR>
52 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
53 &nbsp;<A HREF="../../../org/jempbox/xmp/Thumbnail.html" title="class in org.jempbox.xmp"><B>PREV CLASS</B></A>&nbsp;
54 &nbsp;<A HREF="../../../org/jempbox/xmp/XMPSchema.html" title="class in org.jempbox.xmp"><B>NEXT CLASS</B></A></FONT></TD>
55 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
56 <A HREF="../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
57 &nbsp;<A HREF="XMPMetadata.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
58 &nbsp;<SCRIPT type="text/javascript">
59 <!--
60 if(window==top) {
61 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
62 }
63 //-->
64 </SCRIPT>
65 <NOSCRIPT>
66 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
67 </NOSCRIPT>
68
69 </FONT></TD>
70 </TR>
71 <TR>
72 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
73 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
74 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
75 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
76 </TR>
77 </TABLE>
78 <A NAME="skip-navbar_top"></A>
79 <!-- ========= END OF TOP NAVBAR ========= -->
80
81 <HR>
82 <!-- ======== START OF CLASS DATA ======== -->
83 <H2>
84 <FONT SIZE="-1">
85 org.jempbox.xmp</FONT>
86 <BR>
87 Class XMPMetadata</H2>
88 <PRE>
89 <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A>
90 <IMG SRC="../../../resources/inherit.gif" ALT="extended by"><B>org.jempbox.xmp.XMPMetadata</B>
91 </PRE>
92 <HR>
93 <DL>
94 <DT>public class <B>XMPMetadata</B><DT>extends <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></DL>
95
96 <P>
97 This class represents the top level XMP data structure and gives access to the various schemas
98 that are available as part of the XMP specification.
99 <P>
100
101 <P>
102 <DL>
103 <DT><B>Version:</B></DT>
104 <DD>$Revision: 1.1 $</DD>
105 <DT><B>Author:</B></DT>
106 <DD>Ben Litchfield (ben@benlitchfield.com)</DD>
107 </DL>
108 <HR>
109
110 <P>
111 <!-- ======== NESTED CLASS SUMMARY ======== -->
112
113
114 <!-- =========== FIELD SUMMARY =========== -->
115
116 <A NAME="field_summary"><!-- --></A>
117 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
118 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
119 <TD COLSPAN=2><FONT SIZE="+2">
120 <B>Field Summary</B></FONT></TD>
121 </TR>
122 <TR BGCOLOR="white" CLASS="TableRowColor">
123 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
124 <CODE>static&nbsp;<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
125 <TD><CODE><B><A HREF="../../../org/jempbox/xmp/XMPMetadata.html#ENCODING_UTF16BE">ENCODING_UTF16BE</A></B></CODE>
126
127 <BR>
128 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Supported encoding for persisted XML.</TD>
129 </TR>
130 <TR BGCOLOR="white" CLASS="TableRowColor">
131 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
132 <CODE>static&nbsp;<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
133 <TD><CODE><B><A HREF="../../../org/jempbox/xmp/XMPMetadata.html#ENCODING_UTF16LE">ENCODING_UTF16LE</A></B></CODE>
134
135 <BR>
136 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Supported encoding for persisted XML.</TD>
137 </TR>
138 <TR BGCOLOR="white" CLASS="TableRowColor">
139 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
140 <CODE>static&nbsp;<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
141 <TD><CODE><B><A HREF="../../../org/jempbox/xmp/XMPMetadata.html#ENCODING_UTF8">ENCODING_UTF8</A></B></CODE>
142
143 <BR>
144 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Supported encoding for persisted XML.</TD>
145 </TR>
146 <TR BGCOLOR="white" CLASS="TableRowColor">
147 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
148 <CODE>protected &nbsp;<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/org/w3c/dom/Document.html" title="class or interface in org.w3c.dom">Document</A></CODE></FONT></TD>
149 <TD><CODE><B><A HREF="../../../org/jempbox/xmp/XMPMetadata.html#xmpDocument">xmpDocument</A></B></CODE>
150
151 <BR>
152 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The DOM representation of the metadata.</TD>
153 </TR>
154 </TABLE>
155 &nbsp;
156 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
157
158 <A NAME="constructor_summary"><!-- --></A>
159 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
160 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
161 <TD COLSPAN=2><FONT SIZE="+2">
162 <B>Constructor Summary</B></FONT></TD>
163 </TR>
164 <TR BGCOLOR="white" CLASS="TableRowColor">
165 <TD><CODE><B><A HREF="../../../org/jempbox/xmp/XMPMetadata.html#XMPMetadata()">XMPMetadata</A></B>()</CODE>
166
167 <BR>
168 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default constructor, creates blank XMP doc.</TD>
169 </TR>
170 <TR BGCOLOR="white" CLASS="TableRowColor">
171 <TD><CODE><B><A HREF="../../../org/jempbox/xmp/XMPMetadata.html#XMPMetadata(org.w3c.dom.Document)">XMPMetadata</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/org/w3c/dom/Document.html" title="class or interface in org.w3c.dom">Document</A>&nbsp;doc)</CODE>
172
173 <BR>
174 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor from an existing XML document.</TD>
175 </TR>
176 </TABLE>
177 &nbsp;
178 <!-- ========== METHOD SUMMARY =========== -->
179
180 <A NAME="method_summary"><!-- --></A>
181 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
182 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
183 <TD COLSPAN=2><FONT SIZE="+2">
184 <B>Method Summary</B></FONT></TD>
185 </TR>
186 <TR BGCOLOR="white" CLASS="TableRowColor">
187 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
188 <CODE>&nbsp;<A HREF="../../../org/jempbox/xmp/XMPSchemaBasic.html" title="class in org.jempbox.xmp">XMPSchemaBasic</A></CODE></FONT></TD>
189 <TD><CODE><B><A HREF="../../../org/jempbox/xmp/XMPMetadata.html#addBasicSchema()">addBasicSchema</A></B>()</CODE>
190
191 <BR>
192 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create and add a new Basic Schema to this metadata. </TD>
193 </TR>
194 <TR BGCOLOR="white" CLASS="TableRowColor">
195 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
196 <CODE>&nbsp;<A HREF="../../../org/jempbox/xmp/XMPSchemaDublinCore.html" title="class in org.jempbox.xmp">XMPSchemaDublinCore</A></CODE></FONT></TD>
197 <TD><CODE><B><A HREF="../../../org/jempbox/xmp/XMPMetadata.html#addDublinCoreSchema()">addDublinCoreSchema</A></B>()</CODE>
198
199 <BR>
200 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create and add a new Dublin Core Schema to this metadata. </TD>
201 </TR>
202 <TR BGCOLOR="white" CLASS="TableRowColor">
203 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
204 <CODE>&nbsp;<A HREF="../../../org/jempbox/xmp/XMPSchemaPDF.html" title="class in org.jempbox.xmp">XMPSchemaPDF</A></CODE></FONT></TD>
205 <TD><CODE><B><A HREF="../../../org/jempbox/xmp/XMPMetadata.html#addPDFSchema()">addPDFSchema</A></B>()</CODE>
206
207 <BR>
208 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create and add a new PDF Schema to this metadata. </TD>
209 </TR>
210 <TR BGCOLOR="white" CLASS="TableRowColor">
211 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
212 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
213 <TD><CODE><B><A HREF="../../../org/jempbox/xmp/XMPMetadata.html#getEncoding()">getEncoding</A></B>()</CODE>
214
215 <BR>
216 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the current encoding that will be used to write the XML.</TD>
217 </TR>
218 <TR BGCOLOR="white" CLASS="TableRowColor">
219 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
220 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/List.html" title="class or interface in java.util">List</A></CODE></FONT></TD>
221 <TD><CODE><B><A HREF="../../../org/jempbox/xmp/XMPMetadata.html#getSchemas()">getSchemas</A></B>()</CODE>
222
223 <BR>
224 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This will get a list of XMPSchema(or subclass) objects.</TD>
225 </TR>
226 <TR BGCOLOR="white" CLASS="TableRowColor">
227 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
228 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/org/w3c/dom/Document.html" title="class or interface in org.w3c.dom">Document</A></CODE></FONT></TD>
229 <TD><CODE><B><A HREF="../../../org/jempbox/xmp/XMPMetadata.html#getXMPDocument()">getXMPDocument</A></B>()</CODE>
230
231 <BR>
232 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the XML document from this object.</TD>
233 </TR>
234 <TR BGCOLOR="white" CLASS="TableRowColor">
235 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
236 <CODE>static&nbsp;<A HREF="../../../org/jempbox/xmp/XMPMetadata.html" title="class in org.jempbox.xmp">XMPMetadata</A></CODE></FONT></TD>
237 <TD><CODE><B><A HREF="../../../org/jempbox/xmp/XMPMetadata.html#load(java.io.InputStream)">load</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/InputStream.html" title="class or interface in java.io">InputStream</A>&nbsp;is)</CODE>
238
239 <BR>
240 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Load metadata from the filesystem.</TD>
241 </TR>
242 <TR BGCOLOR="white" CLASS="TableRowColor">
243 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
244 <CODE>static&nbsp;<A HREF="../../../org/jempbox/xmp/XMPMetadata.html" title="class in org.jempbox.xmp">XMPMetadata</A></CODE></FONT></TD>
245 <TD><CODE><B><A HREF="../../../org/jempbox/xmp/XMPMetadata.html#load(java.lang.String)">load</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;file)</CODE>
246
247 <BR>
248 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Load metadata from the filesystem.</TD>
249 </TR>
250 <TR BGCOLOR="white" CLASS="TableRowColor">
251 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
252 <CODE>static&nbsp;void</CODE></FONT></TD>
253 <TD><CODE><B><A HREF="../../../org/jempbox/xmp/XMPMetadata.html#main(java.lang.String[])">main</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[]&nbsp;args)</CODE>
254
255 <BR>
256 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Test main program.</TD>
257 </TR>
258 <TR BGCOLOR="white" CLASS="TableRowColor">
259 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
260 <CODE>&nbsp;void</CODE></FONT></TD>
261 <TD><CODE><B><A HREF="../../../org/jempbox/xmp/XMPMetadata.html#save(java.lang.String)">save</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;file)</CODE>
262
263 <BR>
264 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Save the XMP document to a file.</TD>
265 </TR>
266 <TR BGCOLOR="white" CLASS="TableRowColor">
267 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
268 <CODE>&nbsp;void</CODE></FONT></TD>
269 <TD><CODE><B><A HREF="../../../org/jempbox/xmp/XMPMetadata.html#setEncoding(java.lang.String)">setEncoding</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;xmlEncoding)</CODE>
270
271 <BR>
272 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The encoding used to write the XML. </TD>
273 </TR>
274 </TABLE>
275 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
276 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
277 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
278 <TD><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TD>
279 </TR>
280 <TR BGCOLOR="white" CLASS="TableRowColor">
281 <TD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
282 </TR>
283 </TABLE>
284 &nbsp;
285 <P>
286
287 <!-- ============ FIELD DETAIL =========== -->
288
289 <A NAME="field_detail"><!-- --></A>
290 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
291 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
292 <TD COLSPAN=1><FONT SIZE="+2">
293 <B>Field Detail</B></FONT></TD>
294 </TR>
295 </TABLE>
296
297 <A NAME="ENCODING_UTF8"><!-- --></A><H3>
298 ENCODING_UTF8</H3>
299 <PRE>
300 public static final <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>ENCODING_UTF8</B></PRE>
301 <DL>
302 <DD>Supported encoding for persisted XML.
303 <P>
304 <DL>
305 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.jempbox.xmp.XMPMetadata.ENCODING_UTF8">Constant Field Values</A></DL>
306 </DL>
307 <HR>
308
309 <A NAME="ENCODING_UTF16BE"><!-- --></A><H3>
310 ENCODING_UTF16BE</H3>
311 <PRE>
312 public static final <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>ENCODING_UTF16BE</B></PRE>
313 <DL>
314 <DD>Supported encoding for persisted XML.
315 <P>
316 <DL>
317 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.jempbox.xmp.XMPMetadata.ENCODING_UTF16BE">Constant Field Values</A></DL>
318 </DL>
319 <HR>
320
321 <A NAME="ENCODING_UTF16LE"><!-- --></A><H3>
322 ENCODING_UTF16LE</H3>
323 <PRE>
324 public static final <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>ENCODING_UTF16LE</B></PRE>
325 <DL>
326 <DD>Supported encoding for persisted XML.
327 <P>
328 <DL>
329 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.jempbox.xmp.XMPMetadata.ENCODING_UTF16LE">Constant Field Values</A></DL>
330 </DL>
331 <HR>
332
333 <A NAME="xmpDocument"><!-- --></A><H3>
334 xmpDocument</H3>
335 <PRE>
336 protected <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/org/w3c/dom/Document.html" title="class or interface in org.w3c.dom">Document</A> <B>xmpDocument</B></PRE>
337 <DL>
338 <DD>The DOM representation of the metadata.
339 <P>
340 <DL>
341 </DL>
342 </DL>
343
344 <!-- ========= CONSTRUCTOR DETAIL ======== -->
345
346 <A NAME="constructor_detail"><!-- --></A>
347 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
348 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
349 <TD COLSPAN=1><FONT SIZE="+2">
350 <B>Constructor Detail</B></FONT></TD>
351 </TR>
352 </TABLE>
353
354 <A NAME="XMPMetadata()"><!-- --></A><H3>
355 XMPMetadata</H3>
356 <PRE>
357 public <B>XMPMetadata</B>()
358 throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>
359 <DL>
360 <DD>Default constructor, creates blank XMP doc.
361 <P>
362
363 <DT><B>Throws:</B>
364 <DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - If there is an error creating the initial document.</DL>
365 <HR>
366
367 <A NAME="XMPMetadata(org.w3c.dom.Document)"><!-- --></A><H3>
368 XMPMetadata</H3>
369 <PRE>
370 public <B>XMPMetadata</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/org/w3c/dom/Document.html" title="class or interface in org.w3c.dom">Document</A>&nbsp;doc)</PRE>
371 <DL>
372 <DD>Constructor from an existing XML document.
373 <P>
374 <DT><B>Parameters:</B><DD><CODE>doc</CODE> - The root XMP document.</DL>
375
376 <!-- ============ METHOD DETAIL ========== -->
377
378 <A NAME="method_detail"><!-- --></A>
379 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
380 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
381 <TD COLSPAN=1><FONT SIZE="+2">
382 <B>Method Detail</B></FONT></TD>
383 </TR>
384 </TABLE>
385
386 <A NAME="save(java.lang.String)"><!-- --></A><H3>
387 save</H3>
388 <PRE>
389 public void <B>save</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;file)
390 throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Exception.html" title="class or interface in java.lang">Exception</A></PRE>
391 <DL>
392 <DD>Save the XMP document to a file.
393 <P>
394 <DD><DL>
395 <DT><B>Parameters:</B><DD><CODE>file</CODE> - The file to save the XMP document to.
396 <DT><B>Throws:</B>
397 <DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Exception.html" title="class or interface in java.lang">Exception</A></CODE> - If there is an error while writing to the stream.</DL>
398 </DD>
399 </DL>
400 <HR>
401
402 <A NAME="getXMPDocument()"><!-- --></A><H3>
403 getXMPDocument</H3>
404 <PRE>
405 public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/org/w3c/dom/Document.html" title="class or interface in org.w3c.dom">Document</A> <B>getXMPDocument</B>()</PRE>
406 <DL>
407 <DD>Get the XML document from this object.
408 <P>
409 <DD><DL>
410
411 <DT><B>Returns:</B><DD>This object as an XML document.</DL>
412 </DD>
413 </DL>
414 <HR>
415
416 <A NAME="addPDFSchema()"><!-- --></A><H3>
417 addPDFSchema</H3>
418 <PRE>
419 public <A HREF="../../../org/jempbox/xmp/XMPSchemaPDF.html" title="class in org.jempbox.xmp">XMPSchemaPDF</A> <B>addPDFSchema</B>()</PRE>
420 <DL>
421 <DD>Create and add a new PDF Schema to this metadata. Typically a XMP document
422 will only have one PDF schema (but multiple are supported) so it is recommended
423 that you first check the existence of a PDF scheme by using getPDFSchema()
424 <P>
425 <DD><DL>
426
427 <DT><B>Returns:</B><DD>A new blank PDF schema that is now part of the metadata.</DL>
428 </DD>
429 </DL>
430 <HR>
431
432 <A NAME="addDublinCoreSchema()"><!-- --></A><H3>
433 addDublinCoreSchema</H3>
434 <PRE>
435 public <A HREF="../../../org/jempbox/xmp/XMPSchemaDublinCore.html" title="class in org.jempbox.xmp">XMPSchemaDublinCore</A> <B>addDublinCoreSchema</B>()</PRE>
436 <DL>
437 <DD>Create and add a new Dublin Core Schema to this metadata. Typically a XMP document
438 will only have one schema for each type (but multiple are supported) so it is recommended
439 that you first check the existence of a this scheme by using getDublinCoreSchema()
440 <P>
441 <DD><DL>
442
443 <DT><B>Returns:</B><DD>A new blank PDF schema that is now part of the metadata.</DL>
444 </DD>
445 </DL>
446 <HR>
447
448 <A NAME="addBasicSchema()"><!-- --></A><H3>
449 addBasicSchema</H3>
450 <PRE>
451 public <A HREF="../../../org/jempbox/xmp/XMPSchemaBasic.html" title="class in org.jempbox.xmp">XMPSchemaBasic</A> <B>addBasicSchema</B>()</PRE>
452 <DL>
453 <DD>Create and add a new Basic Schema to this metadata. Typically a XMP document
454 will only have one schema for each type (but multiple are supported) so it is recommended
455 that you first check the existence of a this scheme by using getDublinCoreSchema()
456 <P>
457 <DD><DL>
458
459 <DT><B>Returns:</B><DD>A new blank PDF schema that is now part of the metadata.</DL>
460 </DD>
461 </DL>
462 <HR>
463
464 <A NAME="setEncoding(java.lang.String)"><!-- --></A><H3>
465 setEncoding</H3>
466 <PRE>
467 public void <B>setEncoding</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;xmlEncoding)</PRE>
468 <DL>
469 <DD>The encoding used to write the XML. Default value:UTF-8<br/>
470 See the ENCODING_XXX constants
471 <P>
472 <DD><DL>
473 <DT><B>Parameters:</B><DD><CODE>xmlEncoding</CODE> - The encoding to write the XML as.</DL>
474 </DD>
475 </DL>
476 <HR>
477
478 <A NAME="getEncoding()"><!-- --></A><H3>
479 getEncoding</H3>
480 <PRE>
481 public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getEncoding</B>()</PRE>
482 <DL>
483 <DD>Get the current encoding that will be used to write the XML.
484 <P>
485 <DD><DL>
486
487 <DT><B>Returns:</B><DD>The current encoding to write the XML to.</DL>
488 </DD>
489 </DL>
490 <HR>
491
492 <A NAME="load(java.lang.String)"><!-- --></A><H3>
493 load</H3>
494 <PRE>
495 public static <A HREF="../../../org/jempbox/xmp/XMPMetadata.html" title="class in org.jempbox.xmp">XMPMetadata</A> <B>load</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;file)
496 throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>
497 <DL>
498 <DD>Load metadata from the filesystem.
499 <P>
500 <DD><DL>
501 <DT><B>Parameters:</B><DD><CODE>file</CODE> - The file to load the metadata from.
502 <DT><B>Returns:</B><DD>The loaded XMP document.
503 <DT><B>Throws:</B>
504 <DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - If there is an error reading the data.</DL>
505 </DD>
506 </DL>
507 <HR>
508
509 <A NAME="load(java.io.InputStream)"><!-- --></A><H3>
510 load</H3>
511 <PRE>
512 public static <A HREF="../../../org/jempbox/xmp/XMPMetadata.html" title="class in org.jempbox.xmp">XMPMetadata</A> <B>load</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/InputStream.html" title="class or interface in java.io">InputStream</A>&nbsp;is)
513 throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>
514 <DL>
515 <DD>Load metadata from the filesystem.
516 <P>
517 <DD><DL>
518 <DT><B>Parameters:</B><DD><CODE>is</CODE> - The stream to load the data from.
519 <DT><B>Returns:</B><DD>The loaded XMP document.
520 <DT><B>Throws:</B>
521 <DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - If there is an error reading the data.</DL>
522 </DD>
523 </DL>
524 <HR>
525
526 <A NAME="main(java.lang.String[])"><!-- --></A><H3>
527 main</H3>
528 <PRE>
529 public static void <B>main</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[]&nbsp;args)
530 throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Exception.html" title="class or interface in java.lang">Exception</A></PRE>
531 <DL>
532 <DD>Test main program.
533 <P>
534 <DD><DL>
535 <DT><B>Parameters:</B><DD><CODE>args</CODE> - The command line arguments.
536 <DT><B>Throws:</B>
537 <DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Exception.html" title="class or interface in java.lang">Exception</A></CODE> - If there is an error.</DL>
538 </DD>
539 </DL>
540 <HR>
541
542 <A NAME="getSchemas()"><!-- --></A><H3>
543 getSchemas</H3>
544 <PRE>
545 public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/List.html" title="class or interface in java.util">List</A> <B>getSchemas</B>()
546 throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>
547 <DL>
548 <DD>This will get a list of XMPSchema(or subclass) objects.
549 <P>
550 <DD><DL>
551
552 <DT><B>Returns:</B><DD>A non null read-only list of schemas that are part of this metadata.
553 <DT><B>Throws:</B>
554 <DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - If there is an error creating a specific schema.</DL>
555 </DD>
556 </DL>
557 <!-- ========= END OF CLASS DATA ========= -->
558 <HR>
559
560
561 <!-- ======= START OF BOTTOM NAVBAR ====== -->
562 <A NAME="navbar_bottom"><!-- --></A>
563 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
564 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
565 <TR>
566 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
567 <A NAME="navbar_bottom_firstrow"><!-- --></A>
568 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
569 <TR ALIGN="center" VALIGN="top">
570 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
571 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
572 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
573 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XMPMetadata.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
574 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
575 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
576 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
577 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
578 </TR>
579 </TABLE>
580 </TD>
581 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
582 </EM>
583 </TD>
584 </TR>
585
586 <TR>
587 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
588 &nbsp;<A HREF="../../../org/jempbox/xmp/Thumbnail.html" title="class in org.jempbox.xmp"><B>PREV CLASS</B></A>&nbsp;
589 &nbsp;<A HREF="../../../org/jempbox/xmp/XMPSchema.html" title="class in org.jempbox.xmp"><B>NEXT CLASS</B></A></FONT></TD>
590 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
591 <A HREF="../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
592 &nbsp;<A HREF="XMPMetadata.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
593 &nbsp;<SCRIPT type="text/javascript">
594 <!--
595 if(window==top) {
596 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
597 }
598 //-->
599 </SCRIPT>
600 <NOSCRIPT>
601 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
602 </NOSCRIPT>
603
604 </FONT></TD>
605 </TR>
606 <TR>
607 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
608 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
609 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
610 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
611 </TR>
612 </TABLE>
613 <A NAME="skip-navbar_bottom"></A>
614 <!-- ======== END OF BOTTOM NAVBAR ======= -->
615
616 <HR>
617
618 </BODY>
619 </HTML>

  ViewVC Help
Powered by ViewVC 1.1.26