com.day.cq.commons.inherit

Class HierarchyNodeInheritanceValueMap

java.lang.Object

com.day.cq.commons.ValueMapWrapper

com.day.cq.commons.inherit.HierarchyNodeInheritanceValueMap

All Implemented Interfaces:

InheritanceValueMap, java.util.Map<java.lang.String,java.lang.Object>, ValueMap

public class HierarchyNodeInheritanceValueMap
extends ValueMapWrapper
implements InheritanceValueMap

An InheritanceValueMap for a given Resource that will look inside the jcr:content of ancestor hierarchy nodes for inherited values.

Alternatively, if no resource is available and no inheritance is needed, just a ValueMap can be wrapped.

Inheritance implementation

This is to be used inside hierarchy nodes such as pages, that have their inner content stored under jcr:content. First the property is searched inside the current resource under the given name, which behaves exactly like get(String, Class) and ValueMapWrapper.get(String, Object).

For example: /content/parent/page/jcr:content/footer/image/@width.

If not found locally, then the relative path to the next containing jcr:content starting with the current resource is taken, for example footer/image. Then the ancestors will be walked step by step to find parent hierarchy nodes (= parent pages). The property will then be looked up at those parent nodes under the relative path inside their jcr:content nodes.

For example: /content/parent/jcr:content/footer/image/@width.

The first hit will be used.

This does not look inside the page nodes themselves (such as /content/parent) nor in any node without a jcr:content node. It also does not search in parent "components", such as footer/@width in this example.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
HierarchyNodeInheritanceValueMap(Resource resource) Will wrap the ValueMap returned by resource.adaptTo(ValueMap.class), or use an empty map if resource is null or if it doesn't adapt to a ValueMap.
HierarchyNodeInheritanceValueMap(ValueMap map) Use this if the underlying Resource for a ValueMap is not available and no inheritance is needed.

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	get(java.lang.String name, java.lang.Class<T> type) Get a named property and convert it into the given type.
<T> T	getInherited(java.lang.String name, java.lang.Class<T> type) Get a named property and convert it into the given type, and take the properties of parent resources / pages into account, if the property is not found locally.
<T> T	getInherited(java.lang.String name, T defaultValue) Get a named property and convert it into the given type, and take the properties of parent resources / pages into account, if the property is not found locally.
protected static java.lang.String	getInnerPath(Resource resource) Returns the page local path (aka localstruct).
protected static Resource	getNextExistingParent(Resource resource) Returns the next existing ancestor.
protected <T> T	getParentPageValue(java.lang.String innerPath, java.lang.String name, java.lang.Class<T> type)

Methods inherited from class com.day.cq.commons.ValueMapWrapper

clear, containsKey, containsValue, entrySet, get, get, isEmpty, keySet, put, putAll, remove, size, toString, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.sling.api.resource.ValueMap

get

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Constructor Detail

HierarchyNodeInheritanceValueMap

public HierarchyNodeInheritanceValueMap(Resource resource)

Will wrap the ValueMap returned by resource.adaptTo(ValueMap.class), or use an empty map if resource is null or if it doesn't adapt to a ValueMap. The inheritance is internally resolved by fetching the parent resource and wrapping it into an HierarchyNodeInheritanceValueMap as well.

Parameters:

resource - the resource to start from

HierarchyNodeInheritanceValueMap

public HierarchyNodeInheritanceValueMap(ValueMap map)

Use this if the underlying Resource for a ValueMap is not available and no inheritance is needed. Using the inheritance-enabled getter methods will behave exactly like the normal ValueMap getters.

Parameters:

map - a ValueMap to wrap

Method Detail

get

public <T> T get(java.lang.String name,
        java.lang.Class<T> type)

Description copied from interface: ValueMap

Get a named property and convert it into the given type.

Specified by:

get in interface ValueMap

Overrides:

get in class ValueMapWrapper

Parameters:

name - The name of the property

type - The class of the type

Returns:

Return named value converted to type T or null if non existing or can't be converted.

getInherited

public <T> T getInherited(java.lang.String name,
                 java.lang.Class<T> type)

Description copied from interface: InheritanceValueMap

Get a named property and convert it into the given type, and take the properties of parent resources / pages into account, if the property is not found locally.

The exact inheritance mechanism depends on the implementation.

Specified by:

getInherited in interface InheritanceValueMap

Parameters:

name - The name of the property

type - The class of the type

Returns:

Return named value converted to type T or null if non existing or can't be converted.

getInherited

public <T> T getInherited(java.lang.String name,
                 T defaultValue)

Description copied from interface: InheritanceValueMap

Get a named property and convert it into the given type, and take the properties of parent resources / pages into account, if the property is not found locally.

The exact inheritance mechanism depends on the implementation.

Specified by:

getInherited in interface InheritanceValueMap

Parameters:

name - The name of the property

defaultValue - The default value to use if the named property does not exist or cannot be converted to the requested type. The default value is also used to define the type to convert the value to. If this is null any existing property is not converted.

Returns:

Return named value converted to type T or the default value if non existing or can't be converted.

getParentPageValue

protected <T> T getParentPageValue(java.lang.String innerPath,
                       java.lang.String name,
                       java.lang.Class<T> type)

getInnerPath

protected static java.lang.String getInnerPath(Resource resource)

Returns the page local path (aka localstruct). For example: /some/page/jcr:content/par/comp => par/comp

getNextExistingParent

protected static Resource getNextExistingParent(Resource resource)

Returns the next existing ancestor. Normally this is the parent, but if the resource (and one or more of its parents) does not exist, this will walk up the path node by node to find the first existing ancestor. Returns null for the parent of the root "/".