dive4elements/gnv-client: gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/GNVArtifactBase.java comparison

comparison gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/GNVArtifactBase.java @ 789:0dc115cbef0d

Added javadoc for artifact package. gnv-artifacts/trunk@871 c6561f87-3c4e-4783-a992-168aeb5c3f6f

author	Ingo Weinzierl <ingo.weinzierl@intevation.de>
date	Wed, 31 Mar 2010 09:09:05 +0000
parents	c4156275c1e1
children	feae2f9d6c6f

comparison

equal deleted inserted replaced

-:e8a9e84a0328
+:0dc115cbef0d
 import org.w3c.dom.Element;
 import org.w3c.dom.Node;
 import org.w3c.dom.NodeList;
 /**
+* This is the major gnv artifact and handles the requests specified in
+* {@link de.intevation.artifactdatabase.Artifact}.
+*
 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
 * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
 * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a>
 */
 public abstract class GNVArtifactBase extends GNVDefaultArtifact
 */
 public static final String XPATH_ARTIFACT_CONFIGURATION = "/artifact-database/artifacts/artifact[@name='"
 + 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";
 /**
 * The current State
 */
 public GNVArtifactBase() {
 super();
 }
+/**
+* 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) {
 log.debug("GNVArtifactBase.advance()");
 Document result      = XMLUtils.newDocument();
 return true;
 }
+/**
+*
+* @param document
+* @param nodeName
+* @param state
+* @param msg
+* @return
+*/
 protected Document createReport(
 Document document,
 String   nodeName,
 String   state,
 String   msg
 return document;
 }
+/**
+* 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) {
 return null;
 }
 }
 }
 return false;
 }
-public Document initialize (CallContext context) {
+/**
+*
+* @param context
+* @return
+*/
+public Document initialize(CallContext context) {
 Document result = XMLUtils.newDocument();
 try {
 this.current.initialize(super.identifier, context);
 if (this.current instanceof AutoResumeState){
 .getLocalizedMessage(), XMLUtils.newDocument());
 }
 return result;
 }
+/**
+* Step forward to the next reachable state.
+* @param current Current state.
+* @return Reachable state.
+*/
 protected State getNextReachableState(State current){
 Iterator<Transition> it = this.transitions.iterator();
 String from = current.getID();
 while (it.hasNext()){
 Transition transition = it.next();
 }
 }
 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(
 XPATH_IDENTIFIER_REPLACE, this.name);
 return configurationNode;
 }
 /**
+* Insert new data included in <code>target</code> into the current state.
+* @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) {
 return result;
 }
 /**
+* 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) {
 log.debug("GNVArtifactBase.describe");
 return document;
 }
 /**
+* 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,
 Object context,Document data) {
 }
 }
+/**
+* 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,
 String      uuid,
 boolean     incudeUI
 ) {
 }
 return document;
 }
+/**
+* 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.
+*/
 protected boolean getIncludeUIFromDocument(Document document){
 String value = XMLUtils.xpathString(
 document, XPATH_INCLUDE_UI, ArtifactNamespaceContext.INSTANCE);
 boolean includeUI = false;
 includeUI = Boolean.parseBoolean(value);
 }
 return includeUI;
 }
+/**
+*
+* @param creator
+* @param document
+* @return
+*/
 protected Element createRootNode(
 XMLUtils.ElementCreator creator,
 Document                document
 ) {
 Element rootNode = creator.create("result");
 document.appendChild(rootNode);
 return rootNode;
 }
+/**
+* Append information about the current artifact (uuid, hash).
+*
+* @param creator
+* @param parent
+* @param document
+* @param documentType
+*/
 protected void createHeader(
 XMLUtils.ElementCreator creator,
 Element                 parent,
 Document                document,
 String                  documentType
 Element hashNode = creator.create("hash");
 creator.addAttr(hashNode, "value", this.hash());
 parent.appendChild(hashNode);
 }
+/**
+* Create the fis select box.
+*
+* @param artCreator
+* @param creator
+* @param document
+* @param context
+* @return
+*/
 protected Element createSelectBox(
 XMLUtils.ElementCreator artCreator,
 XMLUtils.ElementCreator creator,
 Document                document,
 CallContext             context
 return selectNode;
 }
+/**
+* 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,
 Element                 parent,
 Document                document
 ) {
 }
 parent.appendChild(stateNode);
 }
+/**
+* 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,
 Element                 parent,
 State                   state
 ) {
 state = state.getParent();
 }
 }
+/**
+* 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,
 Element                 parent,
 Document                document
 ) {
 creator.addAttr(stateNode, "name", this.current.getID());
 creator.addAttr(stateNode, "description", this.current.getDescription());
 parent.appendChild(stateNode);
 }
+/**
+*
+* @param creator
+* @param parent
+* @param document
+*/
 protected void createModel(
 XMLUtils.ElementCreator creator,
 Element                 parent,
 Document                document
 ) {
 }
 }
 parent.appendChild(modelNode);
 }
+/**
+* Append the user interface description to the document returned by
+* {@link #describe(org.w3c.dom.Document, de.intevation.artifacts.CallContext)}
+* @param creator XML element creator.
+* @param parent New elements are appended to this node.
+* @param document Current document.
+* @param context CallContext
+* @param uuid The uuid of the artifact.
+*/
 protected void createUserInterface(
 XMLUtils.ElementCreator creator,
 Element                 parent,
 Document                document,
 CallContext             context,
 );
 }
 }
+/**
+* Append possible output targets to the document returned by
+* {@link #describe(org.w3c.dom.Document, de.intevation.artifacts.CallContext)}
+* @param creator Used to create xml elements.
+* @param parent New elements are appended to this node.
+* @param document The current document.
+*/
 protected void createOutputs(
 XMLUtils.ElementCreator creator,
 Element                 parent,
 Document                document
 ) {
 }
 }
 parent.appendChild(outputsNode);
 }
+/**
+* Parse input data from feed-document.
+* @param document Feed-document
+* @param xPath Path to input data.
+* @return A collection with InputData objects.
+*/
 protected Collection<InputData> parseInputData(Document document,
 String xPath) {
 HashMap<String, InputData> returnValue = null;
 NodeList inputElemets = (NodeList) XMLUtils.xpath(document, xPath,
 }
 return returnValue.values();
 }
 /**
+* Call an output target (e.g. chart, wms, etc.)
+* @param format XML document which contains some further information about
+* the desired output.
+* @param outputStream Stream used for writing the output.
+* @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,
 log.error(e, e);
 throw new IOException(e.getMessage());
 }
 }
+/**
+*
+* @param document
+* @return
+*/
 protected static String readOutputType(Document document) {
 String value = XMLUtils.xpathString(
 document, XPATH_OUTPUT_NAME, ArtifactNamespaceContext.INSTANCE);
 return value;
 }
+/**
+* The the current product.
+* @param product New product.
+*/
 public void setProduct(Product product) {
 this.product = product;
 }
+/**
+* Call endOfLife of parent class and the current state.
+* @param globalContext
+*/
+@Override
 public void endOfLife(Object globalContext) {
 super.endOfLife(globalContext);
 if (current != null) {
 current.endOfLife(globalContext);
 }
 }
 /**
+* 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;
 }
 /**
+* 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;
 if (this.current != null){
 this.current.setPreSettings(preSettings);
 }
 }
 }
-// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8:
+// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :

Mercurial > dive4elements > gnv-client

comparison gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/GNVArtifactBase.java @ 789:0dc115cbef0d