com.adobe.granite.ui.components

Class FilteringResourceWrapper

java.lang.Object

org.apache.sling.api.resource.ResourceWrapper

com.adobe.granite.ui.components.FilteringResourceWrapper

All Implemented Interfaces:

Adaptable, Resource

Direct Known Subclasses:

WCMFilteringResourceWrapper

public class FilteringResourceWrapper
extends ResourceWrapper

A ResourceWrapper that filters its descendant resources based on granite:hide BooleanEL property.

This wrapper needs to be applied to the container resource, such as the page root resource, and the dialog root resource.

It is also smart enough to handle include component. In that case, if the resource type is granite/ui/components/coral/foundation/include, the included resource will also be wrapped by this class, allowing the descendant resources of the included resource to use granite:hide property.

For example given the following content structure:

 
 + /mycontainer
   - sling:resourceType = "my/container"
   + item1
     - sling:resourceType = "my/item"
   + item2
     - sling:resourceType = "my/item"
     - granite:hide = true
   + item3
     - sling:resourceType = "my/item"
   + item4
     - sling:resourceType = "granite/ui/components/coral/foundation/include"
     - path = "/mycontainer2"

 + /mycontainer2
   - sling:resourceType = "my/container2"
   + item1
     - sling:resourceType = "my/item"
   + item2
     - sling:resourceType = "my/item"
     - granite:hide = true
 
 

Assuming that my/container resource type implementation uses FilteringResourceWrapper to wrap its resource (/mycontainer resource), /mycontainer/item2 and /mycontainer2/item2 will be excluded during traversal transparently, as if they are not there in the first place.

Field Summary

Fields inherited from interface org.apache.sling.api.resource.Resource

RESOURCE_TYPE_NON_EXISTING

Constructor Summary

Constructors

Constructor and Description
FilteringResourceWrapper(Resource resource, ExpressionResolver expressionResolver, SlingHttpServletRequest request)

Method Summary

Modifier and Type	Method and Description
Resource	getChild(java.lang.String relPath) Returns the value of calling getChild on the wrapped resource.
java.lang.Iterable<Resource>	getChildren() Returns an iterable of the direct children of this resource.
java.lang.String	getResourceType() Returns the value of calling getResourceType on the wrapped resource.
boolean	hasChildren() Returns the value of calling hasChildren on the wrapped resource.
java.util.Iterator<Resource>	listChildren() Returns the value of calling listChildren on the wrapped resource.

Methods inherited from class org.apache.sling.api.resource.ResourceWrapper

adaptTo, getName, getParent, getPath, getResource, getResourceMetadata, getResourceResolver, getResourceSuperType, getValueMap, isResourceType, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FilteringResourceWrapper

public FilteringResourceWrapper(Resource resource,
                                ExpressionResolver expressionResolver,
                                SlingHttpServletRequest request)

Method Detail

getChild

public Resource getChild(java.lang.String relPath)

Description copied from class: ResourceWrapper

Returns the value of calling getChild on the wrapped resource.

Specified by:

getChild in interface Resource

Overrides:

getChild in class ResourceWrapper

Parameters:

relPath - relative path to the child resource

Returns:

The child resource or null

See Also:

ResourceResolver.getResource(Resource, String)

listChildren

public java.util.Iterator<Resource> listChildren()

Description copied from class: ResourceWrapper

Returns the value of calling listChildren on the wrapped resource.

Specified by:

listChildren in interface Resource

Overrides:

listChildren in class ResourceWrapper

Returns:

An iterator for child resources.

See Also:

ResourceResolver.listChildren(Resource)

getChildren

public java.lang.Iterable<Resource> getChildren()

Description copied from interface: Resource

Returns an iterable of the direct children of this resource.

This method is a convenience and returns exactly the same resources as calling getResourceResolver().getChildren(resource).

Specified by:

getChildren in interface Resource

Overrides:

getChildren in class ResourceWrapper

Returns:

An iterable for child resources

See Also:

Resource.getChildren()

hasChildren

public boolean hasChildren()

Description copied from class: ResourceWrapper

Returns the value of calling hasChildren on the wrapped resource.

Specified by:

hasChildren in interface Resource

Overrides:

hasChildren in class ResourceWrapper

Returns:

true if the resource has any child resources

getResourceType

public java.lang.String getResourceType()

Description copied from class: ResourceWrapper

Returns the value of calling getResourceType on the wrapped resource.

Specified by:

getResourceType in interface Resource

Overrides:

getResourceType in class ResourceWrapper

Returns:

The resource type