Mercurial > dive4elements > framework
comparison artifacts/src/main/java/de/intevation/artifacts/Artifact.java @ 78:55eefe63a777
Repaired the javadoc stuff for almost all artifact interfaces.
artifacts/trunk@760 c6561f87-3c4e-4783-a992-168aeb5c3f6f
| author | Sascha L. Teichmann <sascha.teichmann@intevation.de> |
|---|---|
| date | Thu, 11 Mar 2010 10:53:59 +0000 |
| parents | 48d1a9a082c2 |
| children | e9c80fdfee13 |
comparison
equal
deleted
inserted
replaced
| 77:48d1a9a082c2 | 78:55eefe63a777 |
|---|---|
| 15 * <ol> | 15 * <ol> |
| 16 * <li>{@link #identifier() identifier()}: Returns a gobally unique identfier | 16 * <li>{@link #identifier() identifier()}: Returns a gobally unique identfier |
| 17 * of this artifact.</li> | 17 * of this artifact.</li> |
| 18 * <li>{@link #hash() hash()}: Returns a hash value over the internal state | 18 * <li>{@link #hash() hash()}: Returns a hash value over the internal state |
| 19 * of this artifact.</li> | 19 * of this artifact.</li> |
| 20 * <li>{@link #describe(Object)}: Returns a description of this artifact.</li> | 20 * <li>{@link #describe(Document, CallContext)}: Returns a description of this artifact.</li> |
| 21 * <li>{@link #advance(Document, Object) advance()}: Advances this artifact | 21 * <li>{@link #advance(Document, CallContext) advance()}: Advances this artifact |
| 22 * to the next internal state</li> | 22 * to the next internal state</li> |
| 23 * <li>{@link #feed(Document, Object) feed()}: Feed new data into this artifact.</li> | 23 * <li>{@link #feed(Document, CallContext) feed()}: Feed new data into this artifact.</li> |
| 24 * <li>{@link #out(Document, OutputStream, CallContext) out()}: Produces output for this artifact.</li> | 24 * <li>{@link #out(Document, OutputStream, CallContext) out()}: Produces output for this artifact.</li> |
| 25 * </ol> | 25 * </ol> |
| 26 * | 26 * |
| 27 * There are two more methods involved with the life cycle of the are: | 27 * There are two more methods involved with the life cycle of the are: |
| 28 * <ol> | 28 * <ol> |
| 29 * <li>{@link #setup(String, ArtifactFactory, Object) setup()}: Called after created by the | 29 * <li>{@link #setup(String, ArtifactFactory, Object, Document) setup()}: |
| 30 * factory.</li> | 30 * Called after created by the factory.</li> |
| 31 * <li>{@link #endOfLife(Object) endOfLife()}: Called when the artifact | 31 * <li>{@link #endOfLife(Object) endOfLife()}: Called when the artifact |
| 32 * is going to be removed from | 32 * is going to be removed from |
| 33 * system. Useful to clean up.</li> | 33 * system. Useful to clean up.</li> |
| 34 * </ol> | 34 * </ol> |
| 35 * | 35 * |
| 51 */ | 51 */ |
| 52 String hash(); | 52 String hash(); |
| 53 | 53 |
| 54 /** | 54 /** |
| 55 * A description used to build a interface to interact with this artifact. | 55 * A description used to build a interface to interact with this artifact. |
| 56 * @param data General input data. Useful to produces specific descriptions. | |
| 56 * @param context The global context of the runtime system. | 57 * @param context The global context of the runtime system. |
| 57 * @return An XML representation of the current state of the artifact. | 58 * @return An XML representation of the current state of the artifact. |
| 58 */ | 59 */ |
| 59 Document describe(Document data, CallContext context); | 60 Document describe(Document data, CallContext context); |
| 60 | 61 |
| 75 Document feed(Document data, CallContext context); | 76 Document feed(Document data, CallContext context); |
| 76 | 77 |
| 77 /** | 78 /** |
| 78 * Produce output from this artifact. | 79 * Produce output from this artifact. |
| 79 * @param format Specifies the format of the output. | 80 * @param format Specifies the format of the output. |
| 81 * @param out Stream to write the result data to. | |
| 80 * @param context The global context of the runtime system. | 82 * @param context The global context of the runtime system. |
| 83 * @throws IOException Thrown if an I/O occurs. | |
| 81 */ | 84 */ |
| 82 void out( | 85 void out( |
| 83 Document format, | 86 Document format, |
| 84 OutputStream out, | 87 OutputStream out, |
| 85 CallContext context) | 88 CallContext context) |
| 89 * When created by a factory this method is called to | 92 * When created by a factory this method is called to |
| 90 * initialize the artifact. | 93 * initialize the artifact. |
| 91 * @param identifier The identifier from artifact database | 94 * @param identifier The identifier from artifact database |
| 92 * @param factory The factory which created this artifact. | 95 * @param factory The factory which created this artifact. |
| 93 * @param context The global context of the runtime system. | 96 * @param context The global context of the runtime system. |
| 94 * @param data The data which can be use to setup an Artifact with | 97 * @param data The data which can be use to setup an artifact with |
| 95 * more details. | 98 * more details. |
| 96 */ | 99 */ |
| 97 public void setup( | 100 public void setup( |
| 98 String identifier, | 101 String identifier, |
| 99 ArtifactFactory factory, | 102 ArtifactFactory factory, |
| 100 Object context, | 103 Object context, |
| 101 Document data); | 104 Document data); |
| 102 | 105 |
| 103 /** | 106 /** |
| 104 * Called from artifact database when an artifact is | 107 * Called from artifact database when an artifact is |
| 105 * going to be removed from system. | 108 * going to be removed from system. |
| 106 * @param context The global context of the runtime system. | 109 * @param context The global context of the runtime system. |