Mercurial > dive4elements > gnv-client
comparison gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/fis/SelectProductArtifact.java @ 815:22c18083225e
Removed compiler warnings while JavaDoc generation.
gnv-artifacts/trunk@900 c6561f87-3c4e-4783-a992-168aeb5c3f6f
| author | Ingo Weinzierl <ingo.weinzierl@intevation.de> |
|---|---|
| date | Mon, 12 Apr 2010 06:59:33 +0000 |
| parents | feae2f9d6c6f |
| children | 41234fcf4c7e |
comparison
equal
deleted
inserted
replaced
| 814:9d427dd2a96a | 815:22c18083225e |
|---|---|
| 73 * Path to parameters required by the factory. | 73 * Path to parameters required by the factory. |
| 74 */ | 74 */ |
| 75 public static final String XPATH_SETUP_PARAMETER_NODES = | 75 public static final String XPATH_SETUP_PARAMETER_NODES = |
| 76 "/art:action/art:factory/art:parameter"; | 76 "/art:action/art:factory/art:parameter"; |
| 77 | 77 |
| 78 /** | |
| 79 * | |
| 80 */ | |
| 81 public static final String XFORM_URL = "http://www.w3.org/2002/xforms"; | 78 public static final String XFORM_URL = "http://www.w3.org/2002/xforms"; |
| 82 | 79 |
| 83 /** | 80 /** |
| 84 * Prefix used in the user interface description part of the describe | 81 * Prefix used in the user interface description part of the describe |
| 85 * document. | 82 * document. |
| 149 } | 146 } |
| 150 | 147 |
| 151 | 148 |
| 152 /** | 149 /** |
| 153 * | 150 * |
| 154 * @param products | 151 * @param products Insert a bunch of products. |
| 155 */ | 152 */ |
| 156 public void setProducts(Map products) { | 153 public void setProducts(Map products) { |
| 157 this.products = products; | 154 this.products = products; |
| 158 } | 155 } |
| 159 | 156 |
| 218 /** | 215 /** |
| 219 * If {@link #feed(org.w3c.dom.Document, de.intevation.artifacts.CallContext)} | 216 * If {@link #feed(org.w3c.dom.Document, de.intevation.artifacts.CallContext)} |
| 220 * was sucessfully called before, this artifact is replaced with a concrete | 217 * was sucessfully called before, this artifact is replaced with a concrete |
| 221 * product artifact. | 218 * product artifact. |
| 222 * | 219 * |
| 223 * @param target | 220 * @param target The advance document. |
| 224 * @param context | 221 * @param context The CallContext. |
| 225 * @return | 222 * @return a document with an error or success message. |
| 226 */ | 223 */ |
| 227 @Override | 224 @Override |
| 228 public Document advance(Document target, CallContext context) { | 225 public Document advance(Document target, CallContext context) { |
| 229 log.debug("SelectProductArtifact.advance()"); | 226 log.debug("SelectProductArtifact.advance()"); |
| 230 | 227 |
| 288 | 285 |
| 289 /** | 286 /** |
| 290 * Create a describe document including the user interface description. The | 287 * Create a describe document including the user interface description. The |
| 291 * user gets the choice to select a product supported by the current fis. | 288 * user gets the choice to select a product supported by the current fis. |
| 292 * | 289 * |
| 293 * @param data | 290 * @param data The describe document. |
| 294 * @param context | 291 * @param context The CallContext. |
| 295 * @return | 292 * @return A document with an error or success message. |
| 296 */ | 293 */ |
| 297 @Override | 294 @Override |
| 298 public Document describe(Document data, CallContext context) { | 295 public Document describe(Document data, CallContext context) { |
| 299 log.debug("SelectProductArtifact.describe()"); | 296 log.debug("SelectProductArtifact.describe()"); |
| 300 | 297 |
| 378 | 375 |
| 379 | 376 |
| 380 /** | 377 /** |
| 381 * Append products to the describe document. | 378 * Append products to the describe document. |
| 382 * | 379 * |
| 383 * @param document | 380 * @param document The describe document. |
| 384 * @param parent | 381 * @param parent The node the products should be appended to. |
| 385 * @param context | 382 * @param context The CallContext object. |
| 386 */ | 383 */ |
| 387 protected void appendProducts( | 384 protected void appendProducts( |
| 388 Document document, | 385 Document document, |
| 389 Node parent, | 386 Node parent, |
| 390 Object context | 387 Object context |
| 411 | 408 |
| 412 /** | 409 /** |
| 413 * Append the product select box to the user interface description of the | 410 * Append the product select box to the user interface description of the |
| 414 * describe document. | 411 * describe document. |
| 415 * | 412 * |
| 416 * @param document | 413 * @param document The describe document. |
| 417 * @param node | 414 * @param node The node the products should be appended to. |
| 418 * @param callMeta | 415 * @param callMeta The CallMeta object. |
| 419 */ | 416 */ |
| 420 protected void appendSelectProducts( | 417 protected void appendSelectProducts( |
| 421 Document document, | 418 Document document, |
| 422 Node node, | 419 Node node, |
| 423 CallMeta callMeta | 420 CallMeta callMeta |
| 468 | 465 |
| 469 | 466 |
| 470 /** | 467 /** |
| 471 * Create a feed document. | 468 * Create a feed document. |
| 472 * | 469 * |
| 473 * @param uuid | 470 * @param uuid The UUID of the current artifact. |
| 474 * @param hash | 471 * @param hash The hash of the current artifact. |
| 475 * @return | 472 * @return the feed document. |
| 476 */ | 473 */ |
| 477 protected Document feedDocument(String uuid, String hash) { | 474 protected Document feedDocument(String uuid, String hash) { |
| 478 Document document = XMLUtils.newDocument(); | 475 Document document = XMLUtils.newDocument(); |
| 479 | 476 |
| 480 XMLUtils.ElementCreator creator = new XMLUtils.ElementCreator( | 477 XMLUtils.ElementCreator creator = new XMLUtils.ElementCreator( |