| javax.media.jai.PropertyGenerator
All known Subclasses: javax.media.jai.operator.SubsampleAveragePropertyGenerator, com.sun.media.jai.util.PropertyGeneratorImpl,
| PropertyGenerator | | public interface PropertyGenerator extends Serializable(Code) | | An interface through which properties may be computed dynamically
with respect to an environment of pre-existing properties. In the
interest of simplicity and consistency, a PropertyGenerator
is required to be a pure function; that is, if called multiple times
with the same environment it must produce identical results.
The OperationRegistry class allows
PropertyGenerators to be associated with a particular
operation type, and will automatically insert them into imaging chains
as needed.
Properties are treated in a case-insensitive manner.
See Also: OperationRegistry |
| Method Summary | |
| boolean | canGenerateProperties(Object opNode)
Determines whether the specified Object will
be recognized by getProperty(String,Object). | | Class | getClass(String propertyName)
Returns the class expected to be returned by a request for
the property with the specified name. | | Object | getProperty(String name, Object opNode)
Computes the value of a property relative to an environment
of pre-existing properties. | | Object | getProperty(String name, RenderedOp op)
Computes the value of a property relative to an environment
of pre-existing properties emitted by the sources of
a RenderedOp, and the parameters of that operation.
The operation name, sources, and ParameterBlock
of the RenderedOp being processed may be obtained by
means of the op.getOperationName,
op.getSources(), and op.getParameterBlock()
methods. | | Object | getProperty(String name, RenderableOp op)
Computes the value of a property relative to an environment
of pre-existing properties emitted by the sources of
a RenderableOp, and the parameters of that operation.
The operation name, sources, and ParameterBlock
of the RenderableOp being processed may be obtained by
means of the op.getOperationName,
op.getSources(), and op.getParameterBlock()
methods. | | String[] | getPropertyNames()
Returns an array of Strings naming properties emitted
by this property generator. |
| canGenerateProperties | | boolean canGenerateProperties(Object opNode)(Code) | | Determines whether the specified Object will
be recognized by getProperty(String,Object).
exception:
IllegalArgumentException - if opNodeis null.
since:
JAI 1.1 |
| getClass | | Class getClass(String propertyName)(Code) | | Returns the class expected to be returned by a request for
the property with the specified name. If this information
is unavailable, null will be returned indicating
that getProperty(propertyName).getClass() should
be executed instead. A null value might
be returned for example to prevent generating the value of
a deferred property solely to obtain its class.
The Class expected to be return by arequest for the value of this property or null.
exception:
IllegalArgumentException - if propertyNameis null.
since:
JAI 1.1 |
| getProperty | | Object getProperty(String name, Object opNode)(Code) | | Computes the value of a property relative to an environment
of pre-existing properties. The case of the supplied
String is ignored.
In the case of an OperationNode in a chain of
operations these properties may be emitted by the sources of the
node in a chain or the parameters of that operation. The information
requisite to compute the requested property must be available via the
supplied OperationNode. It is legal to call
getProperty() on the operation's sources.
Parameters:
name - the name of the property, as a String.
Parameters:
op - the Object from which properties willbe generated. the value of the property, as an Object or thevalue java.awt.Image.UndefinedProperty.
exception:
IllegalArgumentException - if name oropNode is null.
exception:
IllegalArgumentException - if opNode isnot an instance of a supported class for this method, i.e.,canGenerateProperties(opNode) returnsfalse.
since:
JAI 1.1 |
| getProperty | | Object getProperty(String name, RenderedOp op)(Code) | | Computes the value of a property relative to an environment
of pre-existing properties emitted by the sources of
a RenderedOp, and the parameters of that operation.
The operation name, sources, and ParameterBlock
of the RenderedOp being processed may be obtained by
means of the op.getOperationName,
op.getSources(), and op.getParameterBlock()
methods. It is legal to call getProperty() on the
operation's sources.
Parameters:
name - the name of the property, as a String.
Parameters:
op - the RenderedOp representing the operation. the value of the property, as an Object or thevalue java.awt.Image.UndefinedProperty.
exception:
IllegalArgumentException - if name orop is null. |
| getProperty | | Object getProperty(String name, RenderableOp op)(Code) | | Computes the value of a property relative to an environment
of pre-existing properties emitted by the sources of
a RenderableOp, and the parameters of that operation.
The operation name, sources, and ParameterBlock
of the RenderableOp being processed may be obtained by
means of the op.getOperationName,
op.getSources(), and op.getParameterBlock()
methods. It is legal to call getProperty() on the
operation's sources.
Parameters:
name - the name of the property, as a String.
Parameters:
op - the RenderableOp representing the operation. the value of the property, as an Object or thevalue java.awt.Image.UndefinedProperty.
exception:
IllegalArgumentException - if name orop is null. |
| getPropertyNames | | String[] getPropertyNames()(Code) | | Returns an array of Strings naming properties emitted
by this property generator. The Strings may contain
characters of any case.
an array of Strings that may be passed as parameternames to the getProperty() method. |
|
|