Mercurial > dive4elements > gnv-client
annotate gnv/src/main/java/de/intevation/gnv/action/sessionmodel/SessionModel.java @ 954:a88fc6320cf8
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 |
| rev | line source |
|---|---|
|
8
65ff6fcfee0c
Some Basic Stuff for WebProjects
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
1 package de.intevation.gnv.action.sessionmodel; |
|
65ff6fcfee0c
Some Basic Stuff for WebProjects
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
2 |
| 954 | 3 import java.io.Serializable; |
| 4 import java.util.Collection; | |
| 5 import java.util.Locale; | |
| 6 | |
|
30
07e9c137a2f1
Added dynamic Outputparameter Support and Outputparameter-manipulation
Tim Englich <tim.englich@intevation.de>
parents:
29
diff
changeset
|
7 import de.intevation.gnv.artifactdatabase.objects.ArtifactDescription; |
|
8
65ff6fcfee0c
Some Basic Stuff for WebProjects
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
8 import de.intevation.gnv.artifactdatabase.objects.ArtifactObject; |
|
164
5570d9b3282f
Implemented a better GUI-Structure for displaying the Statisticdata. issue83
Tim Englich <tim.englich@intevation.de>
parents:
36
diff
changeset
|
9 import de.intevation.gnv.artifactdatabase.objects.ArtifactStatisticsSet; |
|
30
07e9c137a2f1
Added dynamic Outputparameter Support and Outputparameter-manipulation
Tim Englich <tim.englich@intevation.de>
parents:
29
diff
changeset
|
10 import de.intevation.gnv.artifactdatabase.objects.OutputMode; |
|
8
65ff6fcfee0c
Some Basic Stuff for WebProjects
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
11 |
|
65ff6fcfee0c
Some Basic Stuff for WebProjects
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
12 /** |
|
690
254f062e334b
Added JavaDoc.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
684
diff
changeset
|
13 * This interface describe basic methods to store artifacts and diagram options. |
|
254f062e334b
Added JavaDoc.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
684
diff
changeset
|
14 * The SessionModel is saved in the session, which keeps alive during the work. |
|
699
af22fa5567a6
Removed trailing whitespace.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
690
diff
changeset
|
15 * |
|
684
57fa8019fbdc
Bring @author javadoc tags in form '@author <a href="john.doe@example.com">John Doe</a>'
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
683
diff
changeset
|
16 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> |
|
681
15ac78a91d1b
Removed trailing whitespace.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
165
diff
changeset
|
17 * |
|
8
65ff6fcfee0c
Some Basic Stuff for WebProjects
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
18 */ |
|
36
ad381cc47217
Format Code to max 80 Chars per Row
Tim Englich <tim.englich@intevation.de>
parents:
32
diff
changeset
|
19 public interface SessionModel extends Serializable { |
|
ad381cc47217
Format Code to max 80 Chars per Row
Tim Englich <tim.englich@intevation.de>
parents:
32
diff
changeset
|
20 |
| 954 | 21 /** |
| 22 * Returns all Artifactfactories which were retrieved from the | |
| 23 * Artifactdatabases which are connected to the Client. | |
| 24 * @return the artifactfactories. | |
| 25 */ | |
|
8
65ff6fcfee0c
Some Basic Stuff for WebProjects
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
26 Collection<ArtifactObject> getArtifactFactories(); |
|
36
ad381cc47217
Format Code to max 80 Chars per Row
Tim Englich <tim.englich@intevation.de>
parents:
32
diff
changeset
|
27 |
| 954 | 28 /** |
| 29 * Sets all Artifactfactories which were retieved from the Artifactdatabases | |
| 30 * to the SessionModel. | |
| 31 * @param artifactFactories the artifactfactories. | |
| 32 */ | |
|
8
65ff6fcfee0c
Some Basic Stuff for WebProjects
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
33 void setArtifacteFactories(Collection<ArtifactObject> artifactFactories); |
|
36
ad381cc47217
Format Code to max 80 Chars per Row
Tim Englich <tim.englich@intevation.de>
parents:
32
diff
changeset
|
34 |
| 954 | 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 */ | |
|
8
65ff6fcfee0c
Some Basic Stuff for WebProjects
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
40 void selectArtifactFactory(String artiFactFactoryId); |
|
36
ad381cc47217
Format Code to max 80 Chars per Row
Tim Englich <tim.englich@intevation.de>
parents:
32
diff
changeset
|
41 |
| 954 | 42 /** |
| 43 * Returns the Artifactfactory which is selected. | |
| 44 * @return the artifactfactory which is selected. | |
| 45 */ | |
|
8
65ff6fcfee0c
Some Basic Stuff for WebProjects
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
46 ArtifactObject getSelectedArtifactFactory(); |
|
36
ad381cc47217
Format Code to max 80 Chars per Row
Tim Englich <tim.englich@intevation.de>
parents:
32
diff
changeset
|
47 |
| 954 | 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 */ | |
|
8
65ff6fcfee0c
Some Basic Stuff for WebProjects
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
54 ArtifactObject getCurrentArtifact(); |
|
36
ad381cc47217
Format Code to max 80 Chars per Row
Tim Englich <tim.englich@intevation.de>
parents:
32
diff
changeset
|
55 |
| 954 | 56 /** |
| 57 * Sets a new Artifact as the artifact that should be used. | |
| 58 * @param artifact the new artifact which should be used. | |
| 59 */ | |
|
8
65ff6fcfee0c
Some Basic Stuff for WebProjects
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
60 void setCurrentArtifact(ArtifactObject artifact); |
|
36
ad381cc47217
Format Code to max 80 Chars per Row
Tim Englich <tim.englich@intevation.de>
parents:
32
diff
changeset
|
61 |
| 954 | 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 */ | |
|
30
07e9c137a2f1
Added dynamic Outputparameter Support and Outputparameter-manipulation
Tim Englich <tim.englich@intevation.de>
parents:
29
diff
changeset
|
69 void setDiagrammOptions(DiagrammOptions diagrammOptions); |
|
36
ad381cc47217
Format Code to max 80 Chars per Row
Tim Englich <tim.englich@intevation.de>
parents:
32
diff
changeset
|
70 |
| 954 | 71 /** |
| 72 * Returns the diagrammoptions that currently set to the SessionModel. | |
| 73 * @return the diagrammoptions that currently set to the SessionModel. | |
| 74 */ | |
|
29
bba8fd97e549
Export and Diagrammoptions integrated into GUI
Tim Englich <tim.englich@intevation.de>
parents:
8
diff
changeset
|
75 DiagrammOptions getDiagrammOptions(); |
|
36
ad381cc47217
Format Code to max 80 Chars per Row
Tim Englich <tim.englich@intevation.de>
parents:
32
diff
changeset
|
76 |
| 954 | 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 */ | |
|
30
07e9c137a2f1
Added dynamic Outputparameter Support and Outputparameter-manipulation
Tim Englich <tim.englich@intevation.de>
parents:
29
diff
changeset
|
84 OutputMode getOutputMode(String name); |
|
36
ad381cc47217
Format Code to max 80 Chars per Row
Tim Englich <tim.englich@intevation.de>
parents:
32
diff
changeset
|
85 |
| 954 | 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 */ | |
|
30
07e9c137a2f1
Added dynamic Outputparameter Support and Outputparameter-manipulation
Tim Englich <tim.englich@intevation.de>
parents:
29
diff
changeset
|
92 ArtifactDescription getArtifactDescription(); |
|
36
ad381cc47217
Format Code to max 80 Chars per Row
Tim Englich <tim.englich@intevation.de>
parents:
32
diff
changeset
|
93 |
| 954 | 94 /** |
| 95 * Reset the Model. So that it will have the status as no Artifactfactory | |
| 96 * was selected. | |
| 97 */ | |
|
30
07e9c137a2f1
Added dynamic Outputparameter Support and Outputparameter-manipulation
Tim Englich <tim.englich@intevation.de>
parents:
29
diff
changeset
|
98 void resetModel(); |
|
36
ad381cc47217
Format Code to max 80 Chars per Row
Tim Englich <tim.englich@intevation.de>
parents:
32
diff
changeset
|
99 |
| 954 | 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 */ | |
|
164
5570d9b3282f
Implemented a better GUI-Structure for displaying the Statisticdata. issue83
Tim Englich <tim.englich@intevation.de>
parents:
36
diff
changeset
|
105 void setStatistics(Collection<ArtifactStatisticsSet> statistics); |
|
36
ad381cc47217
Format Code to max 80 Chars per Row
Tim Englich <tim.englich@intevation.de>
parents:
32
diff
changeset
|
106 |
| 954 | 107 /** |
| 108 * Returns the statistics that are currently set to the SessionModel | |
| 109 * @return the statistics that are currently set to the SessionModel | |
| 110 */ | |
|
164
5570d9b3282f
Implemented a better GUI-Structure for displaying the Statisticdata. issue83
Tim Englich <tim.englich@intevation.de>
parents:
36
diff
changeset
|
111 Collection<ArtifactStatisticsSet> getStatistics(); |
|
706
2659a5b1fa1e
Added a link (and a controller) to toggle between german and english language (issue254).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
700
diff
changeset
|
112 |
| 954 | 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 */ | |
|
706
2659a5b1fa1e
Added a link (and a controller) to toggle between german and english language (issue254).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
700
diff
changeset
|
120 void setCurrentLocale(Locale locale); |
|
2659a5b1fa1e
Added a link (and a controller) to toggle between german and english language (issue254).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
700
diff
changeset
|
121 |
| 954 | 122 /** |
| 123 * Returns the currently used locale. | |
| 124 * @return the locale that is currently used. | |
| 125 */ | |
|
706
2659a5b1fa1e
Added a link (and a controller) to toggle between german and english language (issue254).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
700
diff
changeset
|
126 Locale getCurrentLocale(); |
|
8
65ff6fcfee0c
Some Basic Stuff for WebProjects
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
127 } |
|
700
89ade245ca7a
Using unix line endings only.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
699
diff
changeset
|
128 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf-8 : |