Mercurial > dive4elements > river
changeset 7676:da412a6c4f39
Cosmetics, doc.
author | Felix Wolfsteller <felix.wolfsteller@intevation.de> |
---|---|
date | Mon, 09 Dec 2013 10:31:24 +0100 |
parents | 7e4c5bd86227 |
children | 36e28ec7ff16 |
files | artifacts/src/main/java/org/dive4elements/river/artifacts/D4EArtifact.java |
diffstat | 1 files changed, 10 insertions(+), 9 deletions(-) [+] |
line wrap: on
line diff
--- a/artifacts/src/main/java/org/dive4elements/river/artifacts/D4EArtifact.java Mon Dec 09 09:56:01 2013 +0100 +++ b/artifacts/src/main/java/org/dive4elements/river/artifacts/D4EArtifact.java Mon Dec 09 10:31:24 2013 +0100 @@ -118,8 +118,10 @@ */ protected Map<String, List<Facet>> filterFacets; + /** To which out this artifacts facets are bound by default. */ private String boundToOut; + /** * Interface to a global facet filter. */ @@ -1297,7 +1299,7 @@ } /** If we use a facet filter that bases the list of compatible facets - * on the output this artifact is bound to then this returns true */ + * on the output this artifact is bound to then return true. */ public boolean usesOutputGlobalFacetFilter() { if (boundToOut == null || boundToOut.isEmpty()) { return false; @@ -1310,8 +1312,9 @@ return facetFilter != null; } - /** If a global facet filter and a bounded out are defined - * use them to eliminate unwished facets. + /** + * If a global facet filter and a bounded out are defined + * use them to eliminate unwished facets. */ protected List<Facet> applyGlobalFilterFacets(List<Facet> facets) { if (!usesOutputGlobalFacetFilter()) { @@ -1433,7 +1436,7 @@ /** - * Like compute, but identify State by it id (string). + * Like compute, but identify State by its id (string). */ public Object compute( CallContext context, @@ -1526,9 +1529,7 @@ } /** - * Sets the facets for an ID - * - * Normally the id is a state ID. + * Sets the facets for an ID, which is normally a state ID. * * @param id ID to map the facets to * @param facets List of facets to be stored @@ -1655,7 +1656,7 @@ } /** - * Return the Facets which a state provides + * Return the Facets which a state provides. * @param stateid String that identifies the state * @return List of Facets belonging to the state identifier */ @@ -1668,7 +1669,7 @@ } /** - * Binds this artifact and all its facet to an out + * Binds this artifact and all its facet to an out. */ public void setBoundToOut(String out) { boundToOut = out;