dive4elements/framework: artifacts/src/main/java/de/intevation/artifacts/ArtifactFactory.java annotate

annotate artifacts/src/main/java/de/intevation/artifacts/ArtifactFactory.java @ 10:e8626caac353

* Made Artifact life cycle symmetric: setup/endOfLife. * Implement defaults for Artifact and ArtifactFactory. * Added connection pooling from apache commons dbcp * Made sql schema of artifact database more compatible. * Improve example config. * Made artifactdb start with 'mvn exec:exec' * minor fixes. artifacts/trunk@25 c6561f87-3c4e-4783-a992-168aeb5c3f6f

author	Sascha L. Teichmann <sascha.teichmann@intevation.de>
date	Sun, 06 Sep 2009 12:00:56 +0000
parents	f95d9a449215
children	251e8904d6c2

rev	line source
1 11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	1 package de.intevation.artifacts;
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	2
4 13a12b607baf Added mechanism to create an share a global context in the artifact database. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 1 diff changeset	3 import org.w3c.dom.Document;
7 f95d9a449215 Insert new Parameter to Setuproutine Tim Englich <tim.englich@intevation.de> parents: 4 diff changeset	4 import org.w3c.dom.Node;
4 13a12b607baf Added mechanism to create an share a global context in the artifact database. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 1 diff changeset	5
1 11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	6 /**
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	7 * Interface of an artifact producing factory.
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	8 *
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	9 * @author Sascha L. Teichmann (sascha.teichmann@intevation.de)
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	10 */
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	11 public interface ArtifactFactory
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	12 {
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	13 /**
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	14 * The short name of this factory.
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	15 * @return the name of this factory.
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	16 */
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	17 String getName();
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	18
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	19 /**
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	20 * Description of this factory.
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	21 * @return description of the factory.
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	22 */
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	23 String getDescription();
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	24
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	25 /**
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	26 * Create a new artifact of certain type, given a general purpose context and
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	27 * an identifier.
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	28 * @param context a context from the ArtifactDatabase.
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	29 * @param identifier unique identifer for the new artifact
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	30 * @return a new {@linkplain de.intevation.artifacts.Artifact Artifact}
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	31 */
4 13a12b607baf Added mechanism to create an share a global context in the artifact database. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 1 diff changeset	32 Artifact createArtifact(String identifier, Object context);
13a12b607baf Added mechanism to create an share a global context in the artifact database. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 1 diff changeset	33
13a12b607baf Added mechanism to create an share a global context in the artifact database. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 1 diff changeset	34 /**
13a12b607baf Added mechanism to create an share a global context in the artifact database. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 1 diff changeset	35 * Setup the factory with a given configuration
13a12b607baf Added mechanism to create an share a global context in the artifact database. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 1 diff changeset	36 * @param config the configuration
7 f95d9a449215 Insert new Parameter to Setuproutine Tim Englich <tim.englich@intevation.de> parents: 4 diff changeset	37 * @param factoryNode the ConfigurationNode of this Factory
4 13a12b607baf Added mechanism to create an share a global context in the artifact database. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 1 diff changeset	38 */
7 f95d9a449215 Insert new Parameter to Setuproutine Tim Englich <tim.englich@intevation.de> parents: 4 diff changeset	39 void setup(Document config, Node factoryNode);
10 e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 7 diff changeset	40
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 7 diff changeset	41 /**
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 7 diff changeset	42 * Tells how long an artifact should survive if it is
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 7 diff changeset	43 * not touched. This is put in the factory because
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 7 diff changeset	44 * life time is nothing a artifact should handle it self.
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 7 diff changeset	45 * This method is only called once directly after the
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 7 diff changeset	46 * artifact is created.
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 7 diff changeset	47 * @param artifact The artifact to be rated.
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 7 diff changeset	48 * @param context The global context.
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 7 diff changeset	49 * return time to live in ms. null means eternal.
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 7 diff changeset	50 */
e8626caac353 * Made Artifact life cycle symmetric: setup/endOfLife. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 7 diff changeset	51 Long timeToLiveUntouched(Artifact artifact, Object context);
1 11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	52 }
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	53 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8:

Mercurial > dive4elements > framework

annotate artifacts/src/main/java/de/intevation/artifacts/ArtifactFactory.java @ 10:e8626caac353