com.hp.ucmdb.api.view.foldingdefinition

Interface FoldingDefinitionNode

All Superinterfaces:

SupportsClientProperties<FoldingDefinitionNode>, SupportsInvisibility<FoldingDefinitionNode>

All Known Subinterfaces:

GroupByAttributeSyntheticFDN, GroupByTypeSyntheticFDN, QueryNodeBasedFDN, SyntheticFDN

public interface FoldingDefinitionNode
extends SupportsClientProperties<FoldingDefinitionNode>, SupportsInvisibility<FoldingDefinitionNode>

The base interface for folding definition nodes.

An FDN is responsible for creating and populting a sub-tree in the result tree. The FDN may:

• Do nothing, adding no nodes to the result tree.
• For each result node X from its parent, add trees of result nodes under X

The actual definition of which result nodes to add lies in the extending classes. However, the FDN is urged to consider children order.

Restrictions:

1. Each FDN has a name which must be unique in the FoldingDefinition.
2. FDNs may not be added to create a cycle (if x is a child of y, y cannot be added as a child to x or any ancestor of x).

The FDN is a tree-like structure. However, the order of child nodes evaluation, if they're evaluated at all is determined by the FDN.

Note: Not all folding definition nodes may be placed under all other nodes. See specific rules in the folding definition nodes descriptions.

Since:

UCMDB 9.0

See Also:

FoldingDefinition

Method Summary

Modifier and Type	Method and Description
<FDN extends FoldingDefinitionNode> FDN	addChild(FDN foldingDefinitionNode) Appends a child to this FDN as the last child.
<FDN extends FoldingDefinitionNode> FDN	addChild(FDN foldingDefinitionNode, int index) Inserts a child to this FDN at the index location.
AttributeSortingRule	addSortingRule(String viewAttributeName, AttributeSortingOrderElementDirection direction)
AttributeSortingRule	addSortingRule(ViewAttribute viewAttribute, AttributeSortingOrderElementDirection direction)
ViewAttribute	addViewAttribute(String viewAttributeName, SingleValueDatasource datasource)
QueryNodeBasedFDN	asQueryNodeBasedFDN() Returns this node as a query node based folding definition node.
SyntheticFDN	asSyntheticNode() Returns this node as a synthetic node.
List<? extends FoldingDefinitionNode>	children() The children of this FDN.
FoldingDefinition	definition() The definition holding this node.
String	name() This FDN name.
FoldingDefinitionNode	parent() The parent node of this node, may be null.
FoldingDefinitionNode	root() The root of this FDN branch (the top-most parent).
List<AttributeSortingRule>	sortingRules()
List<ViewAttribute>	viewAttributes()

Methods inherited from interface com.hp.ucmdb.api.util.SupportsClientProperties

clientProperties, clientProperty, usedNamespaces, withClientProperty

Methods inherited from interface com.hp.ucmdb.api.topology.SupportsInvisibility

invisible, isInvisible

Method Detail

children

List<? extends FoldingDefinitionNode> children()

The children of this FDN.

name

String name()

This FDN name.

parent

FoldingDefinitionNode parent()

The parent node of this node, may be null. May not be called before connecting this node to a FoldingDefinition.

root

FoldingDefinitionNode root()

The root of this FDN branch (the top-most parent). May be identical to 'this', may not be null. May not be called before connecting this node to a FoldingDefinition.

definition

FoldingDefinition definition()

The definition holding this node. May not be called before connecting this node to a FoldingDefinition.

asQueryNodeBasedFDN

QueryNodeBasedFDN asQueryNodeBasedFDN()
                               throws ClassCastException

Returns this node as a query node based folding definition node. If this node is not a query node based one, a class cast exception will occur.

Throws:

ClassCastException

asSyntheticNode

SyntheticFDN asSyntheticNode()
                      throws ClassCastException

Returns this node as a synthetic node. If this node is not a synthetic node, a class cast exception will occur.

Throws:

ClassCastException

addChild

<FDN extends FoldingDefinitionNode> FDN addChild(FDN foldingDefinitionNode)

Appends a child to this FDN as the last child.

Returns:

the child just added.

addChild

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

Inserts a child to this FDN at the index location.

Returns:

the child just added.

viewAttributes

@NotFinalAPI
List<ViewAttribute> viewAttributes()

addViewAttribute

@NotFinalAPI
ViewAttribute addViewAttribute(String viewAttributeName,
                                            SingleValueDatasource datasource)

sortingRules

@NotFinalAPI
List<AttributeSortingRule> sortingRules()

addSortingRule

@NotFinalAPI
AttributeSortingRule addSortingRule(String viewAttributeName,
                                                 AttributeSortingOrderElementDirection direction)

addSortingRule

AttributeSortingRule addSortingRule(ViewAttribute viewAttribute,
                                    AttributeSortingOrderElementDirection direction)