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

annotate artifact-database/src/main/java/de/intevation/artifactdatabase/DefaultArtifactContext.java @ 92:73d0ebae81d7

Last bunch of javadoc artifacts/trunk@848 c6561f87-3c4e-4783-a992-168aeb5c3f6f

author	Sascha L. Teichmann <sascha.teichmann@intevation.de>
date	Sun, 28 Mar 2010 14:16:05 +0000
parents	68285f7bc476
children	933bbc9fc11f

rev	line source
5 8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	1 package de.intevation.artifactdatabase;
8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	2
8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	3 import java.util.HashMap;
8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	4
8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	5 import org.w3c.dom.Document;
8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	6
8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	7 /**
8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	8 * Default implementation of the context.
8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	9 * Besides of the configuration it hosts a map to store key/value pairs.
8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	10 *
77 48d1a9a082c2 Bring @author javadoc tags in form '@author <a href="john.doe@example.com">John Doe</a>' Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 5 diff changeset	11 * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a>
5 8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	12 */
8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	13 public class DefaultArtifactContext
8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	14 {
90 68285f7bc476 More javadoc. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 77 diff changeset	15 /**
68285f7bc476 More javadoc. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 77 diff changeset	16 * The global configuration document of the artifact database.
68285f7bc476 More javadoc. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 77 diff changeset	17 */
5 8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	18 protected Document config;
8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	19
90 68285f7bc476 More javadoc. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 77 diff changeset	20 /**
68285f7bc476 More javadoc. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 77 diff changeset	21 * Custom key/value pairs to be used globally in the whole server.
68285f7bc476 More javadoc. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 77 diff changeset	22 */
5 8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	23 protected HashMap map;
8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	24
90 68285f7bc476 More javadoc. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 77 diff changeset	25 /**
68285f7bc476 More javadoc. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 77 diff changeset	26 * Default constructor
68285f7bc476 More javadoc. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 77 diff changeset	27 */
5 8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	28 public DefaultArtifactContext() {
8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	29 this(null);
8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	30 }
8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	31
90 68285f7bc476 More javadoc. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 77 diff changeset	32 /**
68285f7bc476 More javadoc. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 77 diff changeset	33 * Constructor to create a context with a given global
68285f7bc476 More javadoc. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 77 diff changeset	34 * configuration document and an empty map of custom
68285f7bc476 More javadoc. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 77 diff changeset	35 * key/value pairs.
68285f7bc476 More javadoc. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 77 diff changeset	36 * @param config
68285f7bc476 More javadoc. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 77 diff changeset	37 */
5 8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	38 public DefaultArtifactContext(Document config) {
8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	39 this.config = config;
8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	40 map = new HashMap();
8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	41 }
8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	42
90 68285f7bc476 More javadoc. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 77 diff changeset	43 /**
68285f7bc476 More javadoc. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 77 diff changeset	44 * Fetch a custom value from the global key/value map using
68285f7bc476 More javadoc. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 77 diff changeset	45 * a given key.
68285f7bc476 More javadoc. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 77 diff changeset	46 * @param key The key.
68285f7bc476 More javadoc. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 77 diff changeset	47 * @return The stored value or null if no value was found under
68285f7bc476 More javadoc. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 77 diff changeset	48 * this key.
68285f7bc476 More javadoc. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 77 diff changeset	49 */
5 8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	50 public synchronized Object get(Object key) {
8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	51 return map.get(key);
8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	52 }
8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	53
90 68285f7bc476 More javadoc. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 77 diff changeset	54 /**
68285f7bc476 More javadoc. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 77 diff changeset	55 * Store a custom key/value pair in the global map.
68285f7bc476 More javadoc. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 77 diff changeset	56 * @param key The key to store
68285f7bc476 More javadoc. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 77 diff changeset	57 * @param value The value to store
68285f7bc476 More javadoc. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 77 diff changeset	58 * @return The old value registered under the key or null
68285f7bc476 More javadoc. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 77 diff changeset	59 * if none wa there before.
68285f7bc476 More javadoc. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 77 diff changeset	60 */
5 8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	61 public synchronized Object put(Object key, Object value) {
8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	62 return map.put(key, value);
8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	63 }
8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	64
90 68285f7bc476 More javadoc. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 77 diff changeset	65 /**
68285f7bc476 More javadoc. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 77 diff changeset	66 * Returns a reference to the global configuration document.
68285f7bc476 More javadoc. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 77 diff changeset	67 * @return The global configuration document.
68285f7bc476 More javadoc. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 77 diff changeset	68 */
5 8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	69 public Document getConfig() {
8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	70 return config;
8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	71 }
8f2de197bce2 Added config to artifact database and modelled bootstap of artifact factories on top of this. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	72 }
90 68285f7bc476 More javadoc. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 77 diff changeset	73 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :

Mercurial > dive4elements > framework

annotate artifact-database/src/main/java/de/intevation/artifactdatabase/DefaultArtifactContext.java @ 92:73d0ebae81d7