javax.media.jai
Interface RegistryElementDescriptor

All Known Subinterfaces:

OperationDescriptor, RemoteDescriptor, TileCodecDescriptor

public interface RegistryElementDescriptor

An interface for all JAI descriptors that register themselves with the OperationRegistry. Examples include OperationDescriptor, TileCodecDescriptor, RemoteDescriptor etc.

Since:

JAI 1.1

See Also:

OperationRegistry, RegistryMode

Method Summary

boolean	arePropertiesSupported() Whether this descriptor supports JAI properties.
String	getName() The name this descriptor will be registered under in the OperationRegistry.
ParameterListDescriptor	getParameterListDescriptor(String modeName) Returns the ParameterListDescriptor that describes the associated parameters (not sources).
PropertyGenerator[]	getPropertyGenerators(String modeName) Returns an array of PropertyGenerators implementing the property inheritance for this descriptor.
String[]	getSupportedModes() The registry modes supported by this descriptor.
boolean	isModeSupported(String modeName) Whether this descriptor supports the specified registry mode.

Method Detail

getName

public String getName()

The name this descriptor will be registered under in the OperationRegistry. Individual descriptors implementing this interface will define what this name means in their space. For example this would be "operation name" for OperationDescriptor and "format name" for TileCodecDescriptor etc. The descriptor names are to be treated in a case-insensitive (but retentive) manner.

getSupportedModes

public String[] getSupportedModes()

The registry modes supported by this descriptor. Known modes include those returned by RegistryMode.getModes().

Returns:

an array of Strings specifying the supported modes.

See Also:

RegistryMode

isModeSupported

public boolean isModeSupported(String modeName)

Whether this descriptor supports the specified registry mode. The modeNames are to be treated in a case-insensitive (but retentive) manner.

Parameters:

modeName - the registry mode name

Returns:

true, if the implementation of this descriptor supports the specified mode. false otherwise.

Throws:

IllegalArgumentException - if modeName is null

arePropertiesSupported

public boolean arePropertiesSupported()

Whether this descriptor supports JAI properties.

Returns:

true, if the implementation of this descriptor supports JAI properties. false otherwise.

See Also:

PropertyGenerator

getPropertyGenerators

public PropertyGenerator[] getPropertyGenerators(String modeName)

Returns an array of PropertyGenerators implementing the property inheritance for this descriptor. They may be used as a basis for the descriptor's property management.

Parameters:

modeName - the registry mode name

Returns:

An array of PropertyGenerators, or null if this operation does not have any of its own PropertyGenerators.

Throws:

IllegalArgumentException - if modeName is null or if it is not one of the supported modes.

UnsupportedOperationException - if arePropertiesSupported() returns false

getParameterListDescriptor

public ParameterListDescriptor getParameterListDescriptor(String modeName)

Returns the ParameterListDescriptor that describes the associated parameters (not sources). This method returns null if the specified modeName does not support parameters. If the specified modeName supports parameters but the implementing class does not have parameters, then this method returns a non-null ParameterListDescriptor whose getNumParameters() returns 0.

Parameters:

modeName - the registry mode name.

Throws:

IllegalArgumentException - if modeName is null or if it is not one of the supported modes.