| org.apache.cocoon.generation.AbstractGenerator
 org.apache.cocoon.generation.ServiceableGenerator
org.apache.cocoon.generation.TraversableGenerator
org.apache.cocoon.generation.TraversableSourceDescriptionGenerator
| TraversableSourceDescriptionGenerator | | public class TraversableSourceDescriptionGenerator extends TraversableGenerator (Code) | | This Generator augments the output of the TraversableGenerator.
It adds:
- version information if the Source implements VersionableSource.
- locking information if the Source implements Lockablesource.
- permission information if the Source implements RestrictableSource.
- and describes its SourceProperties if the Source implements InspectableSource.
Sitemap parameters that can be specified to control processing are:
version (true)
whether to generate versioning information.locking (true)
whether to generate locking information.permission (true)
whether to generate permission information.properties (true)
whether to generate source property information.
author:
Stephan Michels
author:
Unico Hommes
version:
$Id: TraversableSourceDescriptionGenerator.java 433543 2006-08-22 06:22:54Z crossley $ |
| Method Summary | |
| final protected void | addContent(TraversableSource source)
Augments source nodes with additional information. | | public void | pushSourceLocks(LockableSource source)
Push a XML description about all locks of a source. | | protected void | setNodeAttributes(TraversableSource source)
Augments source node elements with additional attributes describing the Source. | | public void | setup(SourceResolver resolver, Map objectModel, String location, Parameters parameters)
Set the SourceResolver, objectModel Map,
the source and sitemap Parameters used to process the request. |
| MIME_TYPE_ATTR_NAME | | final protected static String MIME_TYPE_ATTR_NAME(Code) | | |
| addContent | | final protected void addContent(TraversableSource source) throws SAXException, ProcessingException(Code) | | Augments source nodes with additional information.
Parameters:
source - the Source to describe. |
| pushSourceLocks | | public void pushSourceLocks(LockableSource source) throws SAXException, SourceException(Code) | | Push a XML description about all locks of a source.
Parameters:
source - the Source to describe. |
| setNodeAttributes | | protected void setNodeAttributes(TraversableSource source) throws SAXException, ProcessingException(Code) | | Augments source node elements with additional attributes describing the Source.
The additional attributes are a mimeType attribute,
and iff the Source is an instance of VersionableSource and the generator
is configured to output versioning information two attributes:
revision and branch.
Parameters:
source - the Source to describe. |
| setup | | public void setup(SourceResolver resolver, Map objectModel, String location, Parameters parameters) throws ProcessingException, SAXException, IOException(Code) | | Set the SourceResolver, objectModel Map,
the source and sitemap Parameters used to process the request.
Parameters:
resolver - Source Resolver
Parameters:
objectModel - Object model.
Parameters:
location - Location of the source.
Parameters:
parameters - Parameters for the generator. |
| Methods inherited from org.apache.cocoon.generation.TraversableGenerator | protected void addAncestorPath(TraversableSource source, Stack ancestors) throws SAXException, ProcessingException(Code)(Java Doc)
protected void addContent(TraversableSource source) throws SAXException, ProcessingException(Code)(Java Doc)
protected void addPath(TraversableSource source, int depth) throws SAXException, ProcessingException(Code)(Java Doc)
protected void endNode(String nodeName) throws SAXException(Code)(Java Doc)
public void generate() throws SAXException, ProcessingException(Code)(Java Doc)
protected Stack getAncestors(TraversableSource source) throws IOException(Code)(Java Doc)
public Serializable getKey()(Code)(Java Doc)
public SourceValidity getValidity()(Code)(Java Doc)
protected boolean isExcluded(TraversableSource source)(Code)(Java Doc)
protected boolean isIncluded(TraversableSource source)(Code)(Java Doc)
protected boolean isRoot(TraversableSource source)(Code)(Java Doc)
public void recycle()(Code)(Java Doc)
protected void setNodeAttributes(TraversableSource source) throws SAXException, ProcessingException(Code)(Java Doc)
public void setup(SourceResolver resolver, Map objectModel, String src, Parameters par) throws ProcessingException, SAXException, IOException(Code)(Java Doc)
protected void startNode(String nodeName, TraversableSource source) throws SAXException, ProcessingException(Code)(Java Doc)
|
| Fields inherited from org.apache.cocoon.generation.ServiceableGenerator | protected ServiceManager manager(Code)(Java Doc)
|
| Methods inherited from org.apache.cocoon.generation.ServiceableGenerator | public void dispose()(Code)(Java Doc)
public void service(ServiceManager manager) throws ServiceException(Code)(Java Doc)
|
|
|