| org.apache.cocoon.components.source.impl.AbstractConfigurableSourceInspector
All known Subclasses: org.apache.cocoon.components.source.impl.AbstractConfigurableSourceDescriptor,
| AbstractConfigurableSourceInspector | | abstract public class AbstractConfigurableSourceInspector extends AbstractLogEnabled implements SourceInspector,Configurable(Code) | | Abstract base class for SourceInspectors that want to
configure the set of properties they handle beforehand.
Knowing which properties an inspector handles beforehand
greatly improves property management performance.
author:
Unico Hommes |
| Method Summary | |
| public void | configure(Configuration configuration)
Configure this source inspector to handle properties of required types. | | abstract protected SourceProperty | doGetSourceProperty(Source source, String ns, String name)
Do the actual work of getting the requested SourceProperty for the given Source. | | final protected Set | getPropertyTypes()
Provide subclasses access to the set of configured properties. | | public SourceProperty[] | getSourceProperties(Source source)
Iterates over the configured set of properties to handle,
for each property calls doGetSourceProperty(),
and returns the list of properties thus obtained. | | final public SourceProperty | getSourceProperty(Source source, String namespace, String name)
Checks if this inspector is configured to handle the requested property
and if so forwards the call to doGetSourceProperty. | | final public boolean | handlesProperty(String namespace, String name)
Check if this inspector is configured to handle properties of
the given type. |
| AbstractConfigurableSourceInspector | | public AbstractConfigurableSourceInspector()(Code) | | |
| configure | | public void configure(Configuration configuration) throws ConfigurationException(Code) | | Configure this source inspector to handle properties of required types.
Configuration is in the form of a set of property elements as follows:
<property name="owner" namespace="meta">
|
| doGetSourceProperty | | abstract protected SourceProperty doGetSourceProperty(Source source, String ns, String name) throws SourceException(Code) | | Do the actual work of getting the requested SourceProperty for the given Source.
|
| getPropertyTypes | | final protected Set getPropertyTypes()(Code) | | Provide subclasses access to the set of configured properties.
|
| getSourceProperties | | public SourceProperty[] getSourceProperties(Source source) throws SourceException(Code) | | Iterates over the configured set of properties to handle,
for each property calls doGetSourceProperty(),
and returns the list of properties thus obtained. Subclasses
may want to overide this behavior to improve performance.
|
| getSourceProperty | | final public SourceProperty getSourceProperty(Source source, String namespace, String name) throws SourceException(Code) | | Checks if this inspector is configured to handle the requested property
and if so forwards the call to doGetSourceProperty.
|
| handlesProperty | | final public boolean handlesProperty(String namespace, String name)(Code) | | Check if this inspector is configured to handle properties of
the given type.
|
|
|