commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ozeigerm...@apache.org
Subject cvs commit: jakarta-commons-sandbox/xmlio/xdocs index.xml
Date Wed, 01 Dec 2004 18:08:16 GMT
ozeigermann    2004/12/01 10:08:16

  Modified:    xmlio/xdocs index.xml
  Log:
  Completed overview
  
  Revision  Changes    Path
  1.2       +55 -16    jakarta-commons-sandbox/xmlio/xdocs/index.xml
  
  Index: index.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-commons-sandbox/xmlio/xdocs/index.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- index.xml	17 Oct 2004 14:13:39 -0000	1.1
  +++ index.xml	1 Dec 2004 18:08:16 -0000	1.2
  @@ -11,14 +11,36 @@
   
   <section name="The XMLIO Component">
   
  -<p><b>Simple</b> and <b>fast</b> importer for XML configuration
or import files.</p>
  -<p>
  -It is based on SAX and can be considered an extension to it. This means it is
  -callback oriented and does not build an internal data structure like the DOM.
  -While SAX is simple, fast, and memory friendly it might be a bit too 
  -rudimentary for most tasks. <code>SimpleImporter</code> adds more high level
  -means for importing XML while preserving the SAX's benefits. These are the 
  -main extensions to the SAX:
  +<p>XMLIO is a low level library to assist you in the straight forward process of
importing and exporting XML from and to your Java applications. 
  +All of this has been designed having performance and simplicity in
  +mind. No magic is involved. Additionally, it is very lightweight and has exactly no
  +dependencies on any other libraries.</p>
  +
  +<p>XMLIO consists of three parts:</p>
  +
  +<subsection name="Structured reading of XML">
  +
  +<p>XMLIO's main part - <a
  +href="apidocs/org/apache/commons/xmlio/in/SimpleImporter.html">SimpleImporter</a>
  +- is a simple and fast importer for XML.</p> 
  +<p>It is based on SAX and can be considered an extension to it. This
  +means it is callback oriented and does not build an internal data
  +structure like the DOM. No data access objects (DAO) will be created
  +either. This means it is <b>no XML->Java Object
  +Mapper</b>, but rahter a XML->Generic Mehtod Mapper (if there was
  +anything like this). You could easily use the simply importer without a single dynamic
  +construction of a class. </p>
  +<p>Comparing it to <a href="http://jakarta.apache.org/commons/digester/">Commons
Digester</a> the simple importer is much more
  +low level and much more simplistic. Beside <a
  +href="apidocs/org/apache/commons/xmlio/in/SimpleImporter.html">SimpleImporter</a>
  +you will only need to know the <a
  +href="apidocs/org/apache/commons/xmlio/in/SimpleImportHandler.html">call
  +back interface </a>. </p>
  +
  +<p>While preserving all benefits of SAX - among them performance,
  +simplicity and general usability - the simple importer adds more high
  +level means to SAX's rudimentary features. These are the main
  +extensions:
   <ol>
   <li><em>Every callback includes a full path to the XML element</em>:
In many 
   cases this will make maintaining local stacks for keeping track of element
  @@ -28,16 +50,33 @@
   it is convenient to have the full content of an element at hand with a 
   single callback.</li>
   <li><em>More than one listener can be registered</em>: Some XML files
contain
  -different types of data that may be interesting to different listeners. E.g.
  +different types/aspects of data that may be interesting to different listeners. E.g.
   data to import from a server may contain error messages along with the real
   content data. It may be convenient to
  -processes these blocks of data separately.</li>
  -</ol>
  -</p><p>
  -Even though the DOM in combination with XPath can not to be beaten in the 
  -area of convenience, I consider it a good compromise between convenience,
  -simplicity and speed. 
  -</p>
  +processes these blocks of data separately. Another example is a debug or
  +log listener.</li>
  +</ol></p>
  +</subsection>
  +
  +<subsection name="Writing data to formatted XML">
  +
  +<p>You can write your data into a <a
  +href="apidocs/org/apache/commons/xmlio/out/XMLWriter.html">formatted
  +XML writer</a>. Formatting and encoding is done as straight forward as possible.
Everything you know 
  +better than this class must be done by you. In effect, no unexpected
  +so called intelligent behavior or magic is to be feared. Another effect is high
  +speed and simplicity.</p>    
  +
  +</subsection>
  +
  +<subsection name="XML encoding and decoding helpers on the character (not the byte)
level">
  +
  +<p><a href="apidocs/org/apache/commons/xmlio/out/XMLEncode.html">Set
  +of methods</a> to encode and decode characters special to XML like 
  +<![CDATA[(& and < and " and ')]]>.</p> 
  +
  +</subsection>
  +
   </section>
   
   <section name="Releases">
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message