javax.media.jai.registry
Class RemoteRIFRegistry

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

public final class RemoteRIFRegistry

extends Object

Utility class to provide type-safe interaction with the OperationRegistry for RemoteRIF objects.

If the OperationRegistry specified as an argument to the methods in this class is null, then JAI.getOperationRegistry() will be used.

Since:

JAI 1.1

Constructor Summary

RemoteRIFRegistry()

Method Summary

static RemoteRenderedImage	create(OperationRegistry registry, String protocolName, String serverName, String operationName, ParameterBlock paramBlock, RenderingHints renderHints) Constructs a RemoteRenderedImage representing the results of remotely applying the given operation to the source(s), and parameters specified in the specified ParameterBlock, using the specified rendering hints.
static RemoteRIF	get(OperationRegistry registry, String protocolName) Returns the RemoteRIF registered under the given protocol name in the specified OperationRegistry.
static void	register(OperationRegistry registry, String protocolName, RemoteRIF rrif) Registers the given RemoteRIF with the given OperationRegistry under the given protocolName.
static void	unregister(OperationRegistry registry, String protocolName, RemoteRIF rrif) Unregisters the given RemoteRIF previously registered under the given protocolName in the given OperationRegistry.

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteRIFRegistry

public RemoteRIFRegistry()

Method Detail

register

public static void register(OperationRegistry registry,
                            String protocolName,
                            RemoteRIF rrif)

Registers the given RemoteRIF with the given OperationRegistry under the given protocolName.

Parameters:

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

protocolName - The protocolName to register the RemoteRIF under.

rrif - The RemoteRIF to register.

Throws:

IllegalArgumentException - if protocolName is null.

IllegalArgumentException - if rrif is null.

IllegalArgumentException - if there is no RemoteDescriptor registered against the given protocolName.

unregister

public static void unregister(OperationRegistry registry,
                              String protocolName,
                              RemoteRIF rrif)

Unregisters the given RemoteRIF previously registered under the given protocolName in the given OperationRegistry.

Parameters:

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

protocolName - The protocolName to unregister the RemoteRIF from under.

rrif - The RemoteRIF to unregister.

Throws:

IllegalArgumentException - if protocolName is null.

IllegalArgumentException - if rrif is null.

IllegalArgumentException - if there is no RemoteDescriptor registered against the given protocolName.

IllegalArgumentException - if the rrif was not previously registered against protocolName.

get

public static RemoteRIF get(OperationRegistry registry,
                            String protocolName)

Returns the RemoteRIF registered under the given protocol name in the specified OperationRegistry.

Parameters:

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

protocolName - The name of the remote imaging protocol.

Throws:

IllegalArgumentException - if protocolName is null.

IllegalArgumentException - if there is no RemoteDescriptor registered against the given protocolName.

create

public static RemoteRenderedImage create(OperationRegistry registry,
                                         String protocolName,
                                         String serverName,
                                         String operationName,
                                         ParameterBlock paramBlock,
                                         RenderingHints renderHints)

Constructs a RemoteRenderedImage representing the results of remotely applying the given operation to the source(s), and parameters specified in the specified ParameterBlock, using the specified rendering hints. The registry is used to determine the RemoteRIF to be used to instantiate the operation.

Since this class is a simple type-safe wrapper around OperationRegistry's type-unsafe methods, no additional argument validation is performed in this method. Thus errors/exceptions may occur if incorrect values are provided for the input arguments. If argument validation is desired as part of creating a rendering, RemoteJAI.create() may be used instead.

Exceptions thrown by the RemoteRIFs used to create the rendering will be caught by this method and will not be propagated.

Parameters:

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

protocolName - The protocol to be used for remote imaging.

serverName - The name of the server.

operationName - The name of the operation to be performed remotely.

paramBlock - The ParameterBlock specifying the sources and parameters required for the operation.

renderHints - A RenderingHints object containing rendering hints.

Throws:

IllegalArgumentException - if protocolName is null.

IllegalArgumentException - if there is no RemoteDescriptor registered against the given protocolName.