| org.apache.cocoon.components.modules.input.AbstractInputModule
 org.apache.cocoon.components.modules.input.AbstractJXPathModule
org.apache.cocoon.components.modules.input.XMLFileModule
| XMLFileModule | | public class XMLFileModule extends AbstractJXPathModule implements Composable,ThreadSafe(Code) | |
[
]
[
]
This module provides an Input Module interface to any XML document, by using
XPath expressions as attribute keys.
The XML can be obtained from any Cocoon Source (e.g.,
cocoon:/..., context://.., and regular URLs).
Sources can be held in memory for better performance and reloaded if
changed.
Caching and reloading can be turned on / off (default: caching on,
reloading off) through <reloadable>false</reloadable>
and <cacheable>false</cacheable>. The file
(source) to use is specified through <file
src="protocol:path/to/file.xml" reloadable="true"
cacheable="true"/> optionally overriding defaults for
caching and/or reloading.
In addition, xpath expressions are cached for higher performance.
Thus, if an expression has been evaluated for a file, the result
is cached and will be reused, the expression is not evaluated
a second time. This can be turned off using the cache-expressions
configuration option.
author:
Jeff Turner
author:
Christian Haul
version:
$Id: XMLFileModule.java 540711 2007-05-22 19:36:07Z cziegeler $ |
| Inner Class :protected static class DocumentHelper | |
| Method Summary | |
| public void | compose(ComponentManager manager)
Set the current ComponentManager instance used by this
Composable. | | public void | configure(Configuration config)
Static (cocoon.xconf) configuration.
Configuration is expected to be of the form:
<...>
<reloadable>true|false</reloadable>
<cacheable>true|false</cacheable>
<file src="src1" reloadable="true|false" cacheable="true|false"/>
<file src="src2" reloadable="true|false" cacheable="true|false"/>
...
</...>
Each <file/> element pre-loads an XML DOM for querying. | | public void | dispose()
| | protected void | flushCache()
| | public Object | getAttribute(String name, Configuration modeConf, Map objectModel)
| | public Object[] | getAttributeValues(String name, Configuration modeConf, Map objectModel)
| | protected Object | getContextObject(Configuration modeConf, Map objectModel)
Get the DOM object that JXPath will operate on when evaluating
attributes. |
| cacheAll | | boolean cacheAll(Code) | | Default value for cacheability of sources. Defaults to true.
|
| cacheExpressions | | boolean cacheExpressions(Code) | | Default value for cacheability of xpath expressions. Defaults to true.
|
| documents | | Map documents(Code) | | Cached documents
|
| manager | | ComponentManager manager(Code) | | |
| reloadAll | | boolean reloadAll(Code) | | Default value for reloadability of sources. Defaults to false.
|
| resolver | | SourceResolver resolver(Code) | | |
| staticConfLocation | | String staticConfLocation(Code) | | Static (cocoon.xconf) configuration location, for error reporting
|
| compose | | public void compose(ComponentManager manager) throws ComponentException(Code) | | Set the current ComponentManager instance used by this
Composable.
|
| configure | | public void configure(Configuration config) throws ConfigurationException(Code) | | Static (cocoon.xconf) configuration.
Configuration is expected to be of the form:
<...>
<reloadable>true|false</reloadable>
<cacheable>true|false</cacheable>
<file src="src1" reloadable="true|false" cacheable="true|false"/>
<file src="src2" reloadable="true|false" cacheable="true|false"/>
...
</...>
Each <file/> element pre-loads an XML DOM for querying. Typically only one
<file> is specified, and its src is used as a default if not
overridden in the
XMLFileModule.getContextObject(Configuration,Map)
Parameters:
config - a Configuration value, as described above.
exception:
ConfigurationException - if an error occurs |
| dispose | | public void dispose()(Code) | | Dispose this component
|
| flushCache | | protected void flushCache()(Code) | | |
| getAttribute | | public Object getAttribute(String name, Configuration modeConf, Map objectModel) throws ConfigurationException(Code) | | |
| getAttributeValues | | public Object[] getAttributeValues(String name, Configuration modeConf, Map objectModel) throws ConfigurationException(Code) | | |
| getContextObject | | protected Object getContextObject(Configuration modeConf, Map objectModel) throws ConfigurationException(Code) | | Get the DOM object that JXPath will operate on when evaluating
attributes. This DOM is loaded from a Source, specified in the
modeConf, or (if modeConf is null) from the
XMLFileModule.configure(Configuration) .
Parameters:
modeConf - The dynamic configuration for the current operation. Maybe null, in which case static (cocoon.xconf) configurationis used. Configuration is expected to have a <file> child node, andbe of the form:<...><file src="..." reloadable="true|false"/></...>
Parameters:
objectModel - Object Model for the current module operation. |
| Methods inherited from org.apache.cocoon.components.modules.input.AbstractJXPathModule | public void configure(Configuration config) throws ConfigurationException(Code)(Java Doc)
public Object getAttribute(String name, Configuration modeConf, Map objectModel) throws ConfigurationException(Code)(Java Doc)
public Iterator getAttributeNames(Configuration modeConf, Map objectModel) throws ConfigurationException(Code)(Java Doc)
public Object[] getAttributeValues(String name, Configuration modeConf, Map objectModel) throws ConfigurationException(Code)(Java Doc)
abstract protected Object getContextObject(Configuration modeConf, Map objectModel) throws ConfigurationException(Code)(Java Doc)
|
|
|