--- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/GNVArtifactBase.java	Fri Apr 09 14:34:45 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/GNVArtifactBase.java	Mon Apr 12 06:59:33 2010 +0000
@@ -56,7 +56,7 @@
 
 /**
  * This is the major gnv artifact and handles the requests specified in
- * {@link de.intevation.artifactdatabase.Artifact}.
+ * <code>de.intevation.artifactdatabase.Artifact</code>.
  *
  * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
  * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
@@ -86,39 +86,18 @@
                                                               + XPATH_IDENTIFIER_REPLACE
                                                               + "']";
 
-    /**
-     *
-     */
     public static final String XPATH_STATIC_NODE = "/art:result/art:ui/art:static";
 
-    /**
-     *
-     */
     public static final String XPATH_INPUT_DATA = "/art:action/art:data/art:input";
 
-    /**
-     *
-     */
     public static final String XPATH_INCLUDE_UI = "/art:action/art:include-ui";
 
-    /**
-     *
-     */
     public static final String XPATH_TARGET_NAME = "/art:action/art:target/@name";
 
-    /**
-     *
-     */
     public static final String XPATH_OUTPUT_NAME = "/art:action/art:out/@name";
 
-    /**
-     *
-     */
     public static final String XPATH_OUTPUT_PARAMS = "/art:action/art:out/art:params/art:input";
 
-    /**
-     *
-     */
     public static final String INITIAL_STATE = "product";
 
     /**
@@ -165,10 +144,6 @@
      * This method handles request for changing the current state of an
      * artifact. It is possible to step forward, backward, or to the initial
      * state for choosing a fis.
-     *
-     * @param target
-     * @param context
-     * @return
      */
     @Override
     public Document advance(Document target, CallContext context) {
@@ -273,13 +248,6 @@
     }
 
 
-    /**
-     * @param context
-     * @param result
-     * @param next
-     * @return
-     * @throws StateException
-     */
     private boolean go2NextState(CallContext context, Document result,
                                   State next) throws StateException {
         // 2. Transfer Results
@@ -301,14 +269,6 @@
     }
 
 
-    /**
-     *
-     * @param document
-     * @param nodeName
-     * @param state
-     * @param msg
-     * @return
-     */
     protected Document createReport(
         Document document,
         String   nodeName,
@@ -335,9 +295,6 @@
 
     /**
      * Step back to the previous state specified by <code>name</code>.
-     * @param current
-     * @param name
-     * @return
      */
     protected State getPreviousState(State current, String name) {
         if (current == null) {
@@ -367,11 +324,7 @@
         return false;
     }
 
-    /**
-     *
-     * @param context
-     * @return
-     */
+
     public Document initialize(CallContext context) {
         Document result = XMLUtils.newDocument();
         try {
@@ -429,22 +382,14 @@
         return null;
     }
 
-    /**
-     *
-     * @param document
-     * @return
-     */
+
     protected String readStateName(Document document) {
         String returnValue = XMLUtils.xpathString(
             document, XPATH_TARGET_NAME, ArtifactNamespaceContext.INSTANCE);
         return returnValue;
     }
 
-    /**
-     *
-     * @param document
-     * @return
-     */
+
     protected Node getConfigurationFragment(Document document) {
         log.debug("GNVArtifactBase.getConfigurationFragment");
         String xpathQuery = XPATH_ARTIFACT_CONFIGURATION.replaceAll(
@@ -466,8 +411,6 @@
      * @param target XML document which contains data.
      * @param context CallContext
      * @return XML document with success or error message.
-     * @see de.intevation.artifactdatabase.DefaultArtifact#feed(org.w3c.dom.Document,
-     *      de.intevation.artifacts.CallContext)
      */
     @Override
     public Document feed(Document target, CallContext context) {
@@ -514,10 +457,7 @@
 
     /**
      * Describe the current artifact.
-     * @param data
-     * @param context
      * @return The description of the current artifact.
-     * @see de.intevation.artifactdatabase.DefaultArtifact#describe(org.w3c.dom.Document, de.intevation.artifacts.CallContext)
      */
     @Override
     public Document describe(Document data, CallContext context) {
@@ -535,11 +475,6 @@
     /**
      * Initialse this artifact and insert some data if <code>data</code>
      * contains necessary information for this artifact.
-     * @param identifier
-     * @param context
-     * @param factory
-     * @param data
-     * @see de.intevation.artifactdatabase.DefaultArtifact#setup(java.lang.String, de.intevation.artifacts.ArtifactFactory, java.lang.Object, org.w3c.dom.Document)
      */
     @Override
     public void setup(String identifier, ArtifactFactory factory,
@@ -592,11 +527,6 @@
     /**
      * Create the xml document returned in {@link #describe(org.w3c.dom.Document,
      * de.intevation.artifacts.CallContext)}
-     *
-     * @param context
-     * @param uuid
-     * @param incudeUI
-     * @return
      */
     protected Document createDescibeOutput(
         CallContext context,
@@ -628,7 +558,6 @@
      * Determine the wish to append the user interface description to the
      * describe document.
      *
-     * @param document
      * @return True, if the user interface description should be appended,
      * otherwise false.
      */
@@ -643,12 +572,7 @@
         return includeUI;
     }
 
-    /**
-     *
-     * @param creator
-     * @param document
-     * @return
-     */
+
     protected Element createRootNode(
         XMLUtils.ElementCreator creator,
         Document                document
@@ -660,11 +584,6 @@
 
     /**
      * Append information about the current artifact (uuid, hash).
-     *
-     * @param creator
-     * @param parent
-     * @param document
-     * @param documentType
      */
     protected void createHeader(
         XMLUtils.ElementCreator creator,
@@ -687,12 +606,6 @@
 
     /**
      * Create the fis select box.
-     *
-     * @param artCreator
-     * @param creator
-     * @param document
-     * @param context
-     * @return
      */
     protected Element createSelectBox(
         XMLUtils.ElementCreator artCreator,
@@ -743,10 +656,6 @@
     /**
      * Insert all reachable states into the describe document returned by
      * {@link #describe(org.w3c.dom.Document, de.intevation.artifacts.CallContext)}
-     *
-     * @param creator
-     * @param parent
-     * @param document
      */
     protected void createReachableStates(
         XMLUtils.ElementCreator creator,
@@ -784,10 +693,6 @@
      * Insert states which have been visited by this artifact into the xml
      * document returned by {@link #describe(org.w3c.dom.Document,
      * de.intevation.artifacts.CallContext)}
-     *
-     * @param creator
-     * @param parent
-     * @param state
      */
     protected void appendOldReachableStates(
         XMLUtils.ElementCreator creator,
@@ -811,9 +716,6 @@
     /**
      * Insert the current state into the xml document returned by
      * {@link #describe(org.w3c.dom.Document, de.intevation.artifacts.CallContext)}
-     * @param creator
-     * @param parent
-     * @param document
      */
     protected void createCurrentState(
         XMLUtils.ElementCreator creator,
@@ -826,12 +728,7 @@
         parent.appendChild(stateNode);
     }
 
-    /**
-     *
-     * @param creator
-     * @param parent
-     * @param document
-     */
+
     protected void createModel(
         XMLUtils.ElementCreator creator,
         Element                 parent,
@@ -1022,8 +919,6 @@
      * @param context CallContext
      * @throws IOException If an error occured while writing the result to the
      * output stream.
-     * @see de.intevation.artifactdatabase.DefaultArtifact#out(org.w3c.dom.Document,
-     *      java.io.OutputStream, de.intevation.artifacts.CallContext)
      */
     @Override
     public void out(Document format, OutputStream outputStream,
@@ -1043,11 +938,7 @@
         }
     }
 
-    /**
-     *
-     * @param document
-     * @return
-     */
+
     protected static String readOutputType(Document document) {
         String value = XMLUtils.xpathString(
             document, XPATH_OUTPUT_NAME, ArtifactNamespaceContext.INSTANCE);
@@ -1065,7 +956,6 @@
 
     /**
      * Call endOfLife of parent class and the current state.
-     * @param globalContext
      */
     @Override
     public void endOfLife(Object globalContext) {
@@ -1079,8 +969,6 @@
     /**
      * Retrieves a map with given InputData which have been inserted into the
      * current artifact before the parameterization began.
-     * @return
-     * @see de.intevation.gnv.artifacts.PreSettingArtifact#getPreSettings()
      */
     public Map<String, InputData> getPreSettings() {
         return this.preSettings;
@@ -1088,8 +976,6 @@
 
     /**
      * Set InputData which are used in later states.
-     * @param preSettings
-     * @see de.intevation.gnv.artifacts.PreSettingArtifact#setPreSettings(java.util.Map)
      */
     public void setPreSettings(Map<String, InputData> preSettings) {
         this.preSettings = preSettings;