Package org.exoplatform.portal.mop.navigation

Class GenericScope

java.lang.Object

org.exoplatform.portal.mop.navigation.GenericScope

public class GenericScope
extends Object

Flexible scope implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GenericScope.Branch
static class	GenericScope.Tree

Constructor Summary

Constructors

Constructor	Description
GenericScope()

Method Summary

Modifier and Type	Method	Description
static Scope	branchShape(String[] path)
static Scope	branchShape(String[] path, Scope federated)
static Scope	branchShape(List<String> path)
static Scope	branchShape(List<String> path, Scope federated)	A scope with the shape of a tree branch following the rules: the first node with depth 0 will have all of its children visited any node above the root node that fits in the path array will be matched only if the node name matches the corresponding value in the path array.
static Scope	treeShape(int height)

Methods inherited from class java.lang.Object

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

Constructor Details

GenericScope

public GenericScope()

Method Details

branchShape

public static Scope branchShape(List<String> path,
 Scope federated)
                         throws NullPointerException

A scope with the shape of a tree branch following the rules:

• the first node with depth 0 will have all of its children visited
• any node above the root node that fits in the path array will be matched only if the node name matches the corresponding value in the path array. The last node whose depth is equals to the path list size will have its visit mode value delegated to the federated scope argument with a depth of 0 and the same other arguments, any other node will have all of its children visited.
• any other node will have its visit mode delegated to the federated scope argument with the same arguments except the depth that will be subtracted the path list argument size.

Parameters:

path - the names that describing the tree path

federated - the federated scope

Returns:

the branch shape scope

Throws:

NullPointerException - if any argument is null

branchShape

public static Scope branchShape(String[] path,
 Scope federated)

branchShape

public static Scope branchShape(List<String> path)

branchShape

public static Scope branchShape(String[] path)

treeShape

public static Scope treeShape(int height)