Use field variable with qualified field name. FIX namespace!
[marc4j.git] / apidoc / org / marc4j / MarcXmlParser.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
2 <!--NewPage-->\r
3 <HTML>\r
4 <HEAD>\r
5 <!-- Generated by javadoc (build 1.5.0_06) on Fri Oct 17 16:04:52 EDT 2008 -->\r
6 <TITLE>\r
7 MarcXmlParser (MARC4J API)\r
8 </TITLE>\r
9 \r
10 <META NAME="keywords" CONTENT="org.marc4j.MarcXmlParser class">\r
11 \r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">\r
13 \r
14 <SCRIPT type="text/javascript">\r
15 function windowTitle()\r
16 {\r
17     parent.document.title="MarcXmlParser (MARC4J API)";\r
18 }\r
19 </SCRIPT>\r
20 <NOSCRIPT>\r
21 </NOSCRIPT>\r
22 \r
23 </HEAD>\r
24 \r
25 <BODY BGCOLOR="white" onload="windowTitle();">\r
26 \r
27 \r
28 <!-- ========= START OF TOP NAVBAR ======= -->\r
29 <A NAME="navbar_top"><!-- --></A>\r
30 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>\r
31 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
32 <TR>\r
33 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
34 <A NAME="navbar_top_firstrow"><!-- --></A>\r
35 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
36   <TR ALIGN="center" VALIGN="top">\r
37   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
38   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
39   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/MarcXmlParser.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
42   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
45   </TR>\r
46 </TABLE>\r
47 </TD>\r
48 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
49 </EM>\r
50 </TD>\r
51 </TR>\r
52 \r
53 <TR>\r
54 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
55 &nbsp;<A HREF="../../org/marc4j/MarcXmlHandler.html" title="class in org.marc4j"><B>PREV CLASS</B></A>&nbsp;\r
56 &nbsp;<A HREF="../../org/marc4j/MarcXmlParserThread.html" title="class in org.marc4j"><B>NEXT CLASS</B></A></FONT></TD>\r
57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
58   <A HREF="../../index.html?org/marc4j/MarcXmlParser.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
59 &nbsp;<A HREF="MarcXmlParser.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
60 &nbsp;<SCRIPT type="text/javascript">\r
61   <!--\r
62   if(window==top) {\r
63     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
64   }\r
65   //-->\r
66 </SCRIPT>\r
67 <NOSCRIPT>\r
68   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
69 </NOSCRIPT>\r
70 \r
71 \r
72 </FONT></TD>\r
73 </TR>\r
74 <TR>\r
75 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
76   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
77 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
78 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
79 </TR>\r
80 </TABLE>\r
81 <A NAME="skip-navbar_top"></A>\r
82 <!-- ========= END OF TOP NAVBAR ========= -->\r
83 \r
84 <HR>\r
85 <!-- ======== START OF CLASS DATA ======== -->\r
86 <H2>\r
87 <FONT SIZE="-1">\r
88 org.marc4j</FONT>\r
89 <BR>\r
90 Class MarcXmlParser</H2>\r
91 <PRE>\r
92 <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>\r
93   <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>org.marc4j.MarcXmlParser</B>\r
94 </PRE>\r
95 <HR>\r
96 <DL>\r
97 <DT><PRE>public class <B>MarcXmlParser</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>\r
98 </PRE>\r
99 \r
100 <P>\r
101 Creates <code>Record</code> objects from SAX events and pushes each item
102  onto the top of the <code>RecordStack</code>. Used by
103  <code>MarcXmlParserThread</code>.
104  
105  This class requires a JAXP compliant XML parser and XSLT processor. The
106  underlying SAX2 parser should be namespace aware.\r
107 <P>\r
108 \r
109 <P>\r
110 <DL>\r
111 <DT><B>Version:</B></DT>\r
112   <DD>$Revision: 1.2 $</DD>\r
113 <DT><B>Author:</B></DT>\r
114   <DD>Bas Peters</DD>\r
115 </DL>\r
116 <HR>\r
117 \r
118 <P>\r
119 \r
120 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
121 \r
122 <A NAME="constructor_summary"><!-- --></A>\r
123 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
124 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
125 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
126 <B>Constructor Summary</B></FONT></TH>\r
127 </TR>\r
128 <TR BGCOLOR="white" CLASS="TableRowColor">\r
129 <TD><CODE><B><A HREF="../../org/marc4j/MarcXmlParser.html#MarcXmlParser(org.marc4j.MarcXmlHandler)">MarcXmlParser</A></B>(<A HREF="../../org/marc4j/MarcXmlHandler.html" title="class in org.marc4j">MarcXmlHandler</A>&nbsp;handler)</CODE>\r
130 \r
131 <BR>\r
132 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default constructor.</TD>\r
133 </TR>\r
134 </TABLE>\r
135 &nbsp;\r
136 <!-- ========== METHOD SUMMARY =========== -->\r
137 \r
138 <A NAME="method_summary"><!-- --></A>\r
139 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
140 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
141 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
142 <B>Method Summary</B></FONT></TH>\r
143 </TR>\r
144 <TR BGCOLOR="white" CLASS="TableRowColor">\r
145 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
146 <CODE>&nbsp;void</CODE></FONT></TD>\r
147 <TD><CODE><B><A HREF="../../org/marc4j/MarcXmlParser.html#parse(org.xml.sax.InputSource)">parse</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/org/xml/sax/InputSource.html" title="class or interface in org.xml.sax">InputSource</A>&nbsp;input)</CODE>\r
148 \r
149 <BR>\r
150 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Calls the parser.</TD>\r
151 </TR>\r
152 <TR BGCOLOR="white" CLASS="TableRowColor">\r
153 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
154 <CODE>&nbsp;void</CODE></FONT></TD>\r
155 <TD><CODE><B><A HREF="../../org/marc4j/MarcXmlParser.html#parse(org.xml.sax.InputSource, javax.xml.transform.sax.TransformerHandler)">parse</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/org/xml/sax/InputSource.html" title="class or interface in org.xml.sax">InputSource</A>&nbsp;input,\r
156       <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/javax/xml/transform/sax/TransformerHandler.html" title="class or interface in javax.xml.transform.sax">TransformerHandler</A>&nbsp;th)</CODE>\r
157 \r
158 <BR>\r
159 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Calls the parser and tries to transform the source into MARCXML using the
160  given stylesheet source before creating <code>Record</code> objects.</TD>\r
161 </TR>\r
162 </TABLE>\r
163 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
164 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
165 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
166 <TH ALIGN="left"><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></TH>\r
167 </TR>\r
168 <TR BGCOLOR="white" CLASS="TableRowColor">\r
169 <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>\r
170 </TR>\r
171 </TABLE>\r
172 &nbsp;\r
173 <P>\r
174 \r
175 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
176 \r
177 <A NAME="constructor_detail"><!-- --></A>\r
178 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
179 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
180 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
181 <B>Constructor Detail</B></FONT></TH>\r
182 </TR>\r
183 </TABLE>\r
184 \r
185 <A NAME="MarcXmlParser(org.marc4j.MarcXmlHandler)"><!-- --></A><H3>\r
186 MarcXmlParser</H3>\r
187 <PRE>\r
188 public <B>MarcXmlParser</B>(<A HREF="../../org/marc4j/MarcXmlHandler.html" title="class in org.marc4j">MarcXmlHandler</A>&nbsp;handler)</PRE>\r
189 <DL>\r
190 <DD>Default constructor.\r
191 <P>\r
192 <DL>\r
193 <DT><B>Parameters:</B><DD><CODE>handler</CODE> - the <code>MarcXmlHandler</code> object</DL>\r
194 </DL>\r
195 \r
196 <!-- ============ METHOD DETAIL ========== -->\r
197 \r
198 <A NAME="method_detail"><!-- --></A>\r
199 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
200 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
201 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
202 <B>Method Detail</B></FONT></TH>\r
203 </TR>\r
204 </TABLE>\r
205 \r
206 <A NAME="parse(org.xml.sax.InputSource)"><!-- --></A><H3>\r
207 parse</H3>\r
208 <PRE>\r
209 public void <B>parse</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/org/xml/sax/InputSource.html" title="class or interface in org.xml.sax">InputSource</A>&nbsp;input)</PRE>\r
210 <DL>\r
211 <DD>Calls the parser.\r
212 <P>\r
213 <DD><DL>\r
214 <DT><B>Parameters:</B><DD><CODE>input</CODE> - the input source</DL>\r
215 </DD>\r
216 </DL>\r
217 <HR>\r
218 \r
219 <A NAME="parse(org.xml.sax.InputSource, javax.xml.transform.sax.TransformerHandler)"><!-- --></A><H3>\r
220 parse</H3>\r
221 <PRE>\r
222 public void <B>parse</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/org/xml/sax/InputSource.html" title="class or interface in org.xml.sax">InputSource</A>&nbsp;input,\r
223                   <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/javax/xml/transform/sax/TransformerHandler.html" title="class or interface in javax.xml.transform.sax">TransformerHandler</A>&nbsp;th)</PRE>\r
224 <DL>\r
225 <DD>Calls the parser and tries to transform the source into MARCXML using the
226  given stylesheet source before creating <code>Record</code> objects.\r
227 <P>\r
228 <DD><DL>\r
229 <DT><B>Parameters:</B><DD><CODE>input</CODE> - the input source<DD><CODE>th</CODE> - the transformation content handler</DL>\r
230 </DD>\r
231 </DL>\r
232 <!-- ========= END OF CLASS DATA ========= -->\r
233 <HR>\r
234 \r
235 \r
236 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
237 <A NAME="navbar_bottom"><!-- --></A>\r
238 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
239 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
240 <TR>\r
241 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
242 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
243 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
244   <TR ALIGN="center" VALIGN="top">\r
245   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
246   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
247   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
248   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/MarcXmlParser.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
249   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
250   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
251   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
252   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
253   </TR>\r
254 </TABLE>\r
255 </TD>\r
256 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
257 </EM>\r
258 </TD>\r
259 </TR>\r
260 \r
261 <TR>\r
262 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
263 &nbsp;<A HREF="../../org/marc4j/MarcXmlHandler.html" title="class in org.marc4j"><B>PREV CLASS</B></A>&nbsp;\r
264 &nbsp;<A HREF="../../org/marc4j/MarcXmlParserThread.html" title="class in org.marc4j"><B>NEXT CLASS</B></A></FONT></TD>\r
265 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
266   <A HREF="../../index.html?org/marc4j/MarcXmlParser.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
267 &nbsp;<A HREF="MarcXmlParser.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
268 &nbsp;<SCRIPT type="text/javascript">\r
269   <!--\r
270   if(window==top) {\r
271     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
272   }\r
273   //-->\r
274 </SCRIPT>\r
275 <NOSCRIPT>\r
276   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
277 </NOSCRIPT>\r
278 \r
279 \r
280 </FONT></TD>\r
281 </TR>\r
282 <TR>\r
283 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
284   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
285 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
286 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
287 </TR>\r
288 </TABLE>\r
289 <A NAME="skip-navbar_bottom"></A>\r
290 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
291 \r
292 <HR>\r
293 Copyright © 2002-2006 Bas Peters. All Rights Reserved.\r
294 </BODY>\r
295 </HTML>\r