dive4elements/river: flys-artifacts/src/main/java/de/intevation/flys/collections/CollectionDescriptionHelper.java annotate

annotate flys-artifacts/src/main/java/de/intevation/flys/collections/CollectionDescriptionHelper.java @ 4483:cc6323401643

Cosmetics: Removed some WSP, obsolete imports. Documentation added.

author	Felix Wolfsteller <felix.wolfsteller@intevation.de>
date	Tue, 13 Nov 2012 16:52:01 +0100
parents	a5f65e8983be
children

rev	line source
1972 3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	1 package de.intevation.flys.collections;
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	2
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	3 import java.util.ArrayList;
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	4 import java.util.Date;
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	5 import java.util.List;
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	6
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	7 import javax.xml.xpath.XPathConstants;
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	8
3785 a5f65e8983be Merged revisions 5501-5502,5504-5508,5511-5513,5516-5519 via svnmerge from Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 3087 diff changeset	9 import org.apache.log4j.Logger;
1972 3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	10 import org.w3c.dom.Document;
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	11 import org.w3c.dom.Element;
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	12 import org.w3c.dom.Node;
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	13 import org.w3c.dom.NodeList;
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	14
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	15 import de.intevation.artifacts.ArtifactDatabase;
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	16 import de.intevation.artifacts.ArtifactDatabaseException;
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	17 import de.intevation.artifacts.ArtifactNamespaceContext;
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	18 import de.intevation.artifacts.CallContext;
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	19 import de.intevation.artifacts.common.utils.XMLUtils;
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	20 import de.intevation.artifacts.common.utils.XMLUtils.ElementCreator;
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	21
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	22
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	23 public class CollectionDescriptionHelper {
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	24
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	25 private static final Logger logger =
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	26 Logger.getLogger(CollectionDescriptionHelper.class);
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	27
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	28
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	29 public static final String XPATH_ARTIFACT_STATE_DATA =
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	30 "/art:result/art:ui/art:static/art:state/art:data";
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	31
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	32 /** Constant XPath that points to the outputmodes of an artifact. */
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	33 public static final String XPATH_ARTIFACT_OUTPUTMODES =
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	34 "/art:result/art:outputmodes";
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	35
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	36
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	37 protected ElementCreator ec;
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	38
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	39 protected CallContext context;
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	40 protected ArtifactDatabase database;
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	41
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	42 protected String name;
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	43 protected String uuid;
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	44 protected Date creation;
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	45 protected long ttl;
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	46
1976 0b466bd4ab24 Introduced a CollectionAttribute class that stores the information provided by the Collection's attribute document. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1972 diff changeset	47 protected List<String> artifacts;
0b466bd4ab24 Introduced a CollectionAttribute class that stores the information provided by the Collection's attribute document. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1972 diff changeset	48 protected CollectionAttribute attribute;
1972 3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	49
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	50
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	51 /**
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	52 * @param name The name of the collection.
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	53 * @param uuid The uuid of the collection.
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	54 * @param creation The creation time of the collection.
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	55 * @param ttl The time to live of the collection.
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	56 */
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	57 public CollectionDescriptionHelper(
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	58 String name,
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	59 String uuid,
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	60 Date creation,
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	61 long ttl,
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	62 CallContext callContext
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	63 ) {
3785 a5f65e8983be Merged revisions 5501-5502,5504-5508,5511-5513,5516-5519 via svnmerge from Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 3087 diff changeset	64 this.name = name;
a5f65e8983be Merged revisions 5501-5502,5504-5508,5511-5513,5516-5519 via svnmerge from Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 3087 diff changeset	65 this.uuid = uuid;
a5f65e8983be Merged revisions 5501-5502,5504-5508,5511-5513,5516-5519 via svnmerge from Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 3087 diff changeset	66 this.creation = creation;
a5f65e8983be Merged revisions 5501-5502,5504-5508,5511-5513,5516-5519 via svnmerge from Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 3087 diff changeset	67 this.ttl = ttl;
a5f65e8983be Merged revisions 5501-5502,5504-5508,5511-5513,5516-5519 via svnmerge from Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 3087 diff changeset	68 this.context = callContext;
a5f65e8983be Merged revisions 5501-5502,5504-5508,5511-5513,5516-5519 via svnmerge from Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 3087 diff changeset	69 this.database = callContext.getDatabase();
a5f65e8983be Merged revisions 5501-5502,5504-5508,5511-5513,5516-5519 via svnmerge from Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 3087 diff changeset	70 this.artifacts = new ArrayList<String>();
1972 3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	71 }
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	72
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	73
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	74 public void addArtifact(String uuid) {
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	75 if (uuid != null && uuid.length() > 0) {
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	76 artifacts.add(uuid);
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	77 }
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	78 }
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	79
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	80
1976 0b466bd4ab24 Introduced a CollectionAttribute class that stores the information provided by the Collection's attribute document. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1972 diff changeset	81 public void setAttribute(CollectionAttribute attribute) {
1972 3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	82 if (attribute != null) {
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	83 this.attribute = attribute;
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	84 }
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	85 }
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	86
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	87
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	88 public Document toXML() {
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	89 Document doc = XMLUtils.newDocument();
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	90
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	91 ec = new ElementCreator(
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	92 doc,
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	93 ArtifactNamespaceContext.NAMESPACE_URI,
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	94 ArtifactNamespaceContext.NAMESPACE_PREFIX);
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	95
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	96 Element root = ec.create("artifact-collection");
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	97 doc.appendChild(root);
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	98
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	99 String creationTime = creation != null
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	100 ? Long.toString(creation.getTime())
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	101 : "";
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	102
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	103 ec.addAttr(root, "name", name, true);
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	104 ec.addAttr(root, "uuid", uuid, true);
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	105 ec.addAttr(root, "creation", creationTime, true);
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	106 ec.addAttr(root, "ttl", String.valueOf(ttl), true);
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	107
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	108 appendArtifacts(root);
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	109 appendAttribute(root);
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	110
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	111 return doc;
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	112 }
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	113
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	114
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	115 /**
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	116 * Appends parts of the DESCRIBE document of each Artifact to <i>root</i>.
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	117 *
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	118 * @param root The root node.
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	119 */
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	120 protected void appendArtifacts(Element root) {
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	121 Element artifactsEl = ec.create("artifacts");
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	122
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	123 for (String uuid: artifacts) {
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	124 try {
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	125 Element e = buildArtifactNode(uuid);
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	126
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	127 if (e != null) {
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	128 artifactsEl.appendChild(e);
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	129 }
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	130 }
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	131 catch (ArtifactDatabaseException dbe) {
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	132 logger.warn(dbe, dbe);
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	133 }
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	134 }
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	135
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	136 root.appendChild(artifactsEl);
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	137 }
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	138
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	139
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	140 /**
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	141 * Create the Artifacts Node that contains outputmode and statedata.
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	142 *
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	143 * @param uuid uuid of the artifact.
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	144 */
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	145 protected Element buildArtifactNode(String uuid)
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	146 throws ArtifactDatabaseException
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	147 {
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	148 logger.debug("Append artifact '" + uuid + "' to collection description");
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	149
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	150 // TODO
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	151 String hash = "MYHASH";
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	152
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	153 Element ci = ec.create("artifact");
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	154 ec.addAttr(ci, "uuid", uuid, true);
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	155 ec.addAttr(ci, "hash", hash, true);
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	156
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	157 // XXX I am not sure if it works well every time with an empty document
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	158 // in the describe operation of an artifact.
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	159 Document description = database.describe(uuid, null, context.getMeta());
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	160
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	161 // Add outputmode element(s).
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	162 Node outputModes = (Node) XMLUtils.xpath(
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	163 description,
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	164 XPATH_ARTIFACT_OUTPUTMODES,
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	165 XPathConstants.NODE,
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	166 ArtifactNamespaceContext.INSTANCE);
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	167
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	168 if (outputModes != null) {
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	169 Document doc = ci.getOwnerDocument();
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	170 ci.appendChild(doc.importNode(outputModes, true));
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	171 }
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	172
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	173 // Add state-data element(s).
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	174 Node dataNode = ci.appendChild(
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	175 ci.getOwnerDocument().createElement("art:data-items"));
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	176
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	177 NodeList dataNodes = (NodeList) XMLUtils.xpath(
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	178 description,
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	179 XPATH_ARTIFACT_STATE_DATA,
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	180 XPathConstants.NODESET,
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	181 ArtifactNamespaceContext.INSTANCE);
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	182
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	183 if (dataNodes != null) {
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	184 Document doc = ci.getOwnerDocument();
3087 4a76da133144 Removed repeated x.size() calls from for loops. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 3083 diff changeset	185 for (int i = 0, D = dataNodes.getLength(); i < D; i++) {
1972 3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	186 dataNode.appendChild(doc.importNode(dataNodes.item(i), true));
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	187 }
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	188 }
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	189
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	190 return ci;
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	191 }
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	192
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	193
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	194 protected void appendAttribute(Element root) {
3785 a5f65e8983be Merged revisions 5501-5502,5504-5508,5511-5513,5516-5519 via svnmerge from Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 3087 diff changeset	195 if (attribute != null) {
a5f65e8983be Merged revisions 5501-5502,5504-5508,5511-5513,5516-5519 via svnmerge from Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 3087 diff changeset	196 Document owner = root.getOwnerDocument();
a5f65e8983be Merged revisions 5501-5502,5504-5508,5511-5513,5516-5519 via svnmerge from Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 3087 diff changeset	197 Document attr = attribute.toXML();
1972 3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	198
3785 a5f65e8983be Merged revisions 5501-5502,5504-5508,5511-5513,5516-5519 via svnmerge from Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 3087 diff changeset	199 root.appendChild(owner.importNode(attr.getFirstChild(), true));
a5f65e8983be Merged revisions 5501-5502,5504-5508,5511-5513,5516-5519 via svnmerge from Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 3087 diff changeset	200 }
1972 3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	201 }
3c3e81fca092 Added a CollectionDescriptionHelper that helps generating DESCRIBE documents for Collections. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	202 }
3083 4bd3d8bbb60c Added missing vim lines. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 1976 diff changeset	203 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :

Mercurial > dive4elements > river

annotate flys-artifacts/src/main/java/de/intevation/flys/collections/CollectionDescriptionHelper.java @ 4483:cc6323401643