Mercurial > dive4elements > gnv-client

comparison gnv/src/main/java/de/intevation/gnv/action/sessionmodel/SessionModel.java @ 954:a88fc6320cf8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add more Javadocs gnv/trunk@1098 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Tim Englich <tim.englich@intevation.de>
date Tue, 18 May 2010 09:11:31 +0000
parents 2659a5b1fa1e
children d1ed5c51c0de
comparison
equal deleted inserted replaced
953:4b64b4d1f0cf 954:a88fc6320cf8
1 package de.intevation.gnv.action.sessionmodel; 1 package de.intevation.gnv.action.sessionmodel;
2
3 import java.io.Serializable;
4 import java.util.Collection;
5 import java.util.Locale;
2 6
3 import de.intevation.gnv.artifactdatabase.objects.ArtifactDescription; 7 import de.intevation.gnv.artifactdatabase.objects.ArtifactDescription;
4 import de.intevation.gnv.artifactdatabase.objects.ArtifactObject; 8 import de.intevation.gnv.artifactdatabase.objects.ArtifactObject;
5 import de.intevation.gnv.artifactdatabase.objects.ArtifactStatisticsSet; 9 import de.intevation.gnv.artifactdatabase.objects.ArtifactStatisticsSet;
6 import de.intevation.gnv.artifactdatabase.objects.OutputMode; 10 import de.intevation.gnv.artifactdatabase.objects.OutputMode;
7
8 import java.io.Serializable;
9
10 import java.util.Collection;
11 import java.util.Locale;
12 11
13 /** 12 /**
14 * This interface describe basic methods to store artifacts and diagram options. 13 * This interface describe basic methods to store artifacts and diagram options.
15 * The SessionModel is saved in the session, which keeps alive during the work. 14 * The SessionModel is saved in the session, which keeps alive during the work.
16 * 15 *
17 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> 16 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
18 * 17 *
19 */ 18 */
20 public interface SessionModel extends Serializable { 19 public interface SessionModel extends Serializable {
21 20
21 /**
22 * Returns all Artifactfactories which were retrieved from the
23 * Artifactdatabases which are connected to the Client.
24 * @return the artifactfactories.
25 */
22 Collection<ArtifactObject> getArtifactFactories(); 26 Collection<ArtifactObject> getArtifactFactories();
23 27
28 /**
29 * Sets all Artifactfactories which were retieved from the Artifactdatabases
30 * to the SessionModel.
31 * @param artifactFactories the artifactfactories.
32 */
24 void setArtifacteFactories(Collection<ArtifactObject> artifactFactories); 33 void setArtifacteFactories(Collection<ArtifactObject> artifactFactories);
25 34
35 /**
36 * Set the Artifactfactory which match to the given id to selected.
37 * @param artiFactFactoryId the id of the artifactfactory which should
38 * be selected.
39 */
26 void selectArtifactFactory(String artiFactFactoryId); 40 void selectArtifactFactory(String artiFactFactoryId);
27 41
42 /**
43 * Returns the Artifactfactory which is selected.
44 * @return the artifactfactory which is selected.
45 */
28 ArtifactObject getSelectedArtifactFactory(); 46 ArtifactObject getSelectedArtifactFactory();
29 47
48 /**
49 * Returns the currently used artifact.
50 * This Artifact will retrieved from the selected artifactfactory and will
51 * be used to do handle the special businesslogic.
52 * @return the artifact which is currently used.
53 */
30 ArtifactObject getCurrentArtifact(); 54 ArtifactObject getCurrentArtifact();
31 55
56 /**
57 * Sets a new Artifact as the artifact that should be used.
58 * @param artifact the new artifact which should be used.
59 */
32 void setCurrentArtifact(ArtifactObject artifact); 60 void setCurrentArtifact(ArtifactObject artifact);
33 61
62 /**
63 * Sets the currently used diagrammoptions to the Sessionmodel.
64 * Diagrammoptions will be used to manipulate the look of diagramms
65 * and render the GUI so that the user is enabled to switch the options.
66 * Diagrammoptions are also used for Histogram, all Exports and WMS
67 * @param diagrammOptions the Options that should be used.
68 */
34 void setDiagrammOptions(DiagrammOptions diagrammOptions); 69 void setDiagrammOptions(DiagrammOptions diagrammOptions);
35 70
71 /**
72 * Returns the diagrammoptions that currently set to the SessionModel.
73 * @return the diagrammoptions that currently set to the SessionModel.
74 */
36 DiagrammOptions getDiagrammOptions(); 75 DiagrammOptions getDiagrammOptions();
37 76
77 /**
78 * Returns the Outputmode that matches to the given name of an mode.
79 * Outputmodes are used to define which kind of modes are defined to
80 * generate an result for a given Artifact (chart, export, wms,...)
81 * @param name the name of the OutputMode that should be used
82 * @return the OutputMode that matches to the given name.
83 */
38 OutputMode getOutputMode(String name); 84 OutputMode getOutputMode(String name);
39 85
86 /**
87 * Returns the description to the currently used Artifact.
88 * The description can be used to retrieve the supported OutputModes,
89 * the parameters that could be feed, ...
90 * @return the description of the artifact which is currently used.
91 */
40 ArtifactDescription getArtifactDescription(); 92 ArtifactDescription getArtifactDescription();
41 93
94 /**
95 * Reset the Model. So that it will have the status as no Artifactfactory
96 * was selected.
97 */
42 void resetModel(); 98 void resetModel();
43 99
100 /**
101 * Sets the Statistics that were retrieved from the currently used Artifact
102 * to the SessionModel.
103 * @param statistics the Statistics that should be shown in the GUI.
104 */
44 void setStatistics(Collection<ArtifactStatisticsSet> statistics); 105 void setStatistics(Collection<ArtifactStatisticsSet> statistics);
45 106
107 /**
108 * Returns the statistics that are currently set to the SessionModel
109 * @return the statistics that are currently set to the SessionModel
110 */
46 Collection<ArtifactStatisticsSet> getStatistics(); 111 Collection<ArtifactStatisticsSet> getStatistics();
47 112
113 /**
114 * Sets the locale that should be used.
115 * The loacle will be used to customize the GUI for a language that matches
116 * to the locale or it will be used to tell the Artifactdatabase which locale
117 * has to be used.
118 * @param locale the locale that should be used.
119 */
48 void setCurrentLocale(Locale locale); 120 void setCurrentLocale(Locale locale);
49 121
122 /**
123 * Returns the currently used locale.
124 * @return the locale that is currently used.
125 */
50 Locale getCurrentLocale(); 126 Locale getCurrentLocale();
51 } 127 }
52 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf-8 : 128 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf-8 :
http://dive4elements.wald.intevation.org