view artifacts/src/main/java/org/dive4elements/river/exports/process/DefaultProcessor.java @ 7057:1011a40ee79c generator-refactoring

Add Default Processor implementation and make processors inherit it.
author Andre Heinecke <aheinecke@intevation.de>
date Fri, 20 Sep 2013 09:55:17 +0200
parents
children f9d5020af0af
line wrap: on
line source
/* Copyright (C) 2013 by Bundesanstalt für Gewässerkunde
 * Software engineering by Intevation GmbH
 *
 * This file is Free Software under the GNU AGPL (>=v3)
 * and comes with ABSOLUTELY NO WARRANTY! Check out the
 * documentation coming with Dive4Elements River for details.
 */

package org.dive4elements.river.exports.process;

import org.dive4elements.artifactdatabase.state.ArtifactAndFacet;
import org.dive4elements.river.exports.XYChartGenerator;
import org.dive4elements.river.themes.ThemeDocument;

/** Dummy implementation for the Processor interface.
 */
public class DefaultProcessor implements Processor {

    /**
     * Processes data to generate e.g. a chart.
     *
     * @param generator XYChartGenerator to add output on.
     * @param aandf       The artifact and facet
     * @param theme      The theme that contains styling information.
     * @param visible       The visibility of the curve.
     * @param index        The index of the curve
     */
    public void doOut(
            XYChartGenerator generator,
            ArtifactAndFacet aandf,
            ThemeDocument    theme,
            boolean          visible,
            int              indexu)
    {
        return;
    }

    /**
     * Returns true if the Processor class is able to generate output for a facet type
     *
     * @param facettype Name of the facet type
     * @return true if the facettype can be processed
     */
    public boolean canHandle(String facettype)
    {
        return false;
    }
}

http://dive4elements.wald.intevation.org