javax.media.jai.remote
Interface RemoteRenderedImage

All Superinterfaces:
RenderedImage
All Known Implementing Classes:
PlanarImageServerProxy, RemoteRenderedOp

public interface RemoteRenderedImage
extends RenderedImage

RemoteRenderedImage is an interface commonly used to represent objects which contain or can produce image data in the form of Rasters from locations that are remote. The image data may be stored/produced as a single tile or a regular array of tiles.

This class is the remote equivalent of the RenderedImage interface and adds methods that deal with the remote location aspect of the image.

Since:
JAI 1.1
See Also:
RenderedImage

Method Summary
 NegotiableCapability getNegotiatedValue(String category)
          Returns the results of the negotiation process for the given category.
 NegotiableCapabilitySet getNegotiatedValues()
          Returns the results of the negotiation process.
 NegotiableCapabilitySet getNegotiationPreferences()
          Returns the current negotiation preferences or null, if none were set previously.
 int getNumRetries()
          Returns the number of retries.
 String getProtocolName()
          Returns the String that identifies the remote imaging protocol.
 int getRetryInterval()
          Returns the amount of time between retries in milliseconds.
 String getServerName()
          Returns the String that identifies the server.
 void setNegotiationPreferences(NegotiableCapabilitySet preferences)
          Sets the preferences to be used in the client-server communication.
 void setNumRetries(int numRetries)
          Sets the number of retries.
 void setRetryInterval(int retryInterval)
          Sets the amount of time between retries in milliseconds.
 void setServerNegotiatedValues(NegotiableCapabilitySet negotiatedValues)
          Informs the server of the negotiated values that are the result of a successful negotiation.
 
Methods inherited from interface java.awt.image.RenderedImage
copyData, getColorModel, getData, getData, getHeight, getMinTileX, getMinTileY, getMinX, getMinY, getNumXTiles, getNumYTiles, getProperty, getPropertyNames, getSampleModel, getSources, getTile, getTileGridXOffset, getTileGridYOffset, getTileHeight, getTileWidth, getWidth
 

Method Detail

getServerName

public String getServerName()
Returns the String that identifies the server.


getProtocolName

public String getProtocolName()
Returns the String that identifies the remote imaging protocol.


getRetryInterval

public int getRetryInterval()
Returns the amount of time between retries in milliseconds.


setRetryInterval

public void setRetryInterval(int retryInterval)
Sets the amount of time between retries in milliseconds.

Parameters:
retryInterval - The amount of time (in milliseconds) to wait between retries.
Throws:
IllegalArgumentException - if retryInterval is negative.

getNumRetries

public int getNumRetries()
Returns the number of retries.


setNumRetries

public void setNumRetries(int numRetries)
Sets the number of retries.

Parameters:
numRetries - The number of times an operation should be retried in case of a network error.
Throws:
IllegalArgumentException - if numRetries is negative.

getNegotiationPreferences

public NegotiableCapabilitySet getNegotiationPreferences()
Returns the current negotiation preferences or null, if none were set previously.


setNegotiationPreferences

public void setNegotiationPreferences(NegotiableCapabilitySet preferences)
Sets the preferences to be used in the client-server communication. These preferences are utilized in the negotiation process. Note that preferences for more than one category can be specified using this method. Also each preference can be a list of values in decreasing order of preference, each value specified as a NegotiableCapability. The NegotiableCapability first (for a particular category) in this list is given highest priority in the negotiation process (for that category).

It may be noted that this method allows for multiple negotiation cycles. Everytime this method is called, new preferences are specified for the negotiation, which can be utilized to perform a new round of negotiation to produce new negotiated values to be used in the remote communication.

Parameters:
preferences - The preferences to be used in the negotiation process.
Throws:
IllegalArgumentException - if preferences is null.

getNegotiatedValues

public NegotiableCapabilitySet getNegotiatedValues()
                                            throws RemoteImagingException
Returns the results of the negotiation process. This will return null if no negotiation preferences were set, and no negotiation was performed, or if the negotiation failed.

Throws:
RemoteImagingException

getNegotiatedValue

public NegotiableCapability getNegotiatedValue(String category)
                                        throws RemoteImagingException
Returns the results of the negotiation process for the given category. This will return null if no negotiation preferences were set, and no negotiation was performed, or if the negotiation failed.

Throws:
IllegalArgumentException - if category is null.
RemoteImagingException

setServerNegotiatedValues

public void setServerNegotiatedValues(NegotiableCapabilitySet negotiatedValues)
                               throws RemoteImagingException
Informs the server of the negotiated values that are the result of a successful negotiation.

Parameters:
negotiatedValues - The result of the negotiation.
Throws:
RemoteImagingException