|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object | +--javax.media.jai.remote.RemoteDescriptorImpl
This abstract class provides a partial implementation of the
RemoteDescriptor interface, and is suitable for
subclassing.
RemoteDescriptor| 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 | |
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. |
|
| Method Summary | |
boolean |
arePropertiesSupported()
Returns true, if the implementation of this descriptor supports properties, false otherwise. |
Object |
getInvalidRegion(String registryModeName,
String oldServerName,
ParameterBlock oldParamBlock,
RenderingHints oldHints,
String newServerName,
ParameterBlock newParamBlock,
RenderingHints newHints,
OperationNode node)
Calculates the region over which two distinct remote renderings of an operation may be expected to differ. |
String |
getName()
Returns the name of the remote imaging protocol under which this RemoteDescriptor will be registered in the
OperationRegistry. |
ParameterListDescriptor |
getParameterListDescriptor(String modeName)
The two modes supported by this descriptor are "remoteRendered" and "remoteRenderable". |
PropertyGenerator[] |
getPropertyGenerators(String modeName)
Returns an array of PropertyGenerators implementing
the property inheritance for this descriptor. |
URL |
getServerNameDocs()
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. |
String[] |
getSupportedModes()
The registry modes supported by this descriptor. |
boolean |
isModeSupported(String modeName)
Returns true if the supplied modeName is supported by this descriptor. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface javax.media.jai.remote.RemoteDescriptor |
getServerCapabilities, getServerSupportedOperationList |
| Field Detail |
protected String protocolName
protected URL serverNameDocURL
URL pointing to the documentation regarding
the format of the server name String.| Constructor Detail |
public RemoteDescriptorImpl(String protocolName,
URL serverNameDocURL)
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.
protocolName - The name of the protocol.serverNameDocURL - The URL pointing to server name
format documentation.IllegalArgumentException - if protocolName is null.| Method Detail |
public String getName()
RemoteDescriptor will be registered in the
OperationRegistry.getName in interface RegistryElementDescriptorpublic String[] getSupportedModes()
getSupportedModes in interface RegistryElementDescriptorRegistryModepublic boolean isModeSupported(String modeName)
isModeSupported in interface RegistryElementDescriptormodeName - The mode name to check support for.IllegalArgumentException - if modeName is null.public boolean arePropertiesSupported()
arePropertiesSupported in interface RegistryElementDescriptorPropertyGeneratorpublic PropertyGenerator[] getPropertyGenerators(String modeName)
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.getPropertyGenerators in interface RegistryElementDescriptormodeName - The mode name to get PropertyGenerators
for.PropertyGenerators, or
null if this operation does not have any of
its own PropertyGenerators.IllegalArgumentException - if modeName is null.UnsupportedOperationException - if
arePropertiesSupported() returns falsepublic URL getServerNameDocs()
URL that points to an HTML page containing
instructions on constructing a server name string for the protocol
with which this class is associated.getServerNameDocs in interface RemoteDescriptor
public Object getInvalidRegion(String registryModeName,
String oldServerName,
ParameterBlock oldParamBlock,
RenderingHints oldHints,
String newServerName,
ParameterBlock newParamBlock,
RenderingHints newHints,
OperationNode node)
throws RemoteImagingException
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.
getInvalidRegion in interface RemoteDescriptorregistryModeName - The name of the mode.oldServerName - The previous server name.oldParamBlock - The previous sources and parameters.oldHints - The previous hints.newServerName - The current server name.newParamBlock - The current sources and parameters.newHints - The current hints.node - The affected node in the processing chain.null
if there is no common region of validity. If an empty
java.awt.Shape is returned, this indicates
that all pixels within the bounds of the old rendering
remain valid.IllegalArgumentException - if registryModeName
is null or if the operation requires either
sources or parameters and either oldParamBlock
or newParamBlock is null.IllegalArgumentException - if there is no OperationDescriptor
for the specified operationName on any one or both of the
servers identified by oldServerName and
newServerName, or if the number of sources or
the name, number and Class of the operation's
parameters is not the same on both the servers.IllegalArgumentException - if oldParamBlock or
newParamBlock do not contain sufficient sources
or parameters for the operation in question.public ParameterListDescriptor getParameterListDescriptor(String modeName)
getParameterListDescriptor in interface RegistryElementDescriptormodeName - The mode name to get the
ParameterListDescriptor for.IllegalArgumentException - if modeName is null.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||