Original 2.4. With additional eclipse .project/classpath and git ignore
[marc4j.git] / apidoc / overview-summary.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:53 EDT 2008 -->\r
6 <TITLE>\r
7 Overview (MARC4J API)\r
8 </TITLE>\r
9 \r
10 <META NAME="keywords" CONTENT="Overview, MARC4J API">\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="Overview (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="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Overview</B></FONT>&nbsp;</TD>\r
38   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Package</FONT>&nbsp;</TD>\r
39   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>\r
40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Use</FONT>&nbsp;</TD>\r
41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="overview-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;PREV&nbsp;\r
56 &nbsp;NEXT</FONT></TD>\r
57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
58   <A HREF="index.html?overview-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
59 &nbsp;<A HREF="overview-summary.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 </TABLE>\r
75 <A NAME="skip-navbar_top"></A>\r
76 <!-- ========= END OF TOP NAVBAR ========= -->\r
77 \r
78 <HR>\r
79 <CENTER>\r
80 <H1>\r
81 MARC4J API\r
82 </H1>\r
83 </CENTER>\r
84 The goal of MARC4J is to provide an easy to use Application Programming Interface (API) \r
85   for working with <a href="http://www.loc.gov/marc/">MARC</a> and \r
86   <a href="http://www.loc.gov/standards/marcxml/">MARC XML</a> in Java.\r
87 <P>\r
88 <B>See:</B>\r
89 <BR>\r
90 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<A HREF="#overview_description"><B>Description</B></A>\r
91 <P>\r
92 \r
93 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
94 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
95 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
96 <B>Packages</B></FONT></TH>\r
97 </TR>\r
98 <TR BGCOLOR="white" CLASS="TableRowColor">\r
99 <TD WIDTH="20%"><B><A HREF="org/marc4j/package-summary.html">org.marc4j</A></B></TD>\r
100 <TD>Classes to read and write MARC and MARCXML records.</TD>\r
101 </TR>\r
102 <TR BGCOLOR="white" CLASS="TableRowColor">\r
103 <TD WIDTH="20%"><B><A HREF="org/marc4j/converter/package-summary.html">org.marc4j.converter</A></B></TD>\r
104 <TD>Interfaces for character conversions.</TD>\r
105 </TR>\r
106 <TR BGCOLOR="white" CLASS="TableRowColor">\r
107 <TD WIDTH="20%"><B><A HREF="org/marc4j/converter/impl/package-summary.html">org.marc4j.converter.impl</A></B></TD>\r
108 <TD>Classes for byte and character conversions.</TD>\r
109 </TR>\r
110 <TR BGCOLOR="white" CLASS="TableRowColor">\r
111 <TD WIDTH="20%"><B><A HREF="org/marc4j/marc/package-summary.html">org.marc4j.marc</A></B></TD>\r
112 <TD>Interfaces for the record object model.</TD>\r
113 </TR>\r
114 <TR BGCOLOR="white" CLASS="TableRowColor">\r
115 <TD WIDTH="20%"><B><A HREF="org/marc4j/marc/impl/package-summary.html">org.marc4j.marc.impl</A></B></TD>\r
116 <TD>Default implementation of the MARC record object model.</TD>\r
117 </TR>\r
118 <TR BGCOLOR="white" CLASS="TableRowColor">\r
119 <TD WIDTH="20%"><B><A HREF="org/marc4j/util/package-summary.html">org.marc4j.util</A></B></TD>\r
120 <TD>Provides some basic command-line utilities for converting MARC and MARCXML records.</TD>\r
121 </TR>\r
122 </TABLE>\r
123 \r
124 <P>\r
125 &nbsp;<A NAME="overview_description"><!-- --></A>\r
126 <P>\r
127 <p>The goal of MARC4J is to provide an easy to use Application Programming Interface (API) \r
128   for working with <a href="http://www.loc.gov/marc/">MARC</a> and \r
129   <a href="http://www.loc.gov/standards/marcxml/">MARC XML</a> in Java. MARC stands for \r
130   MAchine Readable Cataloguing and is a widely used exchange format for bibliographic data. \r
131   MARC XML provides a loss-less conversion between MARC (MARC21 but also other formats like UNIMARC) and XML.</p>\r
132   \r
133   <p>The structure of a MARC record is defined in the ISO 2709:1996 (Format for Information Exchange) standard \r
134   (or ANSI/NISO Z39.2-1994, available <a href="http://www.niso.org/standards/resources/Z39-2.pdf">online</a> \r
135   from NISO). The MARC4J API is not a full implementation of the ISO 2709:1996 standard. The standard is \r
136   implemented as it is used in the MARC formats.</p>\r
137  \r
138   <p>MARC4J provides readers and writers for MARC and MARC XML. A <A HREF="org/marc4j/MarcReader.html" title="interface in org.marc4j"><CODE>MarcReader</CODE></A> \r
139   implementation parses input data and provides an iterator over a collection \r
140   of <A HREF="org/marc4j/marc/Record.html" title="interface in org.marc4j.marc"><CODE>Record</CODE></A> objects. The record object model is also suitable for in-memory \r
141   editing of MARC records, just as DOM is used for XML editing purposes. \r
142   Using a <A HREF="org/marc4j/MarcWriter.html" title="interface in org.marc4j"><CODE>MarcWriter</CODE></A> implementation it is possible to create MARC or MARC XML. \r
143   Once MARC data has been converted to XML you can further process the result with XSLT, for \r
144   example to convert MARC to <a href="http://www.loc.gov/standards/mods/">MODS</a>.</p>\r
145 \r
146   <p>Although MARC4J is primarily designed for Java development you can use the command-line \r
147     utilities <A HREF="org/marc4j/util/MarcXmlDriver.html" title="class in org.marc4j.util"><CODE>MarcXmlDriver</CODE></A> and <A HREF="org/marc4j/util/XmlMarcDriver.html" title="class in org.marc4j.util"><CODE>XmlMarcDriver</CODE></A> \r
148     to convert between MARC and MARCXML. It is also possible to pre or post process the result \r
149     using XSLT, for example to convert directly from MODS to MARC or from MARC to MODS.</p>\r
150 \r
151   <p>The source code is published under version 2.1 of \r
152   the <a href="http://www.gnu.org/copyleft/lesser.html">GNU Lesser General Public License</a>. \r
153   In brief, this means there&apos;s no warranty and you can do anything you like with it. \r
154   The text of the license is included in the distribution. If you make changes to MARC4J and redistribute \r
155   those changes, then you must publish your modified version under the LGPL.</p>\r
156 \r
157   <p>For more information about the MARC4J project visit <a href="http://marc4j.tigris.org">http://marc4j.tigris.org</a>.</p>\r
158 <P>\r
159 \r
160 <P>\r
161 <HR>\r
162 \r
163 \r
164 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
165 <A NAME="navbar_bottom"><!-- --></A>\r
166 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
167 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
168 <TR>\r
169 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
170 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
171 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
172   <TR ALIGN="center" VALIGN="top">\r
173   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Overview</B></FONT>&nbsp;</TD>\r
174   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Package</FONT>&nbsp;</TD>\r
175   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>\r
176   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Use</FONT>&nbsp;</TD>\r
177   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
178   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
179   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
180   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
181   </TR>\r
182 </TABLE>\r
183 </TD>\r
184 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
185 </EM>\r
186 </TD>\r
187 </TR>\r
188 \r
189 <TR>\r
190 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
191 &nbsp;PREV&nbsp;\r
192 &nbsp;NEXT</FONT></TD>\r
193 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
194   <A HREF="index.html?overview-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
195 &nbsp;<A HREF="overview-summary.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
196 &nbsp;<SCRIPT type="text/javascript">\r
197   <!--\r
198   if(window==top) {\r
199     document.writeln('<A HREF="allclasses-noframe.html"><B>All Classes</B></A>');\r
200   }\r
201   //-->\r
202 </SCRIPT>\r
203 <NOSCRIPT>\r
204   <A HREF="allclasses-noframe.html"><B>All Classes</B></A>\r
205 </NOSCRIPT>\r
206 \r
207 \r
208 </FONT></TD>\r
209 </TR>\r
210 </TABLE>\r
211 <A NAME="skip-navbar_bottom"></A>\r
212 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
213 \r
214 <HR>\r
215 Copyright © 2002-2006 Bas Peters. All Rights Reserved.\r
216 </BODY>\r
217 </HTML>\r