Mercurial > dive4elements > river

annotate flys-client/src/main/java/de/intevation/flys/client/shared/model/OutputMode.java @ 270:d01b0d81b92a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Parse the facets of a Collection and distinguish between an ordinary OutputMode and an ExportMode (new). flys-client/trunk@1895 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Ingo Weinzierl <ingo.weinzierl@intevation.de>
date Wed, 11 May 2011 09:11:40 +0000
parents c8e651530f34
children 8264b02091ef
rev   line source
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
1 package de.intevation.flys.client.shared.model;
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
2
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
3 import java.io.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
4
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
5
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
6 /**
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
7 * 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
8 *
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
9 * @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
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 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
12
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 /**
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
14 * 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
15 *
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
16 * @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
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 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
19
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 /**
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 * 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
23 *
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 * @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
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 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
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
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 * 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
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 * @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
34 */
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 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
36
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
37
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
38 /**
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
39 * 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
40 *
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
41 * @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
42 */
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
43 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
44
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
45
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
46 /**
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
47 * 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
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 * @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
50 */
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
51 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
52
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
53
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
54 /**
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
55 * 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
56 *
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
57 * @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
58 *
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 * @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
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 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
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
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 * 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
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 * @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
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 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
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 Facet getFacet(String name);
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
72 }
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
73 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :
http://dive4elements.wald.intevation.org