Mercurial > dive4elements > gnv-client

comparison gnv/src/main/java/de/intevation/gnv/artifactdatabase/client/ArtifactDatabaseClient.java @ 699:af22fa5567a6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Removed trailing whitespace. gnv/trunk@935 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Sascha L. Teichmann <sascha.teichmann@intevation.de>
date Sat, 17 Apr 2010 09:31:48 +0000
parents 254f062e334b
children 89ade245ca7a
comparison
equal deleted inserted replaced
698:d7b005107443 699:af22fa5567a6
20 import org.w3c.dom.Document; 20 import org.w3c.dom.Document;
21 21
22 /** 22 /**
23 * This interface describes basic methods for the communication between artifact 23 * This interface describes basic methods for the communication between artifact
24 * server and this client. 24 * server and this client.
25 * 25 *
26 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> 26 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
27 * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a> 27 * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
28 */ 28 */
29 public interface ArtifactDatabaseClient { 29 public interface ArtifactDatabaseClient {
30 30
44 throws ArtifactDatabaseClientException, ArtifactDatabaseInputException; 44 throws ArtifactDatabaseClientException, ArtifactDatabaseInputException;
45 45
46 /** 46 /**
47 * Call the create operation of the artifact server and returns a new 47 * Call the create operation of the artifact server and returns a new
48 * artifact with the information returned by the artifact server. 48 * artifact with the information returned by the artifact server.
49 * 49 *
50 * @param artifactFactory 50 * @param artifactFactory
51 * @return the new Artifact 51 * @return the new Artifact
52 * @throws ArtifactDatabaseClientException if a general error occured in the 52 * @throws ArtifactDatabaseClientException if a general error occured in the
53 * artifact server. 53 * artifact server.
54 * @throws ArtifactDatabaseInputException if the input data was valid. 54 * @throws ArtifactDatabaseInputException if the input data was valid.
59 /** 59 /**
60 * Call the describe operation of the artifact server. 60 * Call the describe operation of the artifact server.
61 * 61 *
62 * @param artifactFactory 62 * @param artifactFactory
63 * @param currentArtifact 63 * @param currentArtifact
64 * @param includeUI 64 * @param includeUI
65 * @return the Current Artifact 65 * @return the Current Artifact
66 * @throws ArtifactDatabaseClientException if a general error occured in the 66 * @throws ArtifactDatabaseClientException if a general error occured in the
67 * artifact server. 67 * artifact server.
68 * @throws ArtifactDatabaseInputException if the input data was valid. 68 * @throws ArtifactDatabaseInputException if the input data was valid.
69 */ 69 */
117 * @param currentArtifact 117 * @param currentArtifact
118 * @param stream 118 * @param stream
119 * @param targetName 119 * @param targetName
120 * @param exportMode 120 * @param exportMode
121 * @param mimeType 121 * @param mimeType
122 * @param inputParameter 122 * @param inputParameter
123 * @throws ArtifactDatabaseClientException 123 * @throws ArtifactDatabaseClientException
124 */ 124 */
125 public void doOutput( 125 public void doOutput(
126 ArtifactObject artifactFactory, 126 ArtifactObject artifactFactory,
127 ArtifactObject currentArtifact, 127 ArtifactObject currentArtifact,
133 throws ArtifactDatabaseClientException; 133 throws ArtifactDatabaseClientException;
134 134
135 135
136 /** 136 /**
137 * Write the current artifact to an xml file. 137 * Write the current artifact to an xml file.
138 * 138 *
139 * @param artifactFactory 139 * @param artifactFactory
140 * @param currentArtifact 140 * @param currentArtifact
141 * @param out 141 * @param out
142 * @throws ArtifactDatabaseClientException 142 * @throws ArtifactDatabaseClientException
143 */ 143 */
148 throws ArtifactDatabaseClientException; 148 throws ArtifactDatabaseClientException;
149 149
150 150
151 /** 151 /**
152 * Import an artifact from xml file. 152 * Import an artifact from xml file.
153 * 153 *
154 * @param factory 154 * @param factory
155 * @param document 155 * @param document
156 * @return a status message. If the import was successful, it contains 156 * @return a status message. If the import was successful, it contains
157 * information about the imported artifact, otherwise a failure is 157 * information about the imported artifact, otherwise a failure is
158 * contained. 158 * contained.
164 Document document) 164 Document document)
165 throws ArtifactDatabaseClientException, IOException; 165 throws ArtifactDatabaseClientException, IOException;
166 166
167 /** 167 /**
168 * Publish shapefiles of an artifact as WMS layer. 168 * Publish shapefiles of an artifact as WMS layer.
169 * 169 *
170 * @param factory 170 * @param factory
171 * @param artifact 171 * @param artifact
172 * @param inputParameter 172 * @param inputParameter
173 * @return URL to wms service as string 173 * @return URL to wms service as string
174 * @throws ArtifactDatabaseClientException 174 * @throws ArtifactDatabaseClientException
175 * @throws ArtifactDatabaseInputException 175 * @throws ArtifactDatabaseInputException
176 */ 176 */
177 public Document publishWMS( 177 public Document publishWMS(
178 ArtifactObject factory, 178 ArtifactObject factory,
179 ArtifactObject artifact, 179 ArtifactObject artifact,
180 Collection<InputParameter> inputParameter 180 Collection<InputParameter> inputParameter
181 )throws ArtifactDatabaseClientException, ArtifactDatabaseInputException; 181 )throws ArtifactDatabaseClientException, ArtifactDatabaseInputException;
182 182
183 183
184 /** 184 /**
185 * Start statistics calculation. 185 * Start statistics calculation.
186 * 186 *
187 * @param artifactFactory 187 * @param artifactFactory
188 * @param currentArtifact 188 * @param currentArtifact
189 * @return the calculated statistic. 189 * @return the calculated statistic.
190 * @throws ArtifactDatabaseClientException 190 * @throws ArtifactDatabaseClientException
191 */ 191 */
http://dive4elements.wald.intevation.org