RAT (Release Audit Tool) results

The following document contains the results of RAT (Release Audit Tool).

*****************************************************
Summary
-------
Notes: 3
Binaries: 6
Archives: 0
Standards: 23

Apache Licensed: 15
Generated Documents: 0

JavaDocs are generated and so license header is optional
Generated files do not required license headers

8 Unknown Licenses

*******************************

Archives (+ indicates readable, $ unreadable): 

 
*****************************************************
  Files with AL headers will be marked L
  Binary files (which do not require AL headers) will be marked B
  Compressed archives will be marked A
  Notices, licenses etc will be marked N
 !????? build.properties.sample
 !????? build.xml
  N     example/Readme.txt
  N     LICENSE.txt
  N     NOTICE.txt
  AL    pom.xml
 !????? project.properties
 !????? project.xml
  AL    src/java/org/apache/commons/xmlio/in/ConversionHelpers.java
  AL    src/java/org/apache/commons/xmlio/in/DefaultSimpleImportHandler.java
  AL    src/java/org/apache/commons/xmlio/in/Item.java
 !????? src/java/org/apache/commons/xmlio/in/package.html
  AL    src/java/org/apache/commons/xmlio/in/SimpleImporter.java
  AL    src/java/org/apache/commons/xmlio/in/SimpleImporterException.java
  AL    src/java/org/apache/commons/xmlio/in/SimpleImportHandler.java
  AL    src/java/org/apache/commons/xmlio/in/SimplePath.java
  AL    src/java/org/apache/commons/xmlio/out/XMLEncode.java
  AL    src/java/org/apache/commons/xmlio/out/XMLOutputStreamWriter.java
  AL    src/java/org/apache/commons/xmlio/out/XMLStringWriter.java
  AL    src/java/org/apache/commons/xmlio/out/XMLWriter.java
  B     src/site/resources/images/xmlio-logo-white.png
  B     src/site/resources/images/xmlio-logo-white.xcf
  AL    src/site/site.xml
  AL    src/test/org/apache/commons/xmlio/in/SimpleImportTest.java
  AL    src/test/org/apache/commons/xmlio/out/XMLWriterTest.java
 !????? xdocs/downloads.xml
  B     xdocs/images/xmlio-logo-white.png
  B     xdocs/images/xmlio-logo-white.xcf
 !????? xdocs/index.xml
 !????? xdocs/navigation.xml
  B     xdocs/xmlio-in.pdf
  B     xdocs/xmlio-out.pdf
 
 *****************************************************
 Printing headers for files without AL header...
 
 
 =======================================================================
 ==build.properties.sample
 =======================================================================
 #
# build properties sample, move to build.properties and adapt to your settings 
#

# compile options

compile.debug=on
compile.deprecation=on
compile.optimize=on


 =======================================================================
 ==build.xml
 =======================================================================
 <?xml version="1.0"?>

<!-- 
  =======================================================================
  Commons xmlio build file
  ======================================================================= 
-->
<project name="commons-xmlio" default="all" basedir=".">

  <!-- 
  ===================================================================
  Set build properties
  =================================================================== 
  -->

  <property file="${basedir}/build.properties"/>

  <property name="compile.debug" value="true" />
  <property name="compile.deprecation" value="true" />
  <property name="compile.optimize" value="true" />

  <property name="version" value="0.1pre"/>
  <property name="name" value="commons-xmlio" />
  <property name="final.name" value="${name}-${version}"/>

  <!-- 
  ===================================================================
  Set the properties related to the source tree
  =================================================================== 
  -->

  <property name="src.dir" value="${basedir}/src"/>
  <property name="java.dir" value="${src.dir}/java"/>
  <property name="test.dir" value="${src.dir}/test"/>
  <property name="lib.dir" value="${basedir}/lib"/>
  <property name="docs.dir" value="${basedir}/doc"/>
  <property name="conf.dir" value="${src.dir}/conf"/>
  <property name="example.dir" value="${basedir}/example"/>

  <!-- 
  ===================================================================
  Set the properties for the build area
  =================================================================== 
  -->
  <property name="build.dir" value="${basedir}/build"/>
  <property name="build.classes" value="${build.dir}/classes"/>
  <property name="build.lib" value="${build.dir}/lib"/>
  <property name="build.javadocs" value="${build.dir}/javadoc"/>

  <property name="dist.dir" value="${basedir}/dist"/>

 =======================================================================
 ==project.properties
 =======================================================================
 maven.checkstyle.properties = checkstyle.xml

# uncomment the next line to work in offline mode (no jar download & no linkcheck)
#maven.mode.online=
maven.changelog.factory=org.apache.maven.svnlib.SvnChangeLogFactory

maven.javadoc.author=false
maven.javadoc.links=http://java.sun.com/products/jdk/1.4/docs/api

maven.xdoc.jsl=../commons-build/commons-site.jsl
maven.xdoc.date=bottom
maven.xdoc.poweredby.image=maven-feather.png
maven.xdoc.version=${pom.currentVersion}
maven.xdoc.developmentProcessUrl=http://commons.apache.org/charter.html
maven.xdoc.includeProjectDocumentation=yes

maven.compile.debug=on
maven.compile.deprecation=off
maven.compile.optimize=off

maven.jarResources.basedir=src/java
maven.jar.excludes=**/package.html
maven.junit.fork=true
maven.junit.sysproperties=org.xml.sax.driver
org.xml.sax.driver=org.apache.xerces.parsers.SAXParser

clover.excludes=**/Test*.java

 =======================================================================
 ==project.xml
 =======================================================================
 <?xml version="1.0"?>
<project>
  <extend>../commons-build/sandbox-project.xml</extend>
  <name>Commons XMLIO</name>
  <id>commons-xmlio</id>
  <logo>/images/xmlio-logo-white.png</logo>
  <url>http://commons.apache.org/sandbox/xmlio/</url>
  <inceptionYear>2004</inceptionYear>
  <shortDescription>Commons XMLIO</shortDescription>
  <description>Commons XMLIO</description>

  <currentVersion>0.1-dev</currentVersion>
  <versions>
  </versions>
  <branches>
  </branches>

  <developers>
    <developer>
      <name>Oliver Zeigermann</name>
      <id>ozeigermann</id>
      <email></email>
      <organization></organization>
    </developer>
  </developers>
  
  <contributors>
    <contributor>
      <name>Anaximandro (Woody)</name>
      <email>agodinhost@globo.com</email>
    </contributor>
  </contributors>

  <dependencies>
<!--
    <dependency>
      <groupId>geronimo-spec</groupId>
      <artifactId>geronimo-spec-j2ee</artifactId>
      <version>1.0-M1</version>
    </dependency>
    <dependency>
      <id>commons-codec</id>
      <version>1.2</version>
    </dependency>
    <dependency>
      <id>commons-collections</id>
      <version>3.0</version>
    </dependency>
    <dependency>
      <id>log4j</id>

 =======================================================================
 ==src/java/org/apache/commons/xmlio/in/package.html
 =======================================================================
 <HTML>
<BODY>
<h1>SimpleImporter</H1>
<b>Simple</b> and <b>fast</b> importer for XML configuration or import files.
<br>
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:<br>
<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
histories obsolete.
<li><em>Leading character data can be included into start element callback</em>: 
In many cases import files do not or only rarely contain mixed content. If so
it is convenient to have the full content of an element at hand with a 
single callback.
<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.
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.
</ol>
<br>
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. 
</BODY>
</HTML>

 =======================================================================
 ==xdocs/downloads.xml
 =======================================================================
 <?xml version="1.0"?>
<document>
   <properties>
      <title>Downloads</title>
      <author email="dev@commons.apache.org">Commons Documentation Team</author>
      <revision>$Id: downloads.xml 561366 2007-07-31 15:58:29Z rahul $</revision>
   </properties>

   <body>
      <section name="Releases">
         <p>There are no releases available.</p>

<!--
         <p>The following releases are available:</p>
         <ul>
           <li>Version 1.1 - 20 October 2003</li>
           <li>Version 1.0 - 12 August 2002</li>
         </ul>
         <br/>
         <p>
            The latest binary release is always available on the 
            <a href="http://jakarta.apache.org/site/binindex.cgi#commons-xmlio">
            Jakarta Binary Downloads page</a>,
            its source is available from 
            <a href="http://jakarta.apache.org/site/sourceindex.cgi#commons-xmlio">
            Jakarta Source Downloads page</a>.
         </p>
         <p>
            Older releases are retained by the Apache Software Foundation but are 
            moved into a
            <a href="http://archive.apache.org/dist/jakarta/commons/xmlio/">
            special archive area</a>.
         </p>
         <p>
           <a href="http://cvs.apache.org/builds/jakarta-commons/nightly/commons-xmlio/">
           Nightly source and binary drops</a> are available.
         </p>
-->
         <p>
            Access to the source tree to see the latest and greatest code is possible
            through <a href="cvs-usage.html">anonymous SVN access</a>.
         </p>
      </section>

<!--
      <section name="Release Candidate">
         <p>
            Release candidates for the upcoming 1.1 release can be downloaded 
            <a href="http://cvs.apache.org/~dirkv/builds/">here</a>.
         </p>

 =======================================================================
 ==xdocs/index.xml
 =======================================================================
 <?xml version="1.0"?>

<document>

 <properties>
  <title>Overview</title>
  <author email="dev@commons.apache.org">Commons Documentation Team</author>
 </properties>

 <body>

<section name="The XMLIO Component">

<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://commons.apache.org/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
histories obsolete.</li>
<li><em>Leading character data can be included into start element callback</em>: 
In many cases import files do not or only rarely contain mixed content. If so
it is convenient to have the full content of an element at hand with a 

 =======================================================================
 ==xdocs/navigation.xml
 =======================================================================
 <?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE org.apache.commons.menus SYSTEM '../../commons-build/menus/menus.dtd'>
<project name="Commons&#xA0;XMLIO">
    <title>Commons&#xA0;XMLIO</title>
    <body>
        <menu name="Commons&#xA0;XMLIO">
            <item name="Overview"                      href="/index.html" />
            <item name="API&#xA0;Documentation"        href="/apidocs/index.html"/>
            <item name="Downloads"                     href="/downloads.html"/>
        </menu>
        &common-menus;
    </body>
</project>