Mercurial > dive4elements > river
changeset 1704:e8627d1e2db6
Cosmetics, docs.
flys-artifacts/trunk@2948 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author | Felix Wolfsteller <felix.wolfsteller@intevation.de> |
---|---|
date | Wed, 12 Oct 2011 10:59:12 +0000 |
parents | 71d369ab789d |
children | 2c643a643026 |
files | flys-artifacts/ChangeLog flys-artifacts/src/main/java/de/intevation/flys/artifacts/FLYSArtifact.java |
diffstat | 2 files changed, 31 insertions(+), 10 deletions(-) [+] |
line wrap: on
line diff
--- a/flys-artifacts/ChangeLog Wed Oct 12 10:21:59 2011 +0000 +++ b/flys-artifacts/ChangeLog Wed Oct 12 10:59:12 2011 +0000 @@ -1,3 +1,11 @@ +2011-10-12 Felix Wolfsteller <felix.wolfsteller@intevation.de> + + Cosmetics, docs. + + * src/main/java/de/intevation/flys/artifacts/FLYSArtifact.java: + Cosmetics: Space after full stop in commments, slightly improved + documentation, added one debug message. + 2011-10-12 Felix Wolfsteller <felix.wolfsteller@intevation.de> Fix remainder of flys/issue304 (Erweiterte Funktionen W-Differenzen) .
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/FLYSArtifact.java Wed Oct 12 10:21:59 2011 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/FLYSArtifact.java Wed Oct 12 10:59:12 2011 +0000 @@ -59,17 +59,17 @@ */ public abstract class FLYSArtifact extends DefaultArtifact { - /** The logger that is used in this artifact.*/ + /** The logger that is used in this artifact. */ private static Logger logger = Logger.getLogger(FLYSArtifact.class); public static final String COMPUTING_CACHE = "computed.values"; - /** The XPath that points to the input data elements of the FEED document.*/ + /** The XPath that points to the input data elements of the FEED document. */ public static final String XPATH_FEED_INPUT = "/art:action/art:data/art:input"; - /** The XPath that points to the name of the target state of ADVANCE.*/ + /** The XPath that points to the name of the target state of ADVANCE. */ public static final String XPATH_ADVANCE_TARGET = "/art:action/art:target/@art:name"; @@ -79,29 +79,32 @@ public static final String XPATH_FILTER = "/art:action/art:filter/art:out"; - /** The constant string that shows that an operation was successful.*/ + /** The constant string that shows that an operation was successful. */ public static final String OPERATION_SUCCESSFUL = "SUCCESS"; - /** The constant string that shows that an operation failed.*/ + /** The constant string that shows that an operation failed. */ public static final String OPERATION_FAILED = "FAILURE"; /** The identifier of the current state. */ protected String currentStateId; - /** The identifiers of previous states on a stack.*/ + /** The identifiers of previous states on a stack. */ protected List<String> previousStateIds; - /** The name of the artifact.*/ + /** The name of the artifact. */ protected String name; - /** The data that have been inserted into this artifact.*/ + /** The data that have been inserted into this artifact. */ protected Map<String, StateData> data; - /** The list of facets supported by this artifact.*/ + /** The list of facets supported by this artifact. */ protected Map<String, List<Facet>> facets; - /** out -> facets */ + /** + * Used to generates "view" on the facets (hides facets not matching the + * filter in output of collection); out -> facets. + */ protected Map<String, List<Facet>> filterFacets; @@ -236,6 +239,11 @@ // Do not clone filter facets! } + + /** + * Builds filter facets from document. + * @see filterFacets + */ protected Map<String, List<Facet>> buildFilterFacets(Document document) { NodeList nodes = (NodeList)XMLUtils.xpath( @@ -663,6 +671,7 @@ protected List<Output> filterOutputs(List<Output> outs) { if (filterFacets == null || filterFacets.isEmpty()) { + logger.debug("No filter for Outputs."); return outs; } @@ -825,6 +834,10 @@ return compute(context, hash, current, type, generateFacets); } + + /** + * Like compute, but identify State by it id (string). + */ public Object compute( CallContext context, String hash,