javax.media.jai.registry
Class RCIFRegistry

java.lang.Object
  |
  +--javax.media.jai.registry.RCIFRegistry

public final class RCIFRegistry

extends Object

Utility class to provide type-safe interaction with the OperationRegistry for RenderableCollectionImageFactory objects. If the OperationRegistry is null, then JAI.getDefaultInstance().getOperationRegistry() will be used.

Since:

JAI 1.1

See Also:

CollectionImage

Constructor Summary

RCIFRegistry()

Method Summary

static CollectionImage	create(OperationRegistry registry, String operationName, ParameterBlock paramBlock) Creates a renderable CollectionImage given a ParameterBlock containing the operation's sources and parameters.
static RenderableCollectionImageFactory	get(OperationRegistry registry, String operationName) Returns the RenderableCollectionImageFactory object registered against the operation name.
static PropertySource	getPropertySource(CollectionOp op) Constructs and returns a PropertySource suitable for use by a given CollectionOp.
static void	register(OperationRegistry registry, String operationName, RenderableCollectionImageFactory rcif) Register a RCIF with a particular operation against a specified mode.
static void	unregister(OperationRegistry registry, String operationName, RenderableCollectionImageFactory rcif) Unregister a RCIF previously registered with a operation against the specified mode.

Methods inherited from class java.lang.Object

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

Constructor Detail

RCIFRegistry

public RCIFRegistry()

Method Detail

register

public static void register(OperationRegistry registry,
                            String operationName,
                            RenderableCollectionImageFactory rcif)

Register a RCIF with a particular operation against a specified mode.

Parameters:

registry - the OperationRegistry to register with. if this is null, then JAI.getDefaultInstance().getOperationRegistry() will be used.

operationName - the operation name as a String

rcif - the RenderableCollectionImageFactory to be registered

Throws:

IllegalArgumentException - if operationName or rcif is null

IllegalArgumentException - if there is no OperationDescriptor registered against the operationName

unregister

public static void unregister(OperationRegistry registry,
                              String operationName,
                              RenderableCollectionImageFactory rcif)

Unregister a RCIF previously registered with a operation against the specified mode.

Parameters:

registry - the OperationRegistry to unregister from. if this is null, then JAI.getDefaultInstance().getOperationRegistry() will be used.

operationName - the operation name as a String

rcif - the RenderableCollectionImageFactory to be unregistered

Throws:

IllegalArgumentException - if operationName or rcif is null

IllegalArgumentException - if there is no OperationDescriptor registered against the operationName

IllegalArgumentException - if the rcif was not previously registered against operationName

get

public static RenderableCollectionImageFactory get(OperationRegistry registry,
                                                   String operationName)

Returns the RenderableCollectionImageFactory object registered against the operation name.

Parameters:

registry - the OperationRegistry to use. if this is null, then JAI.getDefaultInstance().getOperationRegistry() will be used.

operationName - the operation name as a String

Returns:

a registered RenderableCollectionImageFactory object

Throws:

IllegalArgumentException - if operationName is null

IllegalArgumentException - if there is no OperationDescriptor registered against the operationName

create

public static CollectionImage create(OperationRegistry registry,
                                     String operationName,
                                     ParameterBlock paramBlock)

Creates a renderable CollectionImage given a ParameterBlock containing the operation's sources and parameters. The registry is used to determine the RCIF to be used to instantiate the operation.

Parameters:

registry - the OperationRegistry to use. if this is null, then JAI.getDefaultInstance().getOperationRegistry() will be used.

operationName - the operation name as a String

paramBlock - the operation's ParameterBlock.

Throws:

IllegalArgumentException - if operationName is null

IllegalArgumentException - if there is no OperationDescriptor registered against the operationName

getPropertySource

public static PropertySource getPropertySource(CollectionOp op)

Constructs and returns a PropertySource suitable for use by a given CollectionOp. The PropertySource includes properties copied from prior nodes as well as those generated at the node itself. Additionally, property suppression is taken into account. The actual implementation of getPropertySource() may make use of deferred execution and caching.

Parameters:

op - the CollectionOp requesting its PropertySource.

Throws:

IllegalArgumentException - if op is null

IllegalArgumentException - if op.isRenderable() returns false