diff artifact-database/src/main/java/de/intevation/artifactdatabase/DefaultServiceFactory.java @ 89:d348fe1fd822

More javadoc (fixes small glitches, too). artifacts/trunk@845 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Sascha L. Teichmann <sascha.teichmann@intevation.de>
date Fri, 26 Mar 2010 16:16:32 +0000
parents 48d1a9a082c2
children 68285f7bc476
line wrap: on
line diff
--- a/artifact-database/src/main/java/de/intevation/artifactdatabase/DefaultServiceFactory.java	Fri Mar 26 15:05:11 2010 +0000
+++ b/artifact-database/src/main/java/de/intevation/artifactdatabase/DefaultServiceFactory.java	Fri Mar 26 16:16:32 2010 +0000
@@ -9,6 +9,12 @@
 import org.apache.log4j.Logger;
 
 /**
+ * Trivial implementation of the ServiceFactory interface.
+ * Name and an description are configured by the given Node given to
+ * #setup(Document, Node) via the 'name' and 'description' attributes.
+ * The name of the class that provides the concrete serice is configured
+ * by the 'service' attribute.
+ * 
  * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a>
  */
 public class DefaultServiceFactory
@@ -17,22 +23,50 @@
     private static Logger logger =
         Logger.getLogger(DefaultServiceFactory.class);
 
+    /**
+     * XPath to access the name of the service.
+     */
     public static final String XPATH_NAME        = "@name";
+    /**
+     * XPath to access the description of the service.
+     */
     public static final String XPATH_DESCRIPTION = "@description";
+    /**
+     * XPath to access the class name of the service to be build by
+     * this factory.
+     */
     public static final String XPATH_SERVICE     = "@service";
 
+    /**
+     * Default description if no description is given in configuration.
+     */
     public static final String DEFAULT_DESCRIPTION =
         "No description available";
 
+    /**
+     * Loaded service class if no class name is given in the configuration.
+     */
     public static final String DEFAULT_SERVICE =
         "de.intevation.artifactdatabase.DefaultService";
 
+    /**
+     * The name of the service factory.
+     */
     protected String name;
 
+    /**
+     * The description of the service factory.
+     */
     protected String description;
 
+    /**
+     * The loaded class used to build the concrete service.
+     */
     protected Class  serviceClass;
 
+    /**
+     * Default constructor.
+     */
     public DefaultServiceFactory() {
     }
 

http://dive4elements.wald.intevation.org