comparison gnv-artifacts/src/main/java/de/intevation/gnv/raster/Filter.java @ 801:d766fe2d917a

More javadoc. gnv-artifacts/trunk@883 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Sascha L. Teichmann <sascha.teichmann@intevation.de>
date Tue, 06 Apr 2010 16:53:43 +0000
parents 6cff63d0c434
children f953c9a559d8
comparison
equal deleted inserted replaced
800:db5b04ecb426 801:d766fe2d917a
1 package de.intevation.gnv.raster; 1 package de.intevation.gnv.raster;
2 2
3 import org.w3c.dom.Element; 3 import org.w3c.dom.Element;
4 4
5 /** 5 /**
6 * Interface to model transformations of rasters.
6 * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a> 7 * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a>
7 */ 8 */
8 public interface Filter 9 public interface Filter
9 { 10 {
11 /**
12 * Allows the creation of filters parameterized from XML elements.
13 */
10 public interface Factory { 14 public interface Factory {
11 15
16 /**
17 * Setup the factory with a given XML element.
18 * @param element
19 */
12 void init(Element element); 20 void init(Element element);
13 21
22 /**
23 * Created a new Filter with this factory.
24 * @return The new created Filter.
25 */
14 Filter create(); 26 Filter create();
15 27
16 } // interface Factory 28 } // interface Factory
17 29
30 /**
31 * Apply this filter to a given raster. The original raster is
32 * unmodified and a new raster is created.
33 * @param raster The original raster.
34 * @return The new raster.
35 */
18 Raster filter(Raster raster); 36 Raster filter(Raster raster);
19 } 37 }
20 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : 38 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :

http://dive4elements.wald.intevation.org