dive4elements/framework: artifact-database/src/main/java/de/intevation/artifactdatabase/state/AbstractState.java annotate

annotate artifact-database/src/main/java/de/intevation/artifactdatabase/state/AbstractState.java @ 210:b75fca1ac215

Enhanced the State interface to retrieve its output modes. artifacts/trunk@1541 c6561f87-3c4e-4783-a992-168aeb5c3f6f

author	Ingo Weinzierl <ingo.weinzierl@intevation.de>
date	Wed, 23 Mar 2011 10:45:36 +0000
parents	1a3fb29b8b2e
children	41404961c804

rev	line source
105 265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	1 /*
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	2 * Copyright (c) 2011 by Intevation GmbH
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	3 *
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	4 * This program is free software under the LGPL (>=v2.1)
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	5 * Read the file LGPL.txt coming with the software for details
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	6 * or visit http://www.gnu.org/licenses/ if it does not exist.
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	7 */
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	8 package de.intevation.artifactdatabase.state;
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	9
209 1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	10 import java.util.ArrayList;
105 265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	11 import java.util.HashMap;
209 1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	12 import java.util.List;
105 265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	13 import java.util.Map;
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	14
106 ece0fdb07975 Implementations to initialize and retrieve states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 105 diff changeset	15 import javax.xml.xpath.XPathConstants;
ece0fdb07975 Implementations to initialize and retrieve states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 105 diff changeset	16
105 265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	17 import org.w3c.dom.Document;
205 2a9591f76270 Changed the return type of a State's describe() method. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 106 diff changeset	18 import org.w3c.dom.Element;
105 265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	19 import org.w3c.dom.Node;
209 1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	20 import org.w3c.dom.NodeList;
105 265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	21
209 1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	22 import de.intevation.artifacts.ArtifactNamespaceContext;
105 265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	23 import de.intevation.artifacts.CallContext;
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	24
106 ece0fdb07975 Implementations to initialize and retrieve states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 105 diff changeset	25 import de.intevation.artifacts.common.utils.XMLUtils;
ece0fdb07975 Implementations to initialize and retrieve states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 105 diff changeset	26
105 265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	27 import de.intevation.artifactdatabase.data.StateData;
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	28
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	29
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	30 /**
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	31 * An abstract implementation of a {@link State}. It implements some basic
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	32 * methods that return the id, description and data. The methods
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	33 * <code>describe()</code> and <code>setup()</code> depend on the concrete class
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	34 * and need to be implemented by those.
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	35 */
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	36 public abstract class AbstractState implements State {
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	37
106 ece0fdb07975 Implementations to initialize and retrieve states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 105 diff changeset	38 /** The XPath to the ID of the state relative to the state node in the
ece0fdb07975 Implementations to initialize and retrieve states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 105 diff changeset	39 * configuration. */
ece0fdb07975 Implementations to initialize and retrieve states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 105 diff changeset	40 public static final String XPATH_ID = "@id";
ece0fdb07975 Implementations to initialize and retrieve states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 105 diff changeset	41
ece0fdb07975 Implementations to initialize and retrieve states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 105 diff changeset	42 /** The XPath to the description of the state relative to the state node in
ece0fdb07975 Implementations to initialize and retrieve states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 105 diff changeset	43 * the configuration. */
ece0fdb07975 Implementations to initialize and retrieve states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 105 diff changeset	44 public static final String XPATH_DESCRIPTION = "@description";
ece0fdb07975 Implementations to initialize and retrieve states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 105 diff changeset	45
209 1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	46 /** The XPath to the output nodes of the state configuration.*/
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	47 public static final String XPATH_OUTPUT_MODES = "outputmodes/outputmode";
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	48
106 ece0fdb07975 Implementations to initialize and retrieve states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 105 diff changeset	49
105 265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	50 /** The ID of the state. */
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	51 protected String id;
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	52
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	53 /** The description of the state. */
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	54 protected String description;
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	55
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	56 /** The data provided by this state. */
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	57 protected Map<String, StateData> data;
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	58
209 1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	59 /** A list of output modes which are available for this state.*/
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	60 protected List<Output> outputs;
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	61
105 265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	62
205 2a9591f76270 Changed the return type of a State's describe() method. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 106 diff changeset	63 public AbstractState() {
209 1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	64 outputs = new ArrayList<Output>();
205 2a9591f76270 Changed the return type of a State's describe() method. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 106 diff changeset	65 }
2a9591f76270 Changed the return type of a State's describe() method. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 106 diff changeset	66
2a9591f76270 Changed the return type of a State's describe() method. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 106 diff changeset	67
105 265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	68 /**
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	69 * The default constructor.
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	70 *
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	71 * @param id The ID of the state.
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	72 * @param description The description of the state.
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	73 */
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	74 public AbstractState(String id, String description) {
209 1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	75 super();
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	76
105 265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	77 this.id = id;
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	78 this.description = description;
209 1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	79
105 265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	80 }
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	81
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	82
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	83 /**
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	84 * Returns the ID of the state.
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	85 *
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	86 * @return the ID of the state.
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	87 */
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	88 public String getID() {
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	89 return id;
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	90 }
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	91
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	92
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	93 /**
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	94 * Set the ID of the state.
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	95 *
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	96 * @param id The ID of the state.
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	97 */
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	98 public void setID(String id) {
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	99 this.id = id;
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	100 }
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	101
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	102
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	103 /**
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	104 * Returns the description of the state.
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	105 *
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	106 * @return the description of the state.
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	107 */
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	108 public String getDescription() {
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	109 return description;
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	110 }
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	111
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	112
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	113 /**
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	114 * Set the description of the state.
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	115 *
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	116 * @param description The description of the state.
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	117 */
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	118 public void setDescription(String description) {
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	119 this.description = description;
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	120 }
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	121
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	122
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	123 /**
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	124 * Returns the data of the state.
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	125 *
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	126 * @return the data of the state.
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	127 */
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	128 public Map<String, StateData> getData() {
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	129 return data;
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	130 }
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	131
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	132
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	133 /**
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	134 * Add new data to the state. NOTE: If there is already an object existing
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	135 * with the key <i>name</i>, this object is overwritten by the new value.
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	136 *
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	137 * @param name The name of the data object.
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	138 * @param StateData The data object.
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	139 */
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	140 public void addData(String name, StateData data) {
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	141 if (this.data == null) {
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	142 this.data = new HashMap<String, StateData>();
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	143 }
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	144
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	145 this.data.put(name, data);
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	146 }
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	147
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	148
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	149 /**
209 1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	150 * Returns the list of possible outputs of this state. The list is empty
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	151 * if no output is available for this state.
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	152 *
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	153 * @return a list of possible outputs of this state.
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	154 */
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	155 public List<Output> getOutputs() {
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	156 return outputs;
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	157 }
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	158
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	159
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	160 /**
106 ece0fdb07975 Implementations to initialize and retrieve states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 105 diff changeset	161 * Initialize the state based on the state node in the configuration.
105 265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	162 *
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	163 * @param config The state configuration node.
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	164 */
106 ece0fdb07975 Implementations to initialize and retrieve states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 105 diff changeset	165 public void setup(Node config) {
ece0fdb07975 Implementations to initialize and retrieve states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 105 diff changeset	166 id = (String) XMLUtils.xpath(config, XPATH_ID, XPathConstants.STRING);
ece0fdb07975 Implementations to initialize and retrieve states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 105 diff changeset	167
ece0fdb07975 Implementations to initialize and retrieve states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 105 diff changeset	168 description = (String) XMLUtils.xpath(
ece0fdb07975 Implementations to initialize and retrieve states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 105 diff changeset	169 config, XPATH_DESCRIPTION, XPathConstants.STRING);
209 1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	170
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	171 setupOutputs(config);
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	172 }
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	173
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	174
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	175 /**
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	176 * This method tries reading the available output nodes configured in the
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	177 * state configuration and adds possible Outputs to the outputs list.
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	178 *
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	179 * @param config The state configuration node.
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	180 */
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	181 protected void setupOutputs(Node config) {
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	182 NodeList outs = (NodeList) XMLUtils.xpath(
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	183 config,
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	184 XPATH_OUTPUT_MODES,
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	185 XPathConstants.NODESET,
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	186 ArtifactNamespaceContext.INSTANCE);
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	187
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	188 if (outs == null \|\| outs.getLength() == 0) {
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	189 return;
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	190 }
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	191
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	192 int size = outs.getLength();
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	193
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	194 for (int i = 0; i < size; i++) {
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	195 outputs.add(buildOutput(outs.item(i)));
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	196 }
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	197 }
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	198
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	199
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	200 /**
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	201 * A helper method that creates an Output object based on the <i>out</i>
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	202 * node.
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	203 *
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	204 * @param out The output node configuration.
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	205 *
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	206 * @return an Output object.
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	207 */
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	208 protected Output buildOutput(Node out) {
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	209 String name = XMLUtils.xpathString(
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	210 out, "@name", ArtifactNamespaceContext.INSTANCE);
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	211
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	212 String desc = XMLUtils.xpathString(
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	213 out, "@description", ArtifactNamespaceContext.INSTANCE);
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	214
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	215 String mimetype = XMLUtils.xpathString(
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	216 out, "@mime-type", ArtifactNamespaceContext.INSTANCE);
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	217
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 205 diff changeset	218 return name != null ? new DefaultOutput(name, desc, mimetype) : null;
106 ece0fdb07975 Implementations to initialize and retrieve states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 105 diff changeset	219 }
105 265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	220
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	221
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	222 /**
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	223 * Describes the UI of the state. This method needs to be implemented by
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	224 * concrete subclasses.
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	225 *
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	226 * @param document Describe doucment.
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	227 * @param rootNode Parent node for all new elements.
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	228 * @param context The CallContext.
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	229 * @param uuid The uuid of an artifact.
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	230 */
205 2a9591f76270 Changed the return type of a State's describe() method. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 106 diff changeset	231 public abstract Element describe(
105 265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	232 Document document,
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	233 Node rootNode,
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	234 CallContext context,
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	235 String uuid
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	236 );
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	237 }
265f150f4f7f Added an abstract implementation of a State. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	238 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf-8 :

Mercurial > dive4elements > framework

annotate artifact-database/src/main/java/de/intevation/artifactdatabase/state/AbstractState.java @ 210:b75fca1ac215