Mercurial > dive4elements > framework

annotate artifact-database/src/main/java/de/intevation/artifactdatabase/state/Output.java @ 464:d4facc5e52e6 2.9.17

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added tag 2.9.16 for changeset 86be4d8e44d4
author Andre Heinecke <aheinecke@intevation.de>
date Fri, 05 Apr 2013 17:15:07 +0200
parents b47d0464f0db
children
rev   line source
209
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
1 package de.intevation.artifactdatabase.state;
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
2
226
41404961c804 Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 209
diff changeset
3 import java.util.List;
41404961c804 Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 209
diff changeset
4
209
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
5
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
6 /**
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
7 * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
8 */
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
9 public interface Output {
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
10
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
11 /**
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
12 * Retrieve the name of this output mode.
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
13 *
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
14 * @return the name of this output mode.
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
15 */
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
16 public String getName();
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
17
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
18 /**
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
19 * Retrieve the description of an output.
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
20 *
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
21 * @return the description.
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
22 */
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
23 public String getDescription();
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
24
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
25 /**
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
26 * Retrieve the mimetype used for the output.
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
27 *
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
28 * @return the mimetype.
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
29 */
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
30 public String getMimeType();
226
41404961c804 Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 209
diff changeset
31
290
995fa6994480 Outputs can have a member variable 'type' that should make it easier to distinguish the type of an Output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 251
diff changeset
32
995fa6994480 Outputs can have a member variable 'type' that should make it easier to distinguish the type of an Output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 251
diff changeset
33 /**
995fa6994480 Outputs can have a member variable 'type' that should make it easier to distinguish the type of an Output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 251
diff changeset
34 * Returns the type of this output.
995fa6994480 Outputs can have a member variable 'type' that should make it easier to distinguish the type of an Output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 251
diff changeset
35 *
995fa6994480 Outputs can have a member variable 'type' that should make it easier to distinguish the type of an Output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 251
diff changeset
36 * @return the type.
995fa6994480 Outputs can have a member variable 'type' that should make it easier to distinguish the type of an Output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 251
diff changeset
37 */
995fa6994480 Outputs can have a member variable 'type' that should make it easier to distinguish the type of an Output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 251
diff changeset
38 public String getType();
995fa6994480 Outputs can have a member variable 'type' that should make it easier to distinguish the type of an Output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 251
diff changeset
39
226
41404961c804 Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 209
diff changeset
40 /**
41404961c804 Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 209
diff changeset
41 * Retrieve the facets of this output.
41404961c804 Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 209
diff changeset
42 *
41404961c804 Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 209
diff changeset
43 * @return the facets of this output.
41404961c804 Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 209
diff changeset
44 */
41404961c804 Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 209
diff changeset
45 public List<Facet> getFacets();
251
9e12f3fbcf78 Added a method to add new facets to an output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 226
diff changeset
46
9e12f3fbcf78 Added a method to add new facets to an output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 226
diff changeset
47 /**
9e12f3fbcf78 Added a method to add new facets to an output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 226
diff changeset
48 * Add a new facet to this output.
9e12f3fbcf78 Added a method to add new facets to an output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 226
diff changeset
49 *
9e12f3fbcf78 Added a method to add new facets to an output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 226
diff changeset
50 * @param facet The new facet.
9e12f3fbcf78 Added a method to add new facets to an output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 226
diff changeset
51 */
9e12f3fbcf78 Added a method to add new facets to an output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 226
diff changeset
52 public void addFacet(Facet facet);
296
a8e009ebe13c Added a addFacets(List<Facet) method to Outputs to be able to add more than only a single facet to an output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 290
diff changeset
53
a8e009ebe13c Added a addFacets(List<Facet) method to Outputs to be able to add more than only a single facet to an output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 290
diff changeset
54 /**
a8e009ebe13c Added a addFacets(List<Facet) method to Outputs to be able to add more than only a single facet to an output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 290
diff changeset
55 * Add a list of facet to this output.
a8e009ebe13c Added a addFacets(List<Facet) method to Outputs to be able to add more than only a single facet to an output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 290
diff changeset
56 *
a8e009ebe13c Added a addFacets(List<Facet) method to Outputs to be able to add more than only a single facet to an output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 290
diff changeset
57 * @param facets A list of facets.
a8e009ebe13c Added a addFacets(List<Facet) method to Outputs to be able to add more than only a single facet to an output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 290
diff changeset
58 */
a8e009ebe13c Added a addFacets(List<Facet) method to Outputs to be able to add more than only a single facet to an output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 290
diff changeset
59 public void addFacets(List<Facet> facets);
358
03a8f9796571 Added interfaces for a Settings hierachy currently used for Outputs.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 296
diff changeset
60
03a8f9796571 Added interfaces for a Settings hierachy currently used for Outputs.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 296
diff changeset
61 /**
361
b47d0464f0db Extended the Output interface and its default implementation with a method to replace an existing list of Facets.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 358
diff changeset
62 * Replaces the old list of facets with a new one.
b47d0464f0db Extended the Output interface and its default implementation with a method to replace an existing list of Facets.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 358
diff changeset
63 *
b47d0464f0db Extended the Output interface and its default implementation with a method to replace an existing list of Facets.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 358
diff changeset
64 * @param facets A list of new facets.
b47d0464f0db Extended the Output interface and its default implementation with a method to replace an existing list of Facets.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 358
diff changeset
65 */
b47d0464f0db Extended the Output interface and its default implementation with a method to replace an existing list of Facets.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 358
diff changeset
66 public void setFacets(List<Facet> facets);
b47d0464f0db Extended the Output interface and its default implementation with a method to replace an existing list of Facets.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 358
diff changeset
67
b47d0464f0db Extended the Output interface and its default implementation with a method to replace an existing list of Facets.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 358
diff changeset
68 /**
358
03a8f9796571 Added interfaces for a Settings hierachy currently used for Outputs.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 296
diff changeset
69 * Returns a Settings object for this Output.
03a8f9796571 Added interfaces for a Settings hierachy currently used for Outputs.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 296
diff changeset
70 */
03a8f9796571 Added interfaces for a Settings hierachy currently used for Outputs.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 296
diff changeset
71 public Settings getSettings();
03a8f9796571 Added interfaces for a Settings hierachy currently used for Outputs.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 296
diff changeset
72
03a8f9796571 Added interfaces for a Settings hierachy currently used for Outputs.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 296
diff changeset
73 /**
03a8f9796571 Added interfaces for a Settings hierachy currently used for Outputs.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 296
diff changeset
74 * Sets the Settings for this Output.
03a8f9796571 Added interfaces for a Settings hierachy currently used for Outputs.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 296
diff changeset
75 *
03a8f9796571 Added interfaces for a Settings hierachy currently used for Outputs.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 296
diff changeset
76 * @param settings the Settings for this Output.
03a8f9796571 Added interfaces for a Settings hierachy currently used for Outputs.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 296
diff changeset
77 */
03a8f9796571 Added interfaces for a Settings hierachy currently used for Outputs.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 296
diff changeset
78 public void setSettings(Settings settings);
209
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
79 }
1a3fb29b8b2e Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
80 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf-8 :
http://dive4elements.wald.intevation.org