Mercurial > dive4elements > river

annotate gwt-client/src/main/java/org/dive4elements/river/client/shared/model/OutputMode.java @ 5861:172338b1407f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
GWT client: Added copyright header.
author Sascha L. Teichmann <teichmann@intevation.de>
date Sun, 28 Apr 2013 14:30:15 +0200
parents 5aa05a7a34b7
children ea9eef426962
rev   line source
5861
172338b1407f GWT client: Added copyright header.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 5838
diff changeset
1 /* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde
172338b1407f GWT client: Added copyright header.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 5838
diff changeset
2 * Software engineering by Intevation GmbH
172338b1407f GWT client: Added copyright header.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 5838
diff changeset
3 *
172338b1407f GWT client: Added copyright header.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 5838
diff changeset
4 * This file is Free Software under the GNU AGPL (>=v3)
172338b1407f GWT client: Added copyright header.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 5838
diff changeset
5 * and comes with ABSOLUTELY NO WARRANTY! Check out the
172338b1407f GWT client: Added copyright header.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 5838
diff changeset
6 * documentation coming with Dive4Elements River for details.
172338b1407f GWT client: Added copyright header.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 5838
diff changeset
7 */
172338b1407f GWT client: Added copyright header.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 5838
diff changeset
8
5835
821a02bbfb4e Fixed internal java dependencies
Sascha L. Teichmann <teichmann@intevation.de>
parents: 5834
diff changeset
9 package org.dive4elements.river.client.shared.model;
63
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
10
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
11 import java.io.Serializable;
275
8264b02091ef ISSUE-56 Display download buttons to export the computed data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 270
diff changeset
12 import java.util.List;
63
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
13
5835
821a02bbfb4e Fixed internal java dependencies
Sascha L. Teichmann <teichmann@intevation.de>
parents: 5834
diff changeset
14 import org.dive4elements.river.client.client.ui.CollectionView;
821a02bbfb4e Fixed internal java dependencies
Sascha L. Teichmann <teichmann@intevation.de>
parents: 5834
diff changeset
15 import org.dive4elements.river.client.client.ui.OutputTab;
796
cd8603aaa730 Improved the process of creating OutputTabs. Added support for map output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 275
diff changeset
16
63
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
17
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
18 /**
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
19 * This interface describes an output mode of an artifact.
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
20 *
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
21 * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
22 */
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
23 public interface OutputMode extends Serializable {
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
24
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
25 /**
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
26 * Retrieves the name of this mode.
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
27 *
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
28 * @return the name of this mode.
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
29 */
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
30 String getName();
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
31
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
32
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
33 /**
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
34 * Retrieves the description of this mode.
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
35 *
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
36 * @return the description of this mode.
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
37 */
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
38 String getDescription();
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
39
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
40
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
41 /**
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
42 * Retrieves the mime-type of this mode.
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
43 *
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
44 *
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
45 * @return the mime-type of this mode.
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
46 */
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
47 String getMimeType();
270
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
48
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
49
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
50 /**
796
cd8603aaa730 Improved the process of creating OutputTabs. Added support for map output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 275
diff changeset
51 * Returns the type of this mode.
cd8603aaa730 Improved the process of creating OutputTabs. Added support for map output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 275
diff changeset
52 *
cd8603aaa730 Improved the process of creating OutputTabs. Added support for map output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 275
diff changeset
53 * @return the type of this mode.
cd8603aaa730 Improved the process of creating OutputTabs. Added support for map output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 275
diff changeset
54 */
cd8603aaa730 Improved the process of creating OutputTabs. Added support for map output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 275
diff changeset
55 String getType();
cd8603aaa730 Improved the process of creating OutputTabs. Added support for map output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 275
diff changeset
56
cd8603aaa730 Improved the process of creating OutputTabs. Added support for map output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 275
diff changeset
57
cd8603aaa730 Improved the process of creating OutputTabs. Added support for map output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 275
diff changeset
58 /**
270
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
59 * Adds a new facet to this mode.
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
60 *
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
61 * @param facet The new facet.
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
62 */
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
63 void addFacet(Facet facet);
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
64
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
65
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
66 /**
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
67 * Returns the number of facets supported by this mode.
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
68 *
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
69 * @return the number of facets.
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
70 */
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
71 int getFacetCount();
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
72
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
73
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
74 /**
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
75 * Returns the facet at a given position.
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
76 *
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
77 * @param idx The position of a facet.
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
78 *
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
79 * @return a facet.
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
80 */
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
81 Facet getFacet(int idx);
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
82
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
83
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
84 /**
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
85 * Returns a facet based on its name.
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
86 *
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
87 * @param name The name of the facet.
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
88 *
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
89 * @return a facet or null if no such facet is available.
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
90 */
d01b0d81b92a Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 63
diff changeset
91 Facet getFacet(String name);
275
8264b02091ef ISSUE-56 Display download buttons to export the computed data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 270
diff changeset
92
8264b02091ef ISSUE-56 Display download buttons to export the computed data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 270
diff changeset
93
8264b02091ef ISSUE-56 Display download buttons to export the computed data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 270
diff changeset
94 /**
8264b02091ef ISSUE-56 Display download buttons to export the computed data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 270
diff changeset
95 * Returns all facets of this mode.
8264b02091ef ISSUE-56 Display download buttons to export the computed data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 270
diff changeset
96 *
8264b02091ef ISSUE-56 Display download buttons to export the computed data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 270
diff changeset
97 * @return all facets.
8264b02091ef ISSUE-56 Display download buttons to export the computed data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 270
diff changeset
98 */
8264b02091ef ISSUE-56 Display download buttons to export the computed data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 270
diff changeset
99 List<Facet> getFacets();
796
cd8603aaa730 Improved the process of creating OutputTabs. Added support for map output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 275
diff changeset
100
cd8603aaa730 Improved the process of creating OutputTabs. Added support for map output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 275
diff changeset
101
cd8603aaa730 Improved the process of creating OutputTabs. Added support for map output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 275
diff changeset
102 /**
cd8603aaa730 Improved the process of creating OutputTabs. Added support for map output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 275
diff changeset
103 * Returns an OutputTab that is used to render the output mode.
cd8603aaa730 Improved the process of creating OutputTabs. Added support for map output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 275
diff changeset
104 *
cd8603aaa730 Improved the process of creating OutputTabs. Added support for map output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 275
diff changeset
105 * @param t The title.
cd8603aaa730 Improved the process of creating OutputTabs. Added support for map output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 275
diff changeset
106 * @param c The Collection.
cd8603aaa730 Improved the process of creating OutputTabs. Added support for map output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 275
diff changeset
107 * @param p The parent CollectionView.
cd8603aaa730 Improved the process of creating OutputTabs. Added support for map output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 275
diff changeset
108 *
cd8603aaa730 Improved the process of creating OutputTabs. Added support for map output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 275
diff changeset
109 * @return an OutputTab.
cd8603aaa730 Improved the process of creating OutputTabs. Added support for map output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 275
diff changeset
110 */
cd8603aaa730 Improved the process of creating OutputTabs. Added support for map output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 275
diff changeset
111 OutputTab createOutputTab(String t, Collection c, CollectionView p);
63
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
112 }
c8e651530f34 Added an interface and its default implementation to describe an output mode of an artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
113 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :
http://dive4elements.wald.intevation.org