javax.media.jai
Interface CollectionImageFactory

public interface CollectionImageFactory

The CollectionImageFactory (CIF) interface is intended to be implemented by classes that wish to act as factories to produce different collection image operators. In JAI, the create() method will be invoked in a chain of CollectionOps when the operation is being executed in rendered mode.

Method Summary

CollectionImage	create(ParameterBlock args, RenderingHints hints) Creates a CollectionImage that represents the result of an operation (or chain of operations) for a given ParameterBlock and RenderingHints.
CollectionImage	update(ParameterBlock oldParamBlock, RenderingHints oldHints, ParameterBlock newParamBlock, RenderingHints newHints, CollectionImage oldRendering, CollectionOp op) Attempts to modify a rendered CollectionImage previously created by this CollectionImageFactory as a function of how the sources, parameters and hints of the operation have changed.

Method Detail

create

public CollectionImage create(ParameterBlock args,
                              RenderingHints hints)

Creates a CollectionImage that represents the result of an operation (or chain of operations) for a given ParameterBlock and RenderingHints. If the operation is unable to handle the input arguments, this method should return null.

Generally this method is expected to be invoked by an operation being executed in rendered mode.

Parameters:

args - Input arguments to the operation, including sources and/or parameters.

hints - The rendering hints.

Returns:

A CollectionImage containing the desired output.

update

public CollectionImage update(ParameterBlock oldParamBlock,
                              RenderingHints oldHints,
                              ParameterBlock newParamBlock,
                              RenderingHints newHints,
                              CollectionImage oldRendering,
                              CollectionOp op)

Attempts to modify a rendered CollectionImage previously created by this CollectionImageFactory as a function of how the sources, parameters and hints of the operation have changed. The CollectionImage passed in should not be modified in place but some or or all of its contents may be copied by reference into the CollectionImage returned, if any. If none of the contents of the old CollectionImage can be re-used, then null should be returned.

Returns:

A CollectionImage modified according to the new values of the ParameterBlock and RenderingHints or null if it is impracticable to perform the update.

Throws:

IllegalArgumentException - if the name of the operation associated with the CollectionOp does not match that expected by this CollectionImageFactory.

Since:

JAI 1.1