| java.lang.Object
 javax.media.jai.registry.CIFRegistry
| CIFRegistry | | final public class CIFRegistry (Code) | | Utility class to provide type-safe interaction with the
OperationRegistry for CollectionImageFactory
objects.
If the OperationRegistry is null, then
JAI.getDefaultInstance().getOperationRegistry() will be used.
since:
JAI 1.1 |
| Method Summary | |
| public static void | clearPreferences(OperationRegistry registry, String operationName, String productName)
Removes all preferences between CIFs within a product registered
under a particular OperationDescriptor. | | public static CollectionImage | create(OperationRegistry registry, String operationName, ParameterBlock paramBlock, RenderingHints renderHints)
Constructs a CollectionImageFactory (usually a
CollectionOp) representing the results of applying
a given operation to a particular ParameterBlock and rendering
hints. | | public static CollectionImageFactory | get(OperationRegistry registry, String operationName)
Returns the the most preferred CollectionImageFactory
object registered against the operation name. | | public static Iterator | getIterator(OperationRegistry registry, String operationName)
Returns an Iterator over all
CollectionImageFactory objects registered under the
operation name over all products. | | public static List | getOrderedList(OperationRegistry registry, String operationName, String productName)
Returns a list of the CIFs of a product registered under a
particular OperationDescriptor, in an ordering
that satisfies all of the pairwise preferences that have
been set. | | public static PropertySource | getPropertySource(CollectionOp op)
Constructs and returns a PropertySource suitable for
use by a given CollectionOp. | | public static void | register(OperationRegistry registry, String operationName, String productName, CollectionImageFactory cif)
Register a CIF with a particular product and operation
against a specified mode. | | public static void | setPreference(OperationRegistry registry, String operationName, String productName, CollectionImageFactory preferredCIF, CollectionImageFactory otherCIF)
Sets a preference between two cifs for a given operation under a
specified product. | | public static void | unregister(OperationRegistry registry, String operationName, String productName, CollectionImageFactory cif)
Unregister a CIF previously registered with a product
and operation against the specified mode. | | public static void | unsetPreference(OperationRegistry registry, String operationName, String productName, CollectionImageFactory preferredCIF, CollectionImageFactory otherCIF)
Unsets a preference between two cifs for a given operation under
a specified product. |
| clearPreferences | | public static void clearPreferences(OperationRegistry registry, String operationName, String productName)(Code) | | Removes all preferences between CIFs within a product registered
under a particular OperationDescriptor.
Parameters:
registry - the OperationRegistry to use.if this is null, then JAI.getDefaultInstance().getOperationRegistry()will be used.
Parameters:
operationName - the operation name as a String
Parameters:
productName - the product name as a String
throws:
IllegalArgumentException - if operationName or productNameis null
throws:
IllegalArgumentException - if there is no OperationDescriptor registered againstthe operationName |
| create | | public static CollectionImage create(OperationRegistry registry, String operationName, ParameterBlock paramBlock, RenderingHints renderHints)(Code) | | Constructs a CollectionImageFactory (usually a
CollectionOp) representing the results of applying
a given operation to a particular ParameterBlock and rendering
hints. The registry is used to determine the CIF to be used to
instantiate the operation.
If none of the CIFs registered with this
OperationRegistry returns a non-null value, null is
returned. Exceptions thrown by the CIFs will be caught by this
method and will not be propagated.
Parameters:
registry - the OperationRegistry to use.if this is null, then JAI.getDefaultInstance().getOperationRegistry()will be used.
Parameters:
operationName - the operation name as a String
Parameters:
paramBlock - the operation's ParameterBlock.
Parameters:
renderHints - a RenderingHints objectcontaining rendering hints.
throws:
IllegalArgumentException - if operationName is null
throws:
IllegalArgumentException - if there is no OperationDescriptor registered againstthe operationName |
| get | | public static CollectionImageFactory get(OperationRegistry registry, String operationName)(Code) | | Returns the the most preferred CollectionImageFactory
object registered against the operation name. This
method will return the first object that would be
encountered by the Iterator returned by the
getIterator() method.
Parameters:
registry - the OperationRegistry to use.if this is null, then JAI.getDefaultInstance().getOperationRegistry()will be used.
Parameters:
operationName - the operation name as a String a registered CollectionImageFactory object
throws:
IllegalArgumentException - if operationName is null
throws:
IllegalArgumentException - if there is no OperationDescriptor registered againstthe operationName |
| getIterator | | public static Iterator getIterator(OperationRegistry registry, String operationName)(Code) | | Returns an Iterator over all
CollectionImageFactory objects registered under the
operation name over all products. The order of objects in
the iteration will be according to the pairwise preferences
among products and image factories within a product. The
remove() method of the Iterator
may not be implemented.
Parameters:
registry - the OperationRegistry to use.if this is null, then JAI.getDefaultInstance().getOperationRegistry()will be used.
Parameters:
operationName - the operation name as a String an Iterator over CollectionImageFactory objects
throws:
IllegalArgumentException - if operationName is null
throws:
IllegalArgumentException - if there is no OperationDescriptor registered againstthe operationName
since:
JAI 1.1 |
| getOrderedList | | public static List getOrderedList(OperationRegistry registry, String operationName, String productName)(Code) | | Returns a list of the CIFs of a product registered under a
particular OperationDescriptor, in an ordering
that satisfies all of the pairwise preferences that have
been set. Returns null if cycles exist. Returns
null, if the product does not exist under this
operationName.
Parameters:
registry - the OperationRegistry to use.if this is null, then JAI.getDefaultInstance().getOperationRegistry()will be used.
Parameters:
operationName - the operation name as a String
Parameters:
productName - the product name as a String an ordered List of CIFs
throws:
IllegalArgumentException - if operationName or productNameis null
throws:
IllegalArgumentException - if there is no OperationDescriptor registered againstthe operationName |
| getPropertySource | | public static PropertySource getPropertySource(CollectionOp op)(Code) | | Constructs and returns a PropertySource suitable for
use by a given CollectionOp. The
PropertySource includes properties copied from prior
nodes as well as those generated at the node itself. Additionally,
property suppression is taken into account. The actual implementation
of getPropertySource() may make use of deferred
execution and caching.
Parameters:
op - the CollectionOp requesting its PropertySource.
throws:
IllegalArgumentException - if op is null
throws:
IllegalArgumentException - if op.isRenderable()returns true |
| register | | public static void register(OperationRegistry registry, String operationName, String productName, CollectionImageFactory cif)(Code) | | Register a CIF with a particular product and operation
against a specified mode. This is JAI 1.0.x equivalent
of registry.registerCIF(...)
Parameters:
registry - the OperationRegistry to register with.if this is null, then JAI.getDefaultInstance().getOperationRegistry()will be used.
Parameters:
operationName - the operation name as a String
Parameters:
productName - the product name as a String
Parameters:
cif - the CollectionImageFactory to be registered
throws:
IllegalArgumentException - if operationName, productName,or cif is null
throws:
IllegalArgumentException - if there is no OperationDescriptor registered againstthe operationName |
| setPreference | | public static void setPreference(OperationRegistry registry, String operationName, String productName, CollectionImageFactory preferredCIF, CollectionImageFactory otherCIF)(Code) | | Sets a preference between two cifs for a given operation under a
specified product.
Parameters:
registry - the OperationRegistry to use.if this is null, then JAI.getDefaultInstance().getOperationRegistry()will be used.
Parameters:
operationName - the operation name as a String
Parameters:
productName - the product name as a String
Parameters:
preferredCIF - the preferred cif
Parameters:
otherCIF - the other cif
throws:
IllegalArgumentException - if operationName, productName,preferredCIF or otherCIF is null
throws:
IllegalArgumentException - if there is no OperationDescriptor registered againstthe operationName
throws:
IllegalArgumentException - if either of the cifswere not previously registered againstoperationName and productName |
| unregister | | public static void unregister(OperationRegistry registry, String operationName, String productName, CollectionImageFactory cif)(Code) | | Unregister a CIF previously registered with a product
and operation against the specified mode.
Parameters:
registry - the OperationRegistry to unregister from.if this is null, then JAI.getDefaultInstance().getOperationRegistry()will be used.
Parameters:
operationName - the operation name as a String
Parameters:
productName - the product name as a String
Parameters:
cif - the CollectionImageFactory to be unregistered
throws:
IllegalArgumentException - if operationName, productName,or cif is null
throws:
IllegalArgumentException - if there is no OperationDescriptor registered againstthe operationName
throws:
IllegalArgumentException - if the cif was not previouslyregistered against operationName and productName |
| unsetPreference | | public static void unsetPreference(OperationRegistry registry, String operationName, String productName, CollectionImageFactory preferredCIF, CollectionImageFactory otherCIF)(Code) | | Unsets a preference between two cifs for a given operation under
a specified product.
Parameters:
registry - the OperationRegistry to use.if this is null, then JAI.getDefaultInstance().getOperationRegistry()will be used.
Parameters:
operationName - the operation name as a String
Parameters:
productName - the product name as a String
Parameters:
preferredCIF - the factory object formerly preferred
Parameters:
otherCIF - the other factory object
throws:
IllegalArgumentException - if operationName, productName,preferredCIF or otherCIF is null
throws:
IllegalArgumentException - if there is no OperationDescriptor registered againstthe operationName
throws:
IllegalArgumentException - if either of the cifswere not previously registered againstoperationName and productName |
|
|