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

annotate artifacts/src/main/java/de/intevation/artifacts/Artifact.java @ 2:141457e0d7b1

Created a new sub project for artifact database server. artifacts/trunk@9 c6561f87-3c4e-4783-a992-168aeb5c3f6f

author	Sascha L. Teichmann <sascha.teichmann@intevation.de>
date	Thu, 03 Sep 2009 13:59:35 +0000
parents	11c82d3f125e
children	13a12b607baf

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
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	3 import org.w3c.dom.Document;
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	4
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	5 import java.io.Serializable;
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 /**
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	8 * Interface of the core component of the artifact system: <strong>The artifact</strong>.
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	9 * <br>
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 * An artifact is an abstract data type offering the following methods:
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 * <ol>
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	14 * <li>{@link #identifier() identifier()}: Returns a gobally unique identfier
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	15 * of this artifact.</li>
2 141457e0d7b1 Created a new sub project for artifact database server. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 1 diff changeset	16 * <li>{@link #hash() hash()}: Returns a hash value over the internal state
1 11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	17 * of this artifact.</li>
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	18 * <li>{@link #describe()}: Returns a description of this artifact.</li>
2 141457e0d7b1 Created a new sub project for artifact database server. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 1 diff changeset	19 * <li>{@link #advance(String) advance()}: Advances this artifact
1 11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	20 * to the next internal state</li>
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	21 * <li>{@link #feed(Document) feed()}: Feed new data into this artifact.</li>
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	22 * <li>{@link #out(Document) out()}: Produces output for this artifact.</li>
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	23 * </ol>
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 * @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	26 */
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	27 public interface Artifact
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	28 extends Serializable
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	29 {
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	30 /**
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	31 * Identify this artifact.
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	32 * @return Returns unique string to identify this artifact globally.
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	33 */
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	34 public String identifier();
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	35
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	36 /**
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	37 * Internal hash of this artifact.
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	38 * @return Returns hash that should stay the same if the internal
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	39 * value has not changed. Useful for caching
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	40 */
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	41 public String hash();
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	42
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	43 /**
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	44 * A description used to build a interface to interact with this artifact.
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	45 * @return An XML representation of the current state of the artifact.
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	46 */
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	47 public Document describe();
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	48
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	49 /**
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	50 * Change the internal state of the artifact.
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	51 * @param target Target of internal state to move to.
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	52 * @return An XML representation of the success of the advancing.
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	53 */
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	54 public Document advance(String target);
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	55
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	56 /**
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	57 * Feed data into this artifact.
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	58 * @param data Data to feed artifact with.
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	59 * @return An XML representation of the success of the feeding.
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	60 */
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	61 public Document feed(Document data);
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	62
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	63 /**
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	64 * Produce output from this artifact.
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	65 * @param format Specifies the format of the output.
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	66 * @return a byte representation of the output.
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	67 */
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	68 public byte [] out(Document format);
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	69 }
11c82d3f125e Checked in the central interfaces of the artifact system. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: diff changeset	70 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8:

Mercurial > dive4elements > framework

annotate artifacts/src/main/java/de/intevation/artifacts/Artifact.java @ 2:141457e0d7b1