com.hp.ucmdb.api.view.foldingdefinition

Interface FoldingDefinition

@NotFinalAPI
public interface FoldingDefinition

This class defines a set of folding rules which can be used to fold a topology into a nodes tree (folded topology). This folding is done using rules from a FoldingDefinitionNode forest (which roots are accessible by roots()). The forest defines how to fold the view, each node creating zero or more layers under the relevant parent in the view result tree.

Note: only nodes created with the factory of this instance (retrieved nodesFactory()) can be added to this folding definition.

//todo: add usage examples

Since:

UCMDB 9.0

See Also:

Query, View, FoldingDefinitionNode

Method Summary

Modifier and Type	Method and Description
<FDN extends FoldingDefinitionNode> FDN	addRoot(FDN foldingDefinitionNode) Appends a new root to the folding definition roots list as the last item.
<FDN extends FoldingDefinitionNode> FDN	addRoot(FDN foldingDefinitionNode, int index) Inserts a new root to the folding definition roots list at the location specified by index.
String	name() Returns the name of the view that holds this folding definition.
FoldingDefinitionNode	nodeByName(String name) Returns a node from the folding definition tree by name.
Collection<QueryNodeBasedFDN>	nodesByQueryNodeName(String queryNodeName) Returns a collection of all the QueryNodeBasedFDN that rely on the given query node name (QueryNodeBasedFDN.queryNodeName().equals(queryNodeName))
FoldingDefinitionNodesFactory	nodesFactory() Returns the nodes factory associated with this definition.
boolean	removeNode(String name) Removes a node (by node name) from the folding definition, removing all referencing grouping nodes, view attributes and sorting rules.
List<? extends FoldingDefinitionNode>	roots() Returns the root nodes defining the folder definition tree.
FoldingDefinitionUtils	utils() Returns a utilities object.

Method Detail

name

String name()

Returns the name of the view that holds this folding definition.

roots

List<? extends FoldingDefinitionNode> roots()

Returns the root nodes defining the folder definition tree.

addRoot

<FDN extends FoldingDefinitionNode> FDN addRoot(FDN foldingDefinitionNode)

Appends a new root to the folding definition roots list as the last item.

Returns:

the added folding definition node (the new root).

See Also:

for creating nodes

addRoot

<FDN extends FoldingDefinitionNode> FDN addRoot(FDN foldingDefinitionNode,
                                                int index)

Inserts a new root to the folding definition roots list at the location specified by index.

Returns:

the added folding definition node (the new root).

See Also:

for creating nodes

nodeByName

FoldingDefinitionNode nodeByName(String name)

Returns a node from the folding definition tree by name.

nodesByQueryNodeName

@NotFinalAPI
Collection<QueryNodeBasedFDN> nodesByQueryNodeName(String queryNodeName)

Returns a collection of all the QueryNodeBasedFDN that rely on the given query node name (QueryNodeBasedFDN.queryNodeName().equals(queryNodeName))

Parameters:

queryNodeName - this method will return QueryNodeBasedFDN referencing this name.

Returns:

a collection of QueryNodeBasedFDNs that refer to the given name, or an empty collection if none was found.

removeNode

@NotFinalAPI
boolean removeNode(String name)

Removes a node (by node name) from the folding definition, removing all referencing grouping nodes, view attributes and sorting rules.

Parameters:

name - the name of the node to remove.

Returns:

true if a removal was done, false if a node by the given name was not found.

nodesFactory

FoldingDefinitionNodesFactory nodesFactory()

Returns the nodes factory associated with this definition. Only nodes created by this factory can be added to this folding definition.

utils

FoldingDefinitionUtils utils()

Returns a utilities object.