org.jmage.filter
Class ConfigurableImageFilter

java.lang.Object
  org.jmage.filter.ConfigurableImageFilter

All Implemented Interfaces:

ImageFilter

Direct Known Subclasses:

BicubicResizeFilter, BorderExtenderFilter, BrightenFilter, ColorizeFilter, CropFilter, ExtendingRotationFilter, NonExtendingRotationFilter, NoOpFilter, RGB2GreyScaleConverterFilter, TextOverlayFilter, TwinResourceImageFilter

public abstract class ConfigurableImageFilter
extends java.lang.Object
implements ImageFilter

ConfigurableImageFilter accepts and maintains Properties

Field Summary

protected java.util.Properties	filterProperties
protected static java.lang.String	INITIALIZED
protected static java.lang.String	NOT_INITIALIZED

Constructor Summary

ConfigurableImageFilter()

Method Summary

javax.media.jai.PlanarImage	filter(javax.media.jai.PlanarImage image, java.util.Properties imageProperties) Filter the image with additional properties
java.util.Properties	getFilterProperties() Gets the Filter's properties.
abstract void	initialize(java.util.Properties filterProperties) Initializes the ImageFilter with properties
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jmage.filter.ImageFilter

filter

Field Detail

filterProperties

protected java.util.Properties filterProperties

INITIALIZED

protected static java.lang.String INITIALIZED

NOT_INITIALIZED

protected static java.lang.String NOT_INITIALIZED

Constructor Detail

ConfigurableImageFilter

public ConfigurableImageFilter()

Method Detail

initialize

public abstract void initialize(java.util.Properties filterProperties)
                         throws FilterException

Initializes the ImageFilter with properties

Parameters:

filterProperties -

Throws:

FilterException - if the filter can't handle the properties.

filter

public javax.media.jai.PlanarImage filter(javax.media.jai.PlanarImage image,
                                          java.util.Properties imageProperties)
                                   throws FilterException

Filter the image with additional properties

Parameters:

image - the image

imageProperties - additional imageProperties used only during this filter call

Returns:

the filtered image

Throws:

FilterException

getFilterProperties

public java.util.Properties getFilterProperties()

Gets the Filter's properties.

Returns:

the properties

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object