Mercurial > dive4elements > river
view flys-artifacts/src/main/java/de/intevation/flys/artifacts/AnnotationArtifact.java @ 4418:e0a355d0c771
FixationArtifact: In doc, mention where the FacetActivity is registered.
author | Felix Wolfsteller <felix.wolfsteller@intevation.de> |
---|---|
date | Tue, 06 Nov 2012 09:04:07 +0100 |
parents | e47559908acc |
children | a2735a4bf75e |
line wrap: on
line source
package de.intevation.flys.artifacts; import java.util.ArrayList; import java.util.List; import org.w3c.dom.Document; import org.w3c.dom.Element; import org.apache.log4j.Logger; import de.intevation.artifacts.Artifact; import de.intevation.artifacts.ArtifactFactory; import de.intevation.artifacts.ArtifactNamespaceContext; import de.intevation.artifacts.CallContext; import de.intevation.artifacts.CallMeta; import de.intevation.artifactdatabase.ProtocolUtils; import de.intevation.artifactdatabase.state.Facet; import de.intevation.artifactdatabase.state.FacetActivity; import de.intevation.artifactdatabase.state.Output; import de.intevation.artifactdatabase.state.State; import de.intevation.artifactdatabase.state.StateEngine; import de.intevation.flys.artifacts.model.FacetTypes; import de.intevation.artifacts.common.utils.XMLUtils; import de.intevation.flys.artifacts.states.DefaultState; import de.intevation.flys.artifacts.context.FLYSContext; import de.intevation.flys.utils.FLYSUtils; /** * Artifact to access names of Points Of Interest along a segment of a river. */ public class AnnotationArtifact extends StaticFLYSArtifact implements FacetTypes { /** The logger for this class. */ private static Logger logger = Logger.getLogger(AnnotationArtifact.class); /** The name of the artifact. */ public static final String ARTIFACT_NAME = "annotation"; // Let Annotations enter life inactively if in Fix Analysis LS setting. static { FacetActivity.Registry.getInstance().register( "annotation", new FacetActivity() { @Override public Boolean isInitialActive( Artifact artifact, Facet facet, String output ) { if (output.contains(FacetTypes.ChartType.FLSC.toString())) { // Longitudinal section chart String name = facet.getName(); if (name.contains(FacetTypes.LONGITUDINAL_ANNOTATION)) { return Boolean.FALSE; } } return Boolean.TRUE; } }); } @Override public void setup( String identifier, ArtifactFactory factory, Object context, CallMeta callMeta, Document data) { logger.debug("AnnotationArtifact.setup"); String filter = StaticFLYSArtifact.getDatacageIDValue(data); String[] splits = filter.split(":"); if (splits.length > 1) { addStringData("nameFilter", splits[1]); } super.setup(identifier, factory, context, callMeta, data); } /** Get river, setup Facets. */ @Override protected void initialize(Artifact artifact, Object context, CallMeta meta) { logger.debug("AnnotationArtifact.initialize, id: " + artifact.identifier()); FLYSArtifact flys = (FLYSArtifact) artifact; // TODO issue880: make annotations available _per type_ importData(flys, "river"); List<Facet> fs = new ArrayList<Facet>(); // TODO Add CallMeta (duplicate TODO in RiverAxisArtifact.java). DefaultState state = (DefaultState) getCurrentState(context); state.computeInit(this, hash(), context, meta, fs); if (!fs.isEmpty()) { logger.debug("Facets to add in AnnotationsArtifact.initialize ."); facets.put(getCurrentStateId(), fs); } else { logger.debug("No facets to add in AnnotationsArtifact.initialize ."); } } /** Shortcut to nameFilter-data (TODO: move to respective Access). */ public String getFilterName() { return getDataAsString("nameFilter"); } public double[] getDistance() { /** TODO In initialize(), access maximal range of river (via * AnnotationFactory) instead of overriding getDistance, * important for diagram generation. */ return new double[] {0f, 1000f}; } /** * Create the description of this AnnotationArtifact-instance. * * @param data Some data. * @param context The CallContext. * * @return the description of this artifact. */ @Override public Document describe(Document data, CallContext context) { logger.debug("Describe: the current state is: " + getCurrentStateId()); if (logger.isDebugEnabled()) { dumpArtifact(); } Document description = XMLUtils.newDocument(); XMLUtils.ElementCreator creator = new XMLUtils.ElementCreator( description, ArtifactNamespaceContext.NAMESPACE_URI, ArtifactNamespaceContext.NAMESPACE_PREFIX); Element root = ProtocolUtils.createRootNode(creator); description.appendChild(root); State current = getCurrentState(context); ProtocolUtils.appendDescribeHeader(creator, root, identifier(), hash()); ProtocolUtils.appendState(creator, root, current); Element name = ProtocolUtils.createArtNode( creator, "name", new String[] { "value" }, new String[] { getName() }); Element outs = ProtocolUtils.createArtNode( creator, "outputmodes", null, null); appendOutputModes(description, outs, context); root.appendChild(name); root.appendChild(outs); return description; } /** * Returns the name of the concrete artifact. * * @return the name of the concrete artifact. */ public String getName() { return ARTIFACT_NAME; } /** * Append outputmode elements to given document. * * @param doc Document to add outputmodes to. * @param outs Element to add outputmode elements to. * @param context The given CallContext (mostly for internationalization). */ //@Override protected void appendOutputModes( Document doc, Element outs, CallContext context) { List<String> stateIds = getPreviousStateIds(); FLYSContext flysContext = FLYSUtils.getFlysContext(context); StateEngine engine = (StateEngine) flysContext.get( FLYSContext.STATE_ENGINE_KEY); for (String stateId: stateIds) { logger.debug("Append output modes for state: " + stateId); DefaultState state = (DefaultState) engine.getState(stateId); List<Output> list = state.getOutputs(); if (list == null || list.isEmpty()) { logger.debug("-> No output modes for this state."); continue; } List<Facet> fs = facets.get(stateId); if (fs == null || fs.isEmpty()) { logger.debug("No facets found."); continue; } logger.debug("Found " + fs.size() + " facets in previous states."); List<Output> generated = generateOutputs(list, fs); ProtocolUtils.appendOutputModes(doc, outs, generated); } try { DefaultState cur = (DefaultState) getCurrentState(context); if (cur.validate(this)) { List<Output> list = cur.getOutputs(); if (list != null && list.size() > 0) { logger.debug( "Append output modes for state: " + cur.getID()); List<Facet> fs = facets.get(cur.getID()); if (fs != null && fs.size() > 0) { List<Output> generated = generateOutputs(list, fs); logger.debug("Found " + fs.size() + " current facets."); if (!generated.isEmpty()) { ProtocolUtils.appendOutputModes( doc, outs, generated); } else{ logger.debug("Cannot append output to generated document."); } } else { logger.debug("No facets found for the current state."); } } } } catch (IllegalArgumentException iae) { // state is not valid, so we do not append its outputs. } } } // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :