| java.lang.Object
 javax.media.jai.remote.RemoteDescriptorImpl
All known Subclasses: javax.media.jai.remote.JAIRMIDescriptor,
| RemoteDescriptorImpl | | abstract public class RemoteDescriptorImpl implements RemoteDescriptor(Code) | | This abstract class provides a partial implementation of the
RemoteDescriptor interface, and is suitable for
subclassing.
See Also: RemoteDescriptor
since:
JAI 1.1 |
| Field Summary | |
| protected String | protocolName
The name of the protocol that this descriptor describes. | | protected URL | serverNameDocURL
The URL pointing to the documentation regarding
the format of the server name String. |
| Constructor Summary | |
| public | RemoteDescriptorImpl(String protocolName, URL serverNameDocURL)
Creates a RemoteDescriptorImpl given the protocol name
and the URL that points to documentation regarding the
format of the server name String. |
| protocolName | | protected String protocolName(Code) | | The name of the protocol that this descriptor describes.
|
| serverNameDocURL | | protected URL serverNameDocURL(Code) | | The URL pointing to the documentation regarding
the format of the server name String.
|
| RemoteDescriptorImpl | | public RemoteDescriptorImpl(String protocolName, URL serverNameDocURL)(Code) | | Creates a RemoteDescriptorImpl given the protocol name
and the URL that points to documentation regarding the
format of the server name String.
While the serverNameDocURL argument is allowed to
be null, this is strongly discouraged, since this URL
is the only description available to the user to help with creating
a serverName String correctly.
Parameters:
protocolName - The name of the protocol.
Parameters:
serverNameDocURL - The URL pointing to server nameformat documentation.
throws:
IllegalArgumentException - if protocolName is null. |
| arePropertiesSupported | | public boolean arePropertiesSupported()(Code) | | Returns true, if the implementation of this descriptor supports
properties, false otherwise. The default implementation in this class
returns false, signifying that no properties are supported independent
of the operations themselves.
See Also: PropertyGenerator |
| getInvalidRegion | | public Object getInvalidRegion(String registryModeName, String oldServerName, ParameterBlock oldParamBlock, RenderingHints oldHints, String newServerName, ParameterBlock newParamBlock, RenderingHints newHints, OperationNode node) throws RemoteImagingException(Code) | | Calculates the region over which two distinct remote renderings
of an operation may be expected to differ. The operation is
represented by the OperationNode argument to this
method. The String that identifies the operation
can be retrieved via the OperationNode's
getOperationName() method.
The class of the returned object will vary as a function of
the nature of the operation. For rendered and renderable two-
dimensional images this should be an instance of a class which
implements java.awt.Shape.
The implementation in this class always returns null as the
invalid region signifying that there is no common region of validity.
Since null is always returned, in the interests of efficiency, none
of the checks for ensuring that the ParameterBlock
arguments passed to this method contain the correct number and
Class of sources and parameters are performed in this
implementation.
Parameters:
registryModeName - The name of the mode.
Parameters:
oldServerName - The previous server name.
Parameters:
oldParamBlock - The previous sources and parameters.
Parameters:
oldHints - The previous hints.
Parameters:
newServerName - The current server name.
Parameters:
newParamBlock - The current sources and parameters.
Parameters:
newHints - The current hints.
Parameters:
node - The affected node in the processing chain. The region over which the data of two renderings of thisoperation may be expected to be invalid or nullif there is no common region of validity. If an emptyjava.awt.Shape is returned, this indicatesthat all pixels within the bounds of the old renderingremain valid.
throws:
IllegalArgumentException - if registryModeNameis null or if the operation requires eithersources or parameters and either oldParamBlockor newParamBlock is null.
throws:
IllegalArgumentException - if there is no OperationDescriptorfor the specified operationName on any one or both of theservers identified by oldServerName andnewServerName, or if the number of sources orthe name, number and Class of the operation'sparameters is not the same on both the servers.
throws:
IllegalArgumentException - if oldParamBlock ornewParamBlock do not contain sufficient sourcesor parameters for the operation in question. |
| getName | | public String getName()(Code) | | Returns the name of the remote imaging protocol under which this
RemoteDescriptor will be registered in the
OperationRegistry.
|
| getParameterListDescriptor | | public ParameterListDescriptor getParameterListDescriptor(String modeName)(Code) | | The two modes supported by this descriptor are "remoteRendered" and
"remoteRenderable". Since neither of these modes supports any
parameters, this default implementation always returns null.
Parameters:
modeName - The mode name to get the ParameterListDescriptor for.
throws:
IllegalArgumentException - if modeName is null. |
| getPropertyGenerators | | public PropertyGenerator[] getPropertyGenerators(String modeName)(Code) | | Returns an array of PropertyGenerators implementing
the property inheritance for this descriptor. Since neither the
"remoteRendered" or "remoteRendered" modes support properties
independent of the operations themselves, the default
implementation throws an UnsupportedOperationException.
Subclasses should override this method if they wish to produce
inherited properties.
Parameters:
modeName - The mode name to get PropertyGeneratorsfor.
throws:
IllegalArgumentException - if modeName is null.
throws:
UnsupportedOperationException - ifarePropertiesSupported() returns false An array of PropertyGenerators, ornull if this operation does not have any ofits own PropertyGenerators. |
| getServerNameDocs | | public URL getServerNameDocs()(Code) | | Returns a URL that points to an HTML page containing
instructions on constructing a server name string for the protocol
with which this class is associated.
|
| getSupportedModes | | public String[] getSupportedModes()(Code) | | The registry modes supported by this descriptor. The default
implementation in this class returns two modes - "remoteRendered"
and "remoteRenderable". If the subclass does not support both
these modes it should override this method to reflect that.
See Also: javax.media.jai.RegistryMode |
| isModeSupported | | public boolean isModeSupported(String modeName)(Code) | | Returns true if the supplied modeName is supported by this
descriptor. The default implementation in this class returns true
only if the supplied modeName is one of either "remoteRendered"
or "remoteRenderable".
Parameters:
modeName - The mode name to check support for. true, if the implementation of this descriptor supportsthe specified mode. false otherwise.
throws:
IllegalArgumentException - if modeName is null. |
|
|