org.ametys.plugins.explorer.resources.generators

Class ResourcesExplorerGenerator

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.cocoon.xml.AbstractXMLProducer

org.apache.cocoon.generation.AbstractGenerator

org.apache.cocoon.generation.ServiceableGenerator

org.ametys.plugins.explorer.resources.generators.ResourcesExplorerGenerator

All Implemented Interfaces:

Poolable, Recyclable, Disposable, Component, LogEnabled, Serviceable, Generator, SitemapModelComponent, XMLProducer

Direct Known Subclasses:

ExplorerEntitiesGenerator, ExplorerEntityGenerator, ResourceGenerator, ResourcesExplorerGenerator, ResourcesGenerator, SearchGenerator

public class ResourcesExplorerGenerator
extends ServiceableGenerator

Generates a subtree of ExplorerNode.
The subnodes are SAXed to a depth of 0 by default.

• Depth of -1 means generate all
• 0 means only the given node and its children (resources and folders)
• 1 means the given node, its children and their children, and so on.

Field Summary

Fields

Modifier and Type	Field and Description
protected ExplorerApplicationExtensionPoint	_explorerApplicationEP The explorer application EP
protected AmetysObjectResolver	_resolver The resolver for ametys object
protected UserManager	_userManager The user manager
static String	RESOURCE Constant for resource
static String	RESOURCE_COLLECTION Constant for resource collection

Fields inherited from class org.apache.cocoon.generation.ServiceableGenerator

manager

Fields inherited from class org.apache.cocoon.generation.AbstractGenerator

objectModel, parameters, resolver, source

Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer

contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumer

Fields inherited from interface org.apache.cocoon.generation.Generator

ROLE

Constructor Summary

Constructors

Constructor and Description
ResourcesExplorerGenerator()

Method Summary

Modifier and Type	Method and Description
protected boolean	_matchFilter(Resource resource, String[] allowedExtensions) Determines if the resource matches the allowed extensions
void	generate()
protected void	getAdditionalAttributes(AttributesImpl attrs, Resource resource) Get the additional attributes
protected AttributesImpl	getExplorerNodeAttributes(ExplorerNode node) Returns the attributes corresponding to an Explorer node.
protected AttributesImpl	getResourceAttributes(Resource resource) Returns the attributes corresponding to a Resource.
protected String	getResourcesIconCls(Resource resource) CSS suffix class name getter for the icon resource.
protected void	saxCollection(ExplorerNode node) SAX a ExplorerNode
protected void	saxCollection(ExplorerNode node, boolean saxNode) SAX a ExplorerNode
protected void	saxCollection(ExplorerNode node, boolean saxNode, String nodeTag) SAX a ExplorerNode
protected void	saxCollection(ExplorerNode node, int depth, boolean saxNode, String nodeTag) SAX a ExplorerNode
protected void	saxCollection(ExplorerNode node, int depth, String[] allowedExtensions) SAX a ExplorerNode
protected void	saxExplorerNode(ExplorerNode node, int depth) SAX a ExplorerNode
protected void	saxExplorerNode(ExplorerNode node, int depth, String[] allowedExtensions) SAX a ExplorerNode
protected void	saxResource(Resource resource) SAX a Resource
void	service(ServiceManager sManager)

Methods inherited from class org.apache.cocoon.generation.ServiceableGenerator

dispose

Methods inherited from class org.apache.cocoon.generation.AbstractGenerator

recycle, setup

Methods inherited from class org.apache.cocoon.xml.AbstractXMLProducer

setConsumer, setContentHandler, setLexicalHandler

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.cocoon.xml.XMLProducer

setConsumer

Field Detail

RESOURCE_COLLECTION

public static final String RESOURCE_COLLECTION

Constant for resource collection

See Also:

Constant Field Values

RESOURCE

public static final String RESOURCE

Constant for resource

See Also:

Constant Field Values

_resolver

protected AmetysObjectResolver _resolver

The resolver for ametys object

_userManager

protected UserManager _userManager

The user manager

_explorerApplicationEP

protected ExplorerApplicationExtensionPoint _explorerApplicationEP

The explorer application EP

Constructor Detail

ResourcesExplorerGenerator

public ResourcesExplorerGenerator()

Method Detail

service

public void service(ServiceManager sManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class ServiceableGenerator

Throws:

ServiceException

generate

public void generate()
              throws IOException,
                     SAXException,
                     ProcessingException

Throws:

IOException

SAXException

ProcessingException

saxCollection

protected void saxCollection(ExplorerNode node)
                      throws SAXException

SAX a ExplorerNode

Parameters:

node - The node to sax

Throws:

SAXException - If an error occurred while saxing

saxCollection

protected void saxCollection(ExplorerNode node,
                             boolean saxNode)
                      throws SAXException

SAX a ExplorerNode

Parameters:

node - The node to sax

saxNode - True to wrap the collection with an XML node representing the current node.

Throws:

SAXException - If an error occurred while saxing

saxCollection

protected void saxCollection(ExplorerNode node,
                             boolean saxNode,
                             String nodeTag)
                      throws SAXException

SAX a ExplorerNode

Parameters:

node - The node to sax

saxNode - True to wrap the collection with an XML node representing the current node.

nodeTag - The tag to use

Throws:

SAXException - If an error occurred while saxing

saxCollection

protected void saxCollection(ExplorerNode node,
                             int depth,
                             boolean saxNode,
                             String nodeTag)
                      throws SAXException

SAX a ExplorerNode

Parameters:

node - The node to sax

depth - The recursive depth to sax

saxNode - True to wrap the collection with an XML node representing the current node.

nodeTag - The tag to use

Throws:

SAXException - If an error occurred while saxing

saxCollection

protected void saxCollection(ExplorerNode node,
                             int depth,
                             String[] allowedExtensions)
                      throws SAXException

SAX a ExplorerNode

Parameters:

node - The node to sax

depth - The recursive depth to sax

allowedExtensions - The allowed file extensions (lower-case). Can be null or empty to not filter on file extensions

Throws:

SAXException - If an error occurred while saxing

_matchFilter

protected boolean _matchFilter(Resource resource,
                               String[] allowedExtensions)

Determines if the resource matches the allowed extensions

Parameters:

resource - The resource

allowedExtensions - allowed file extensions

Returns:

true if the allowed extensions are empty or null, or if the resource's name matches the allowed extensions

saxExplorerNode

protected void saxExplorerNode(ExplorerNode node,
                               int depth)
                        throws SAXException

SAX a ExplorerNode

Parameters:

node - The explorer node to SAX.

depth - The recursive depth to sax

Throws:

SAXException - If an error occurred while SAXing

saxExplorerNode

protected void saxExplorerNode(ExplorerNode node,
                               int depth,
                               String[] allowedExtensions)
                        throws SAXException

SAX a ExplorerNode

Parameters:

node - The explorer node to SAX.

depth - The recursive depth to sax

allowedExtensions - allowed file extensions

Throws:

SAXException - If an error occurred while SAXing

getExplorerNodeAttributes

protected AttributesImpl getExplorerNodeAttributes(ExplorerNode node)

Returns the attributes corresponding to an Explorer node.

Parameters:

node - The explorer node to SAX.

Returns:

the attributes

saxResource

protected void saxResource(Resource resource)
                    throws SAXException

SAX a Resource

Parameters:

resource - The resource to SAX

Throws:

SAXException - If an error occurred while SAXing

getResourceAttributes

protected AttributesImpl getResourceAttributes(Resource resource)

Returns the attributes corresponding to a Resource.

Parameters:

resource - The resource to SAX

Returns:

the attributes

getResourcesIconCls

protected String getResourcesIconCls(Resource resource)

CSS suffix class name getter for the icon resource.

Parameters:

resource - The resource

Returns:

The suffix of the css class for the icon of this resource.

getAdditionalAttributes

protected void getAdditionalAttributes(AttributesImpl attrs,
                                       Resource resource)

Get the additional attributes

Parameters:

attrs - The attributes

resource - The resource