Mercurial > dive4elements > framework
annotate artifact-database/src/main/java/org/dive4elements/artifactdatabase/state/AbstractState.java @ 570:584591f8203c 3.2.x
Upgrade to Log4j 2
author | Tom Gottfried <tom@intevation.de> |
---|---|
date | Mon, 28 Feb 2022 17:41:14 +0100 |
parents | 415df0fc4fa1 |
children |
rev | line source |
---|---|
105
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
1 /* |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
2 * Copyright (c) 2011 by Intevation GmbH |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
3 * |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
4 * This program is free software under the LGPL (>=v2.1) |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
5 * Read the file LGPL.txt coming with the software for details |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
6 * or visit http://www.gnu.org/licenses/ if it does not exist. |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
7 */ |
475
415df0fc4fa1
Fixed maven group ids
Sascha L. Teichmann <teichmann@intevation.de>
parents:
473
diff
changeset
|
8 package org.dive4elements.artifactdatabase.state; |
105
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
9 |
209
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
10 import java.util.ArrayList; |
105
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
11 import java.util.HashMap; |
209
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
12 import java.util.List; |
105
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
13 import java.util.Map; |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
14 |
106
ece0fdb07975
Implementations to initialize and retrieve states.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
105
diff
changeset
|
15 import javax.xml.xpath.XPathConstants; |
ece0fdb07975
Implementations to initialize and retrieve states.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
105
diff
changeset
|
16 |
570 | 17 import org.apache.logging.log4j.Logger; |
18 import org.apache.logging.log4j.LogManager; | |
226
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
19 |
105
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
20 import org.w3c.dom.Document; |
205
2a9591f76270
Changed the return type of a State's describe() method.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
106
diff
changeset
|
21 import org.w3c.dom.Element; |
105
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
22 import org.w3c.dom.Node; |
209
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
23 import org.w3c.dom.NodeList; |
105
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
24 |
475
415df0fc4fa1
Fixed maven group ids
Sascha L. Teichmann <teichmann@intevation.de>
parents:
473
diff
changeset
|
25 import org.dive4elements.artifacts.Artifact; |
415df0fc4fa1
Fixed maven group ids
Sascha L. Teichmann <teichmann@intevation.de>
parents:
473
diff
changeset
|
26 import org.dive4elements.artifacts.ArtifactNamespaceContext; |
415df0fc4fa1
Fixed maven group ids
Sascha L. Teichmann <teichmann@intevation.de>
parents:
473
diff
changeset
|
27 import org.dive4elements.artifacts.CallContext; |
415df0fc4fa1
Fixed maven group ids
Sascha L. Teichmann <teichmann@intevation.de>
parents:
473
diff
changeset
|
28 import org.dive4elements.artifacts.CallMeta; |
105
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
29 |
475
415df0fc4fa1
Fixed maven group ids
Sascha L. Teichmann <teichmann@intevation.de>
parents:
473
diff
changeset
|
30 import org.dive4elements.artifacts.common.utils.Config; |
415df0fc4fa1
Fixed maven group ids
Sascha L. Teichmann <teichmann@intevation.de>
parents:
473
diff
changeset
|
31 import org.dive4elements.artifacts.common.utils.XMLUtils; |
106
ece0fdb07975
Implementations to initialize and retrieve states.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
105
diff
changeset
|
32 |
475
415df0fc4fa1
Fixed maven group ids
Sascha L. Teichmann <teichmann@intevation.de>
parents:
473
diff
changeset
|
33 import org.dive4elements.artifactdatabase.data.StateData; |
105
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
34 |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
35 |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
36 /** |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
37 * An abstract implementation of a {@link State}. It implements some basic |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
38 * methods that return the id, description and data. The methods |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
39 * <code>describe()</code> and <code>setup()</code> depend on the concrete class |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
40 * and need to be implemented by those. |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
41 */ |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
42 public abstract class AbstractState implements State { |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
43 |
106
ece0fdb07975
Implementations to initialize and retrieve states.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
105
diff
changeset
|
44 /** The XPath to the ID of the state relative to the state node in the |
ece0fdb07975
Implementations to initialize and retrieve states.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
105
diff
changeset
|
45 * configuration. */ |
ece0fdb07975
Implementations to initialize and retrieve states.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
105
diff
changeset
|
46 public static final String XPATH_ID = "@id"; |
ece0fdb07975
Implementations to initialize and retrieve states.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
105
diff
changeset
|
47 |
ece0fdb07975
Implementations to initialize and retrieve states.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
105
diff
changeset
|
48 /** The XPath to the description of the state relative to the state node in |
ece0fdb07975
Implementations to initialize and retrieve states.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
105
diff
changeset
|
49 * the configuration. */ |
ece0fdb07975
Implementations to initialize and retrieve states.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
105
diff
changeset
|
50 public static final String XPATH_DESCRIPTION = "@description"; |
ece0fdb07975
Implementations to initialize and retrieve states.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
105
diff
changeset
|
51 |
386
fd32dc33a24c
Added a method State.getHelpText().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
373
diff
changeset
|
52 /** The XPath that points to the help text.*/ |
fd32dc33a24c
Added a method State.getHelpText().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
373
diff
changeset
|
53 public static final String XPATH_HELP_TEXT = "@helpText"; |
fd32dc33a24c
Added a method State.getHelpText().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
373
diff
changeset
|
54 |
367
6431b7efe240
Cosmetics.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
365
diff
changeset
|
55 /** The XPath to the output nodes of the state configuration. */ |
209
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
56 public static final String XPATH_OUTPUT_MODES = "outputmodes/outputmode"; |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
57 |
226
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
58 /** The XPath to the list of facets relative to the output mode it belongs |
367
6431b7efe240
Cosmetics.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
365
diff
changeset
|
59 * to. */ |
226
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
60 public static final String XPATH_FACETS = "facets/facet"; |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
61 |
468
402cd5464723
${help.url} in states helpText attributes now evaluates to /artifact-database/help-url/text() from configuration.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
425
diff
changeset
|
62 public static final String XPATH_HELP_URL = "/artifact-database/help-url/text()"; |
402cd5464723
${help.url} in states helpText attributes now evaluates to /artifact-database/help-url/text() from configuration.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
425
diff
changeset
|
63 |
402cd5464723
${help.url} in states helpText attributes now evaluates to /artifact-database/help-url/text() from configuration.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
425
diff
changeset
|
64 public static final String HELP_URL = "${help.url}"; |
402cd5464723
${help.url} in states helpText attributes now evaluates to /artifact-database/help-url/text() from configuration.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
425
diff
changeset
|
65 |
226
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
66 |
367
6431b7efe240
Cosmetics.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
365
diff
changeset
|
67 /** The logger that is used in this class. */ |
570 | 68 private static Logger logger = LogManager.getLogger(AbstractState.class); |
226
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
69 |
106
ece0fdb07975
Implementations to initialize and retrieve states.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
105
diff
changeset
|
70 |
105
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
71 /** The ID of the state. */ |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
72 protected String id; |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
73 |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
74 /** The description of the state. */ |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
75 protected String description; |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
76 |
386
fd32dc33a24c
Added a method State.getHelpText().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
373
diff
changeset
|
77 /** The help text for this state.*/ |
fd32dc33a24c
Added a method State.getHelpText().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
373
diff
changeset
|
78 protected String helpText; |
fd32dc33a24c
Added a method State.getHelpText().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
373
diff
changeset
|
79 |
105
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
80 /** The data provided by this state. */ |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
81 protected Map<String, StateData> data; |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
82 |
367
6431b7efe240
Cosmetics.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
365
diff
changeset
|
83 /** A list of output modes which are available for this state. */ |
209
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
84 protected List<Output> outputs; |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
85 |
468
402cd5464723
${help.url} in states helpText attributes now evaluates to /artifact-database/help-url/text() from configuration.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
425
diff
changeset
|
86 private static String helpUrl; |
402cd5464723
${help.url} in states helpText attributes now evaluates to /artifact-database/help-url/text() from configuration.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
425
diff
changeset
|
87 |
105
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
88 |
205
2a9591f76270
Changed the return type of a State's describe() method.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
106
diff
changeset
|
89 public AbstractState() { |
209
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
90 outputs = new ArrayList<Output>(); |
205
2a9591f76270
Changed the return type of a State's describe() method.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
106
diff
changeset
|
91 } |
2a9591f76270
Changed the return type of a State's describe() method.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
106
diff
changeset
|
92 |
468
402cd5464723
${help.url} in states helpText attributes now evaluates to /artifact-database/help-url/text() from configuration.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
425
diff
changeset
|
93 public static synchronized final String getHelpUrl() { |
402cd5464723
${help.url} in states helpText attributes now evaluates to /artifact-database/help-url/text() from configuration.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
425
diff
changeset
|
94 if (helpUrl == null) { |
402cd5464723
${help.url} in states helpText attributes now evaluates to /artifact-database/help-url/text() from configuration.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
425
diff
changeset
|
95 helpUrl = Config.getStringXPath(XPATH_HELP_URL, HELP_URL); |
402cd5464723
${help.url} in states helpText attributes now evaluates to /artifact-database/help-url/text() from configuration.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
425
diff
changeset
|
96 } |
402cd5464723
${help.url} in states helpText attributes now evaluates to /artifact-database/help-url/text() from configuration.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
425
diff
changeset
|
97 return helpUrl; |
402cd5464723
${help.url} in states helpText attributes now evaluates to /artifact-database/help-url/text() from configuration.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
425
diff
changeset
|
98 } |
402cd5464723
${help.url} in states helpText attributes now evaluates to /artifact-database/help-url/text() from configuration.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
425
diff
changeset
|
99 |
402cd5464723
${help.url} in states helpText attributes now evaluates to /artifact-database/help-url/text() from configuration.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
425
diff
changeset
|
100 public static String replaceHelpUrl(String string) { |
402cd5464723
${help.url} in states helpText attributes now evaluates to /artifact-database/help-url/text() from configuration.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
425
diff
changeset
|
101 return string.replace(HELP_URL, getHelpUrl()); |
402cd5464723
${help.url} in states helpText attributes now evaluates to /artifact-database/help-url/text() from configuration.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
425
diff
changeset
|
102 } |
402cd5464723
${help.url} in states helpText attributes now evaluates to /artifact-database/help-url/text() from configuration.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
425
diff
changeset
|
103 |
205
2a9591f76270
Changed the return type of a State's describe() method.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
106
diff
changeset
|
104 |
105
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
105 /** |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
106 * The default constructor. |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
107 * |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
108 * @param id The ID of the state. |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
109 * @param description The description of the state. |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
110 */ |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
111 public AbstractState(String id, String description) { |
209
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
112 super(); |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
113 |
105
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
114 this.id = id; |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
115 this.description = description; |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
116 } |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
117 |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
118 |
386
fd32dc33a24c
Added a method State.getHelpText().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
373
diff
changeset
|
119 public AbstractState(String id, String description, String helpText) { |
fd32dc33a24c
Added a method State.getHelpText().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
373
diff
changeset
|
120 this(id, description); |
468
402cd5464723
${help.url} in states helpText attributes now evaluates to /artifact-database/help-url/text() from configuration.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
425
diff
changeset
|
121 this.helpText = replaceHelpUrl(helpText); |
386
fd32dc33a24c
Added a method State.getHelpText().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
373
diff
changeset
|
122 } |
fd32dc33a24c
Added a method State.getHelpText().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
373
diff
changeset
|
123 |
fd32dc33a24c
Added a method State.getHelpText().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
373
diff
changeset
|
124 |
105
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
125 /** |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
126 * Returns the ID of the state. |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
127 * |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
128 * @return the ID of the state. |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
129 */ |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
130 public String getID() { |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
131 return id; |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
132 } |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
133 |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
134 |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
135 /** |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
136 * Set the ID of the state. |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
137 * |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
138 * @param id The ID of the state. |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
139 */ |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
140 public void setID(String id) { |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
141 this.id = id; |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
142 } |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
143 |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
144 |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
145 /** |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
146 * Returns the description of the state. |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
147 * |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
148 * @return the description of the state. |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
149 */ |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
150 public String getDescription() { |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
151 return description; |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
152 } |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
153 |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
154 |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
155 /** |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
156 * Set the description of the state. |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
157 * |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
158 * @param description The description of the state. |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
159 */ |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
160 public void setDescription(String description) { |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
161 this.description = description; |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
162 } |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
163 |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
164 |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
165 /** |
386
fd32dc33a24c
Added a method State.getHelpText().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
373
diff
changeset
|
166 * Returns the help text of this state. |
fd32dc33a24c
Added a method State.getHelpText().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
373
diff
changeset
|
167 * |
fd32dc33a24c
Added a method State.getHelpText().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
373
diff
changeset
|
168 * @return the help text. |
fd32dc33a24c
Added a method State.getHelpText().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
373
diff
changeset
|
169 */ |
fd32dc33a24c
Added a method State.getHelpText().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
373
diff
changeset
|
170 public String getHelpText() { |
fd32dc33a24c
Added a method State.getHelpText().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
373
diff
changeset
|
171 return helpText; |
fd32dc33a24c
Added a method State.getHelpText().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
373
diff
changeset
|
172 } |
fd32dc33a24c
Added a method State.getHelpText().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
373
diff
changeset
|
173 |
fd32dc33a24c
Added a method State.getHelpText().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
373
diff
changeset
|
174 |
fd32dc33a24c
Added a method State.getHelpText().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
373
diff
changeset
|
175 /** |
fd32dc33a24c
Added a method State.getHelpText().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
373
diff
changeset
|
176 * Set the help text for this state. |
fd32dc33a24c
Added a method State.getHelpText().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
373
diff
changeset
|
177 * |
fd32dc33a24c
Added a method State.getHelpText().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
373
diff
changeset
|
178 * @param helpText The help text. |
fd32dc33a24c
Added a method State.getHelpText().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
373
diff
changeset
|
179 */ |
fd32dc33a24c
Added a method State.getHelpText().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
373
diff
changeset
|
180 public void setHelpText(String helpText) { |
468
402cd5464723
${help.url} in states helpText attributes now evaluates to /artifact-database/help-url/text() from configuration.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
425
diff
changeset
|
181 this.helpText = replaceHelpUrl(helpText); |
386
fd32dc33a24c
Added a method State.getHelpText().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
373
diff
changeset
|
182 } |
fd32dc33a24c
Added a method State.getHelpText().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
373
diff
changeset
|
183 |
fd32dc33a24c
Added a method State.getHelpText().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
373
diff
changeset
|
184 |
fd32dc33a24c
Added a method State.getHelpText().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
373
diff
changeset
|
185 /** |
105
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
186 * Returns the data of the state. |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
187 * |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
188 * @return the data of the state. |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
189 */ |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
190 public Map<String, StateData> getData() { |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
191 return data; |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
192 } |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
193 |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
194 |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
195 /** |
256
55d08706ccf2
Added a getData(String) method to a State to get just a single StateData object.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
244
diff
changeset
|
196 * Returns a specific data object of the state. |
55d08706ccf2
Added a getData(String) method to a State to get just a single StateData object.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
244
diff
changeset
|
197 * |
55d08706ccf2
Added a getData(String) method to a State to get just a single StateData object.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
244
diff
changeset
|
198 * @param name The name of the data object. |
55d08706ccf2
Added a getData(String) method to a State to get just a single StateData object.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
244
diff
changeset
|
199 * |
55d08706ccf2
Added a getData(String) method to a State to get just a single StateData object.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
244
diff
changeset
|
200 * @return a data object of the state or null if no such data object exists. |
55d08706ccf2
Added a getData(String) method to a State to get just a single StateData object.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
244
diff
changeset
|
201 */ |
55d08706ccf2
Added a getData(String) method to a State to get just a single StateData object.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
244
diff
changeset
|
202 public StateData getData(String name) { |
373
6072f84608c2
Added modifications to last commit (forgot to commit the modified class).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
367
diff
changeset
|
203 if (data != null) { |
6072f84608c2
Added modifications to last commit (forgot to commit the modified class).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
367
diff
changeset
|
204 return data.get(name); |
6072f84608c2
Added modifications to last commit (forgot to commit the modified class).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
367
diff
changeset
|
205 } |
6072f84608c2
Added modifications to last commit (forgot to commit the modified class).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
367
diff
changeset
|
206 |
6072f84608c2
Added modifications to last commit (forgot to commit the modified class).
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
367
diff
changeset
|
207 return null; |
256
55d08706ccf2
Added a getData(String) method to a State to get just a single StateData object.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
244
diff
changeset
|
208 } |
55d08706ccf2
Added a getData(String) method to a State to get just a single StateData object.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
244
diff
changeset
|
209 |
55d08706ccf2
Added a getData(String) method to a State to get just a single StateData object.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
244
diff
changeset
|
210 |
55d08706ccf2
Added a getData(String) method to a State to get just a single StateData object.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
244
diff
changeset
|
211 /** |
105
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
212 * Add new data to the state. NOTE: If there is already an object existing |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
213 * with the key <i>name</i>, this object is overwritten by the new value. |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
214 * |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
215 * @param name The name of the data object. |
400
f367be55dd35
Doc fixes.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
386
diff
changeset
|
216 * @param data The data object. |
105
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
217 */ |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
218 public void addData(String name, StateData data) { |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
219 if (this.data == null) { |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
220 this.data = new HashMap<String, StateData>(); |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
221 } |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
222 |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
223 this.data.put(name, data); |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
224 } |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
225 |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
226 |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
227 /** |
209
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
228 * Returns the list of possible outputs of this state. The list is empty |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
229 * if no output is available for this state. |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
230 * |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
231 * @return a list of possible outputs of this state. |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
232 */ |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
233 public List<Output> getOutputs() { |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
234 return outputs; |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
235 } |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
236 |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
237 |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
238 /** |
106
ece0fdb07975
Implementations to initialize and retrieve states.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
105
diff
changeset
|
239 * Initialize the state based on the state node in the configuration. |
105
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
240 * |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
241 * @param config The state configuration node. |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
242 */ |
106
ece0fdb07975
Implementations to initialize and retrieve states.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
105
diff
changeset
|
243 public void setup(Node config) { |
226
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
244 logger.info("AbstractState.setup"); |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
245 |
106
ece0fdb07975
Implementations to initialize and retrieve states.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
105
diff
changeset
|
246 id = (String) XMLUtils.xpath(config, XPATH_ID, XPathConstants.STRING); |
ece0fdb07975
Implementations to initialize and retrieve states.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
105
diff
changeset
|
247 |
ece0fdb07975
Implementations to initialize and retrieve states.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
105
diff
changeset
|
248 description = (String) XMLUtils.xpath( |
ece0fdb07975
Implementations to initialize and retrieve states.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
105
diff
changeset
|
249 config, XPATH_DESCRIPTION, XPathConstants.STRING); |
209
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
250 |
386
fd32dc33a24c
Added a method State.getHelpText().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
373
diff
changeset
|
251 helpText = (String) XMLUtils.xpath( |
fd32dc33a24c
Added a method State.getHelpText().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
373
diff
changeset
|
252 config, XPATH_HELP_TEXT, XPathConstants.STRING); |
fd32dc33a24c
Added a method State.getHelpText().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
373
diff
changeset
|
253 |
468
402cd5464723
${help.url} in states helpText attributes now evaluates to /artifact-database/help-url/text() from configuration.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
425
diff
changeset
|
254 if (helpUrl != null) { |
402cd5464723
${help.url} in states helpText attributes now evaluates to /artifact-database/help-url/text() from configuration.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
425
diff
changeset
|
255 helpUrl = replaceHelpUrl(helpUrl); |
402cd5464723
${help.url} in states helpText attributes now evaluates to /artifact-database/help-url/text() from configuration.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
425
diff
changeset
|
256 } |
402cd5464723
${help.url} in states helpText attributes now evaluates to /artifact-database/help-url/text() from configuration.
Sascha L. Teichmann <teichmann@intevation.de>
parents:
425
diff
changeset
|
257 |
209
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
258 setupOutputs(config); |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
259 } |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
260 |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
261 |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
262 /** |
363
4d3298295a64
Enhanced the State interface with a new method initialize() which might be used to initialize the State based on a model Artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
327
diff
changeset
|
263 * This default implementation does nothing at all. |
365
81ae7948bff0
Added the owner Artifact as parameter to State.initialize().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
363
diff
changeset
|
264 * |
81ae7948bff0
Added the owner Artifact as parameter to State.initialize().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
363
diff
changeset
|
265 * @param orig |
81ae7948bff0
Added the owner Artifact as parameter to State.initialize().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
363
diff
changeset
|
266 * @param owner |
81ae7948bff0
Added the owner Artifact as parameter to State.initialize().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
363
diff
changeset
|
267 * @param context |
81ae7948bff0
Added the owner Artifact as parameter to State.initialize().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
363
diff
changeset
|
268 * @param callMeta |
363
4d3298295a64
Enhanced the State interface with a new method initialize() which might be used to initialize the State based on a model Artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
327
diff
changeset
|
269 */ |
365
81ae7948bff0
Added the owner Artifact as parameter to State.initialize().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
363
diff
changeset
|
270 public void initialize( |
81ae7948bff0
Added the owner Artifact as parameter to State.initialize().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
363
diff
changeset
|
271 Artifact orig, |
81ae7948bff0
Added the owner Artifact as parameter to State.initialize().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
363
diff
changeset
|
272 Artifact owner, |
81ae7948bff0
Added the owner Artifact as parameter to State.initialize().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
363
diff
changeset
|
273 Object context, |
81ae7948bff0
Added the owner Artifact as parameter to State.initialize().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
363
diff
changeset
|
274 CallMeta callMeta |
81ae7948bff0
Added the owner Artifact as parameter to State.initialize().
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
363
diff
changeset
|
275 ) { |
363
4d3298295a64
Enhanced the State interface with a new method initialize() which might be used to initialize the State based on a model Artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
327
diff
changeset
|
276 // do nothing. |
4d3298295a64
Enhanced the State interface with a new method initialize() which might be used to initialize the State based on a model Artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
327
diff
changeset
|
277 } |
4d3298295a64
Enhanced the State interface with a new method initialize() which might be used to initialize the State based on a model Artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
327
diff
changeset
|
278 |
4d3298295a64
Enhanced the State interface with a new method initialize() which might be used to initialize the State based on a model Artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
327
diff
changeset
|
279 |
4d3298295a64
Enhanced the State interface with a new method initialize() which might be used to initialize the State based on a model Artifact.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
327
diff
changeset
|
280 /** |
209
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
281 * This method tries reading the available output nodes configured in the |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
282 * state configuration and adds possible Outputs to the outputs list. |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
283 * |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
284 * @param config The state configuration node. |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
285 */ |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
286 protected void setupOutputs(Node config) { |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
287 NodeList outs = (NodeList) XMLUtils.xpath( |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
288 config, |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
289 XPATH_OUTPUT_MODES, |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
290 XPathConstants.NODESET, |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
291 ArtifactNamespaceContext.INSTANCE); |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
292 |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
293 if (outs == null || outs.getLength() == 0) { |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
294 return; |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
295 } |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
296 |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
297 int size = outs.getLength(); |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
298 |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
299 for (int i = 0; i < size; i++) { |
425
ad74e1ba88ba
Allow to add Output objects to a state manually
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
400
diff
changeset
|
300 addOutput(buildOutput(outs.item(i))); |
209
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
301 } |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
302 } |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
303 |
425
ad74e1ba88ba
Allow to add Output objects to a state manually
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
400
diff
changeset
|
304 /** |
ad74e1ba88ba
Allow to add Output objects to a state manually
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
400
diff
changeset
|
305 * This methods allows subclasses to manually add outputs |
ad74e1ba88ba
Allow to add Output objects to a state manually
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
400
diff
changeset
|
306 * |
ad74e1ba88ba
Allow to add Output objects to a state manually
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
400
diff
changeset
|
307 * @param out The output to add |
ad74e1ba88ba
Allow to add Output objects to a state manually
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
400
diff
changeset
|
308 */ |
ad74e1ba88ba
Allow to add Output objects to a state manually
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
400
diff
changeset
|
309 protected void addOutput(Output out) { |
ad74e1ba88ba
Allow to add Output objects to a state manually
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
400
diff
changeset
|
310 outputs.add(out); |
ad74e1ba88ba
Allow to add Output objects to a state manually
Bjoern Ricks <bjoern.ricks@intevation.de>
parents:
400
diff
changeset
|
311 } |
209
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
312 |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
313 /** |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
314 * A helper method that creates an Output object based on the <i>out</i> |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
315 * node. |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
316 * |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
317 * @param out The output node configuration. |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
318 * |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
319 * @return an Output object. |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
320 */ |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
321 protected Output buildOutput(Node out) { |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
322 String name = XMLUtils.xpathString( |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
323 out, "@name", ArtifactNamespaceContext.INSTANCE); |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
324 |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
325 String desc = XMLUtils.xpathString( |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
326 out, "@description", ArtifactNamespaceContext.INSTANCE); |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
327 |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
328 String mimetype = XMLUtils.xpathString( |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
329 out, "@mime-type", ArtifactNamespaceContext.INSTANCE); |
1a3fb29b8b2e
Enhanced the abstract state: the output modes are read now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
205
diff
changeset
|
330 |
290
995fa6994480
Outputs can have a member variable 'type' that should make it easier to distinguish the type of an Output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
256
diff
changeset
|
331 String type = XMLUtils.xpathString( |
995fa6994480
Outputs can have a member variable 'type' that should make it easier to distinguish the type of an Output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
256
diff
changeset
|
332 out, "@type", ArtifactNamespaceContext.INSTANCE); |
995fa6994480
Outputs can have a member variable 'type' that should make it easier to distinguish the type of an Output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
256
diff
changeset
|
333 |
226
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
334 if (name == null) { |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
335 return null; |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
336 } |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
337 |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
338 NodeList facets = (NodeList) XMLUtils.xpath( |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
339 out, |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
340 XPATH_FACETS, |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
341 XPathConstants.NODESET, |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
342 ArtifactNamespaceContext.INSTANCE); |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
343 |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
344 if (facets == null || facets.getLength() == 0) { |
290
995fa6994480
Outputs can have a member variable 'type' that should make it easier to distinguish the type of an Output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
256
diff
changeset
|
345 return new DefaultOutput(name, desc, mimetype, type); |
226
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
346 } |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
347 |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
348 int num = facets.getLength(); |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
349 |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
350 List<Facet> facetList = new ArrayList<Facet>(num); |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
351 |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
352 for (int i = 0; i < num; i++) { |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
353 Facet facet = buildFacet(facets.item(i)); |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
354 |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
355 if (facet != null) { |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
356 facetList.add(facet); |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
357 } |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
358 } |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
359 |
290
995fa6994480
Outputs can have a member variable 'type' that should make it easier to distinguish the type of an Output.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
256
diff
changeset
|
360 return new DefaultOutput(name, desc, mimetype, facetList, type); |
226
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
361 } |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
362 |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
363 |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
364 /** |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
365 * A helper method that creates a Facet object based on the <i>facet</i> |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
366 * node. |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
367 * |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
368 * @param facet The facet node. |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
369 * |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
370 * @return a Facet object or null if no valid Facet was found. |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
371 */ |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
372 protected Facet buildFacet(Node facet) { |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
373 String name = XMLUtils.xpathString( |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
374 facet, "@name", ArtifactNamespaceContext.INSTANCE); |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
375 |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
376 String desc = XMLUtils.xpathString( |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
377 facet, "@description", ArtifactNamespaceContext.INSTANCE); |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
378 |
41404961c804
Added support for facets - facets of output modes are read from configuration now.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
209
diff
changeset
|
379 return name != null ? new DefaultFacet(name, desc) : null; |
106
ece0fdb07975
Implementations to initialize and retrieve states.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
105
diff
changeset
|
380 } |
105
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
381 |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
382 |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
383 /** |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
384 * Describes the UI of the state. This method needs to be implemented by |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
385 * concrete subclasses. |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
386 * |
244
3d14fe6e05f7
Improved the describe() of a State - a reference to an artifact has been added.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
226
diff
changeset
|
387 * @param artifact A reference to the artifact this state belongs to. |
105
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
388 * @param document Describe doucment. |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
389 * @param rootNode Parent node for all new elements. |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
390 * @param context The CallContext. |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
391 * @param uuid The uuid of an artifact. |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
392 */ |
205
2a9591f76270
Changed the return type of a State's describe() method.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
106
diff
changeset
|
393 public abstract Element describe( |
244
3d14fe6e05f7
Improved the describe() of a State - a reference to an artifact has been added.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
226
diff
changeset
|
394 Artifact artifact, |
105
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
395 Document document, |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
396 Node rootNode, |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
397 CallContext context, |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
398 String uuid |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
399 ); |
327
8a3ddd374dd1
Enhanced the State interface with an endOfLife() method.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
290
diff
changeset
|
400 |
8a3ddd374dd1
Enhanced the State interface with an endOfLife() method.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
290
diff
changeset
|
401 |
8a3ddd374dd1
Enhanced the State interface with an endOfLife() method.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
290
diff
changeset
|
402 @Override |
8a3ddd374dd1
Enhanced the State interface with an endOfLife() method.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
290
diff
changeset
|
403 public void endOfLife(Artifact artifact, Object context) { |
8a3ddd374dd1
Enhanced the State interface with an endOfLife() method.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
290
diff
changeset
|
404 // nothing to do here |
8a3ddd374dd1
Enhanced the State interface with an endOfLife() method.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
290
diff
changeset
|
405 } |
105
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
406 } |
265f150f4f7f
Added an abstract implementation of a State.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff
changeset
|
407 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf-8 : |