org.apache.jackrabbit.oak.plugins.migration

Class FilteringNodeState

java.lang.Object

org.apache.jackrabbit.oak.spi.state.AbstractNodeState

org.apache.jackrabbit.oak.plugins.migration.AbstractDecoratedNodeState

org.apache.jackrabbit.oak.plugins.migration.FilteringNodeState

All Implemented Interfaces:

NodeState

public class FilteringNodeState
extends AbstractDecoratedNodeState

NodeState implementation that decorates another node-state instance in order to hide subtrees or partial subtrees from the consumer of the API.
The set of visible subtrees is defined by two parameters: include paths and exclude paths, both of which are sets of absolute paths.
Any paths that are equal or are descendants of one of the excluded paths are hidden by this implementation.
For all included paths, the direct ancestors, the node-state at the path itself and all descendants are visible. Any siblings of the defined path or its ancestors are implicitly hidden (unless made visible by another include path).
The implementation delegates to the decorated node-state instance and filters out hidden node-states in the following methods:

• AbstractDecoratedNodeState.exists()
• AbstractDecoratedNodeState.hasChildNode(String)
• AbstractDecoratedNodeState.getChildNodeEntries()

Additionally, hidden node-state names are removed from the property :childOrder in the following two methods:

• AbstractDecoratedNodeState.getProperties()
• AbstractDecoratedNodeState.getProperty(String)

Field Summary

Fields

Modifier and Type	Field and Description
static Set<String>	ALL
static Set<String>	NONE

Fields inherited from interface org.apache.jackrabbit.oak.spi.state.NodeState

EXISTS

Method Summary

Modifier and Type	Method and Description
static @NotNull NodeState	wrap(@NotNull String path, @NotNull NodeState delegate, @Nullable Set<String> includePaths, @Nullable Set<String> excludePaths, @Nullable Set<String> fragmentPaths, @Nullable Set<String> excludedFragments) Factory method that conditionally decorates the given node-state iff the node-state is (a) hidden itself or (b) has hidden descendants.

Methods inherited from class org.apache.jackrabbit.oak.plugins.migration.AbstractDecoratedNodeState

builder, compareAgainstBaseState, equals, exists, getChildNode, getChildNodeEntries, getDelegate, getProperties, getProperty, hasChildNode

Methods inherited from class org.apache.jackrabbit.oak.spi.state.AbstractNodeState

checkValidName, compareAgainstBaseState, comparePropertiesAgainstBaseState, equals, getBoolean, getBoolean, getChildNodeCount, getChildNodeNames, getLong, getLong, getName, getName, getNames, getNames, getPropertyCount, getString, getString, getStrings, getStrings, hashCode, hasProperty, isValidName, toString, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

ALL

public static final Set<String> ALL

NONE

public static final Set<String> NONE

Method Detail

wrap

@NotNull
public static @NotNull NodeState wrap(@NotNull
                                               @NotNull String path,
                                               @NotNull
                                               @NotNull NodeState delegate,
                                               @Nullable
                                               @Nullable Set<String> includePaths,
                                               @Nullable
                                               @Nullable Set<String> excludePaths,
                                               @Nullable
                                               @Nullable Set<String> fragmentPaths,
                                               @Nullable
                                               @Nullable Set<String> excludedFragments)

Factory method that conditionally decorates the given node-state iff the node-state is (a) hidden itself or (b) has hidden descendants.

Parameters:

path - The path where the node-state should be assumed to be located.

delegate - The node-state to decorate.

includePaths - A Set of paths that should be visible. Defaults to ["/"] if null.

excludePaths - A Set of paths that should be hidden. Empty if null.

fragmentPaths - A Set of paths that should support the fragments (see below). Empty if null.

excludedFragments - A Set of name fragments that should be hidden. Empty if null.

Returns:

The decorated node-state if required, the original node-state if decoration is unnecessary.