dive4elements/river: flys-artifacts/src/main/java/de/intevation/flys/artifacts/FLYSArtifact.java comparison

comparison flys-artifacts/src/main/java/de/intevation/flys/artifacts/FLYSArtifact.java @ 121:e0ded17a4846

Implemented the feed() operation. flys-artifacts/trunk@1442 c6561f87-3c4e-4783-a992-168aeb5c3f6f

author	Ingo Weinzierl <ingo.weinzierl@intevation.de>
date	Wed, 09 Mar 2011 14:13:57 +0000
parents	84c0b151203e
children	d3b8b0b1d010

comparison

equal deleted inserted replaced

-:5243ac559e16
+:e0ded17a4846
 package de.intevation.flys.artifacts;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
+import javax.xml.xpath.XPathConstants;
 import org.apache.log4j.Logger;
 import org.w3c.dom.Document;
+import org.w3c.dom.Element;
+import org.w3c.dom.Node;
+import org.w3c.dom.NodeList;
 import de.intevation.artifacts.ArtifactFactory;
 import de.intevation.artifacts.CallContext;
 import de.intevation.artifacts.common.ArtifactNamespaceContext;
 import de.intevation.artifacts.common.utils.XMLUtils;
 import de.intevation.artifactdatabase.DefaultArtifact;
+import de.intevation.artifactdatabase.data.DefaultStateData;
 import de.intevation.artifactdatabase.data.StateData;
 import de.intevation.artifactdatabase.state.State;
 import de.intevation.artifactdatabase.state.StateEngine;
 import de.intevation.flys.artifacts.context.FLYSContext;
 /** The logger that is used in this artifact.*/
 private static Logger logger = Logger.getLogger(FLYSArtifact.class);
-/** The XPath to the name of the artifact in its configuration. */
+/** The XPath that points to the input data elements of the FEED document.*/
-public static final String XPATH_ARTIFACT_NAME = "@name";
+public static final String XPATH_FEED_INPUT =
+"/art:action/art:data/art:input";
 /** The identifier of the current state. */
 protected String currentStateId;
 /** The name of the artifact.*/
 protected String name;
+/** The data that have been inserted into this artifact.*/
+protected Map<String, StateData> data;
+/**
+* The default constructor that creates an empty FLYSArtifact.
+*/
+public FLYSArtifact() {
+data = new HashMap<String, StateData>();
+}
+/**
+* Returns the name of the concrete artifact.
+*
+* @return the name of the concrete artifact.
+*/
+public abstract String getName();
+/**
+* Returns the FLYSContext from context object.
+*
+* @param context The CallContext or the FLYSContext.
+*
+* @return the FLYSContext.
+*/
+protected FLYSContext getFlysContext(Object context) {
+return context instanceof FLYSContext
+? (FLYSContext) context
+: (FLYSContext) ((CallContext) context).globalContext();
+}
 /**
 * Initialize the artifact and insert new data if <code>data</code> contains
 * information necessary for this artifact.
 {
 logger.debug("Setup this artifact with the uuid: " + identifier);
 super.setup(identifier, factory, context, data);
-String name = XMLUtils.xpathString(
-data, XPATH_ARTIFACT_NAME, ArtifactNamespaceContext.INSTANCE);
-setName(name);
 FLYSContext flysContext = (FLYSContext) context;
 StateEngine engine      = (StateEngine) flysContext.get(
 FLYSContext.STATE_ENGINE_KEY);
+String name = getName();
+logger.debug("Set initial state for artifact '" + name + "'");
 List<State> states = engine.getStates(name);
 setCurrentState(states.get(0));
 }
 *
 * @return a document that contains a SUCCESS or FAILURE message.
 */
 @Override
 public Document feed(Document target, CallContext context) {
-Document result = XMLUtils.newDocument();
+Document doc = XMLUtils.newDocument();
-// TODO IMPLEMENT ME
+XMLUtils.ElementCreator creator = new XMLUtils.ElementCreator(
+doc,
-return result;
+ArtifactNamespaceContext.NAMESPACE_URI,
-}
+ArtifactNamespaceContext.NAMESPACE_PREFIX);
+Element result = creator.create("result");
-/**
+doc.appendChild(result);
-* This method returns the name of the concrete artifact.
-*
+try {
-* @return the name of the concrete artifact.
+saveData(target, XPATH_FEED_INPUT);
-*/
+creator.addAttr(result, "type", "SUCCESS", true);
-public String getName() {
+}
-return name;
+catch (IllegalArgumentException iae) {
-}
+creator.addAttr(result, "type", "FAILURE", true);
+// TODO I18N this message - getMessage() returns a lookup string, no
+// human readable error message
-/**
+result.setTextContent(iae.getMessage());
-* This method sets the name of this artifact.
+}
-*
-* @param name the name for this artifact.
+return doc;
-*/
-protected void setName(String name) {
-this.name = name;
 }
 /**
 * Returns the identifier of the current state.
 * @param id the identifier of a state.
 */
 protected void setCurrentStateId(String id) {
 currentStateId = id;
 }
 /**
 * Set the current state of this artifact. <b>NOTE</b>We don't store the
 * State object itself - which is not necessary - but its identifier. So
 * Returns the current state of the artifact.
 *
 * @return the current State of the artifact.
 */
 protected State getCurrentState(Object context) {
-FLYSContext flysContext = (FLYSContext) context;
+FLYSContext flysContext = getFlysContext(context);
 StateEngine engine      = (StateEngine) flysContext.get(
 FLYSContext.STATE_ENGINE_KEY);
 return engine.getState(getCurrentStateId());
 }
 /**
-* This method extracts the data that is contained in the FEED document.
+* Adds a new StateData item to the data pool of this artifact.
+*
+* @param name the name of the data object.
+* @param data the data object itself.
+*/
+protected void addData(String name, StateData data) {
+this.data.put(name, data);
+}
+/**
+* This method stores the data that is contained in the FEED document.
 *
 * @param feed The FEED document.
 * @param xpath The XPath that points to the data nodes.
-*
+*/
-* @return a StateData array.
+public void saveData(Document feed, String xpath)
-*/
+throws IllegalArgumentException
-public StateData[] extractData(Document feed, String xpath) {
+{
+if (feed == null || xpath == null || xpath.length() == 0) {
-// TODO IMPLEMENT ME
+throw new IllegalArgumentException("feed.no.input.data");
-return null;
+}
+NodeList nodes = (NodeList) XMLUtils.xpath(
+feed,
+xpath,
+XPathConstants.NODESET,
+ArtifactNamespaceContext.INSTANCE);
+if (nodes == null || nodes.getLength() == 0) {
+throw new IllegalArgumentException("feed.no.input.data");
+}
+int count = nodes.getLength();
+logger.debug("Try to save " + count + " data items.");
+for (int i = 0; i < count; i++) {
+Node node = nodes.item(i);
+String name = XMLUtils.xpathString(
+node, "@art:name", ArtifactNamespaceContext.INSTANCE);
+String value = XMLUtils.xpathString(
+node, "@art:value", ArtifactNamespaceContext.INSTANCE);
+if (name != null && value != null) {
+logger.debug("Save data item for '" + name + "' : " + value);
+// TODO ADD INPUT VALIDATION!
+addData(name, new DefaultStateData(name, null, null, value));
+}
+}
 }
 }
 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :

Mercurial > dive4elements > river

comparison flys-artifacts/src/main/java/de/intevation/flys/artifacts/FLYSArtifact.java @ 121:e0ded17a4846