svn commit: r703375 - /forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/java/org/apache/forrest/dispatcher/impl/XMLStructurerAxiom.java

[th...@apache.org]

Author: thorsten
Date: Fri Oct 10 03:06:30 2008
New Revision: 703375

URL: http://svn.apache.org/viewvc?rev=703375&view=rev
Log:
Adding more javadoc comments

Modified:
    forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/java/org/apache/forrest/dispatcher/impl/XMLStructurerAxiom.java

Modified: forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/java/org/apache/forrest/dispatcher/impl/XMLStructurerAxiom.java
URL: http://svn.apache.org/viewvc/forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/java/org/apache/forrest/dispatcher/impl/XMLStructurerAxiom.java?rev=703375&r1=703374&r2=703375&view=diff
==============================================================================
--- forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/java/org/apache/forrest/dispatcher/impl/XMLStructurerAxiom.java (original)
+++ forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/java/org/apache/forrest/dispatcher/impl/XMLStructurerAxiom.java Fri Oct 10 03:06:30 2008
@@ -7,8 +7,6 @@
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Iterator;
-import java.util.LinkedHashMap;
-import java.util.LinkedHashSet;
 import java.util.Map;
 
 import javax.xml.namespace.QName;
@@ -54,6 +52,23 @@
 
   private boolean shrink;
 
+  /**
+   * AXIOM stands for AXis Object Model 
+   * (also known as OM - Object Model) and refers to the XML
+   * infoset model that was initially developed for Apache Axis2.
+   * <p>XML infoset refers to the information included inside the 
+   * XML and for programmatical manipulation it is convenient to 
+   * have a representation of this XML infoset in a language specific manner. 
+   * <p>For an object oriented language the obvious choice is a model 
+   * made up of objects.<p>
+   * The axiom implementation is an object model
+       * approach to StAX. It allows you a dom like navigation
+       * (allocate xpath nodes), adding of child elements in
+       * this xpath statement and many more.
+   * @param config the current dispatcher configuration. 
+   * @param defaultProperties the properties that we want to 
+   * pass later to the contract transformation.
+   */
   public XMLStructurerAxiom(DispatcherBean config, Map<String, Object> defaultProperties) {
     this.contractRep = new ContractFactory(config);
     this.resolver = config.getResolver();