ingo@105: package de.intevation.flys.artifacts;
ingo@105: 
ingo@109: import java.util.List;
ingo@124: import java.util.Set;
ingo@124: 
ingo@124: import javax.xml.xpath.XPathConstants;
ingo@109: 
ingo@105: import org.w3c.dom.Document;
ingo@110: import org.w3c.dom.Element;
ingo@124: import org.w3c.dom.Node;
ingo@105: 
ingo@105: import org.apache.log4j.Logger;
ingo@105: 
ingo@110: import de.intevation.artifacts.ArtifactNamespaceContext;
ingo@105: import de.intevation.artifacts.CallContext;
ingo@105: 
ingo@110: import de.intevation.artifactdatabase.ProtocolUtils;
ingo@124: import de.intevation.artifactdatabase.data.StateData;
ingo@110: import de.intevation.artifactdatabase.state.State;
ingo@110: import de.intevation.artifactdatabase.state.StateEngine;
ingo@112: import de.intevation.artifactdatabase.transition.TransitionEngine;
ingo@110: 
ingo@109: import de.intevation.artifacts.common.utils.XMLUtils;
ingo@109: 
ingo@109: import de.intevation.flys.artifacts.context.FLYSContext;
ingo@105: 
ingo@105: 
ingo@105: /**
ingo@105:  * The default WINFO artifact.
ingo@105:  *
ingo@105:  * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
ingo@105:  */
ingo@119: public class WINFOArtifact extends FLYSArtifact {
ingo@105: 
ingo@105:     /** The logger for this class */
ingo@105:     private static Logger logger = Logger.getLogger(WINFOArtifact.class);
ingo@105: 
ingo@105: 
ingo@121:     /** The name of the artifact.*/
ingo@121:     public static final String ARTIFACT_NAME = "winfo";
ingo@121: 
ingo@124:     /** XPath */
ingo@124:     public static final String XPATH_STATIC_UI ="/art:result/art:ui/art:static";
ingo@124: 
ingo@121: 
ingo@105:     /**
ingo@105:      * The default constructor.
ingo@105:      */
ingo@105:     public WINFOArtifact() {
ingo@105:     }
ingo@105: 
ingo@105: 
ingo@105:     /**
ingo@105:      * This method returns a description of this artifact.
ingo@105:      *
ingo@105:      * @param data Some data.
ingo@105:      * @param CallContext The CallContext.
ingo@105:      *
ingo@105:      * @return the description of this artifact.
ingo@105:      */
ingo@105:     public Document describe(Document data, CallContext context) {
ingo@119:         logger.debug("Describe: the current state is: " + getCurrentStateId());
ingo@105: 
ingo@112:         FLYSContext flysContext = null;
ingo@112:         if (context instanceof FLYSContext) {
ingo@112:             flysContext = (FLYSContext) context;
ingo@112:         }
ingo@112:         else {
ingo@112:             flysContext = (FLYSContext) context.globalContext();
ingo@112:         }
ingo@110: 
ingo@112:         StateEngine stateEngine = (StateEngine) flysContext.get(
ingo@112:             FLYSContext.STATE_ENGINE_KEY);
ingo@112: 
ingo@112:         TransitionEngine transitionEngine = (TransitionEngine) flysContext.get(
ingo@112:             FLYSContext.TRANSITION_ENGINE_KEY);
ingo@112: 
ingo@112:         List<State> reachable = transitionEngine.getReachableStates(
ingo@119:             getCurrentState(context), stateEngine);
ingo@112: 
ingo@112:         Document description            = XMLUtils.newDocument();
ingo@110:         XMLUtils.ElementCreator creator = new XMLUtils.ElementCreator(
ingo@110:             description,
ingo@110:             ArtifactNamespaceContext.NAMESPACE_URI,
ingo@110:             ArtifactNamespaceContext.NAMESPACE_PREFIX);
ingo@110: 
ingo@110:         Element root = ProtocolUtils.createRootNode(creator);
ingo@115:         description.appendChild(root);
ingo@115: 
ingo@119:         State current = getCurrentState(context);
ingo@119: 
ingo@110:         ProtocolUtils.appendDescribeHeader(creator, root, identifier(), hash());
ingo@119:         ProtocolUtils.appendState(creator, root, current);
ingo@112:         ProtocolUtils.appendReachableStates(creator, root, reachable);
ingo@110: 
ingo@127:         Element ui = ProtocolUtils.createArtNode(
ingo@127:             creator, "ui", null, null);
ingo@110: 
ingo@127:         Element staticUI  = ProtocolUtils.createArtNode(
ingo@127:             creator, "static", null, null);
ingo@127: 
ingo@127:         Element dynamic = current.describe(
ingo@124:             description,
ingo@127:             root,
ingo@127:             context,
ingo@127:             identifier());
ingo@127: 
ingo@127:         ui.appendChild(dynamic);
ingo@127:         root.appendChild(ui);
ingo@124: 
ingo@124:         appendStaticUI(creator, ui);
ingo@124: 
ingo@110:         return description;
ingo@105:     }
ingo@121: 
ingo@121: 
ingo@121:     /**
ingo@121:      * Returns the name of the concrete artifact.
ingo@121:      *
ingo@121:      * @return the name of the concrete artifact.
ingo@121:      */
ingo@121:     public String getName() {
ingo@121:         return ARTIFACT_NAME;
ingo@121:     }
ingo@124: 
ingo@124: 
ingo@124:     /**
ingo@124:      * This method appends the static data - that has already been inserted by
ingo@124:      * the user - to the static node of the DESCRIBE document.
ingo@124:      *
ingo@124:      * @param cr The ElementCreator that is used to create new elements.
ingo@124:      * @param ui The static ui node.
ingo@124:      */
ingo@124:     protected void appendStaticUI(XMLUtils.ElementCreator cr, Node ui) {
ingo@124:         Set<String> keys = data.keySet();
ingo@124: 
ingo@124:         // XXX This just handles single selection string values. If we need more
ingo@124:         // complex (maybe multiselect) objects we should introduce a data
ingo@124:         // structure for this - this structure should have a method that returns
ingo@124:         // a <data> node that contains its items.
ingo@124:         for (String k: keys) {
ingo@124:             logger.debug("The key = " + k);
ingo@124:             StateData d = getData(k);
ingo@124: 
ingo@124:             Element dataElement = cr.create("data");
ingo@124:             cr.addAttr(dataElement, "name", (String) d.getName(), true);
ingo@124:             cr.addAttr(dataElement, "type", d.getType(), true);
ingo@124: 
ingo@124:             Element itemElement = cr.create("item");
ingo@124:             cr.addAttr(itemElement, "value", (String) d.getValue(), true);
ingo@124:             // TODO Description (human readable) is missing
ingo@124: 
ingo@124:             dataElement.appendChild(itemElement);
ingo@124:             ui.appendChild(dataElement);
ingo@124:         }
ingo@124:     }
ingo@105: }
ingo@105: // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :