com.hp.ucmdb.api.view.foldingdefinition

Interface QueryNodeBasedFDN

All Superinterfaces:

FoldingDefinitionNode, SupportsClientProperties<FoldingDefinitionNode>, SupportsInvisibility<FoldingDefinitionNode>

public interface QueryNodeBasedFDN
extends FoldingDefinitionNode

This node adds CI-based result nodes to the view result. Generally speaking, this FDN will add result tree node linked to the CIs that are returned by the query node its based on (defined by queryNodeName()). These result tree nodes will be placed under the 'correct' result tree node parent - either as roots if there is no parent or as children to their connected result tree nodes.
The anchor define the end of a path between the parent and this FDN and is used to determine under which result tree instance (CI / synthetic label) each result of this FDN will be placed.

Node designations:

• If not defined, a single letter node denotes is a query based FDN and nodes begining with "Syn" defnote synthetic nodes
• X - this node.
• Pr - This node's parent, may be null, may be synthetic.
• PrQN - this node's closest query node based FDN parent.
• Anc - This node's anchor FDN.

Modifiers:

• Y! - the query nodes for the given FDN, if one can exist (if the node is a query based FDN).
• Y@ - the result tree nodes for the given FDN.

Restrictions regarding anchors:

1. The queryNodeName() method must return the name of a valid node name in the query this query definition is based on.
2. If X is root, the Anc may be null.
3. If X is not root but all it ancestors are synthetic nodes, Anc may be null.
4. If X is not root and not all ancestors are synthethic nodes, Anc must be either:
   1. PrQN.
   2. A query based FDN that is a direct child of PrQN that is not X.
   3. A query based FDN that is an indirect child of PrQN that does not have X as its ancestor.
   see example group 1.
5. If Anc is not null, Anc! and X! must be linked in the query (Anc!->X!, X!->Anc! or both).

Definitions:

1. X is "In place" if Anc == Pr or Anc == null.
2. X is "Syntheticly in place" if Anc == PrQN and Pr is a synthetic node.
3. X is "Out of place" if Anc != PrQN.

Cycle definitions:
The cycleDefinitions() denotes a cycle-inducing link in the query. Each cycle definition has a target, denoted Y. A cycle definition with Y as target causes the entire sub-tree of Y to appear below X or below X's parent (folded and not folded cycles, respectively) if the correct link exist. Infinite cycles are stopepd at their first repeat.
Note: All permitted and not permitted links (white/black lists) of Y apply to the cycle links as well.

Restrictions regarding cycle definitions:

1. Y must be a query node FDN ancestor of X and there must be a link between Y! and X! (X!->Y!, Y!->X! or both).

Indirect link with "show path" flag:
Indirect links (aka compound links) with the "show path" flag (aka "open compound link") add CIs to the result. Since the folding definition is node based, these CIs have no specified parent to be added under and they are handled by the following rules (See example group 2 for all rules):

1. If the target of the link is directly under the source of the link, or vice versa, the CIs will be added in a "folded" fashion, from the parent to the child, regardless of the link original direction.
2. On any other configuration, the CIs will appear "flat" next to the 'target' FDN (the FDN that has an anchor to that points to the other side of the link).

Examples:
In all examples:

1. If anchor is not specifically named, the anchor is the nodes parent (if exists) or null (if the node is root)
2. Small letters with numbers refer to CI instances of the nodes with the same letter - i.e. a1, a2 are instance of A

Example group 1: allowed placing for anchors (disregarding query nodes):
This is allowed:

  A
      B (trivial anchor = A)
      C (anchor = B)
      D
          E
              F
      G (anchor = F)
  H (anchor = F)
  SynI
      J (anchor = null)
  K
      SynL
          M (anchor = K)
 

1. B is trivially allowed the anchor is its direct parent A.
2. C is valid since B is a direct descendant of C's parent A.
3. G is valid since E is an indirect descendant of G's parent A
4. H is trivially valid since its parent is root, so all nodes are descendant from it (direct or indirect).
5. J is valid since all of its ancestors are synthethic nodes.
6. M is valid since K is its PrQN (closets query based FDN) ancestor.

This is not allowed:

  A (anchor = B)
      B
  C
      D
          E (anchor = C)
  F
  G
      H (anchor = F)
  SynI
      J (anchor = SynI)
 

1. A is not allowed since B is its child.
2. E is not allowed since C is not a descendant of D (its PrQN).
3. H is not valid since F is not a descendant of G (its PrQN).
4. J is not valid since SynI is not a query based FDN.

Example group 2: Indirect link with show path flag:
For the query A->D where the link is an indirect link with the steps A->B (along), C->B (against):

For the following definition (source above target):

  A
      D
 

The following result tree is a possible result:

  a1
      b1
          c1
              d1
      b2
          c2
              d2
  a2              - if min depth is 0 and the query node of D permits a2, this can occur as well.
      a2
 

For the following definition (target above source):

  D
      A
 

The following result tree is a possible result:

  d1
      c1
          b1
              a1
      c2
          b2
              a2
  d2              - if min depth is 0 and the query node of A permits d2, this can occur as well.
      d2
 

For the following definition (flat indirect link):

  R
      A
      D (anchor = A)
 

The following result tree is a possible result:

  r1
      a1      - from the A FDN
      a2
      d1      - from the D FDN
      d2
      b1      - from the CIs returned by the indirect link.
      c1
      d1
      b2
      c2
 

For the following definition (CIs with the target):

  R
      D
  A (anchor = D)
 

The following result tree is a possible result:

  r1
      d1      - from the D FDN
      d2
  a1      - from the A FDN
  a2
  b1      - from the CIs returned by the indirect link - positioned under the same parent (root) as the 'target' FDN.
  c1
  d1
  b2
  c2
 

Since:

UCMDB 9.0

See Also:

QueryDefinition, QueryNode, QueryLink

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.
QueryNodeBasedFDN	addCycleDefinition(String cycleFoldingRootNodeName, CycleFoldingRule cycleFoldingRule) Adds a cycle definition for this node.
Set<CycleDefinition>	cycleDefinitions() The set of added cycle definitions.
String	queryNodeName() Returns the query node name associated with this FDN.
ReachableSetFoldingRule	reachableSetFoldingRule() Returns the previously set ReachableSetFoldingRule.
QueryNodeBasedFDN	withQueryNodeName(String queryNodeName) Sets the query node name associated with this FDN.
QueryNodeBasedFDN	withReachableSetFoldingRule(ReachableSetFoldingRule reachableSetFoldingRule) Sets the reachable set folding rule.

Methods inherited from interface com.hp.ucmdb.api.view.foldingdefinition.FoldingDefinitionNode

addSortingRule, addSortingRule, addViewAttribute, asQueryNodeBasedFDN, asSyntheticNode, children, definition, name, parent, root, sortingRules, 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

queryNodeName

String queryNodeName()

Returns the query node name associated with this FDN.

withQueryNodeName

QueryNodeBasedFDN withQueryNodeName(String queryNodeName)

Sets the query node name associated with this FDN. A query node by this name must exist in the Query this definition relies on before the view can be saved or executed.

Parameters:

queryNodeName - the query node name. May not be null.

Returns:

this QueryNodeBasedFDN.

cycleDefinitions

Set<CycleDefinition> cycleDefinitions()

The set of added cycle definitions.

addCycleDefinition

QueryNodeBasedFDN addCycleDefinition(String cycleFoldingRootNodeName,
                                     CycleFoldingRule cycleFoldingRule)

Adds a cycle definition for this node. The node name in a cycle definition must:

• Exist in the folding definition before it is saved or executed.
• Be anchor/parent-reachable from this node.

Returns:

this QueryNodeBasedFDN.

addChild

<FDN extends FoldingDefinitionNode> FDN addChild(FDN foldingDefinitionNode)

Appends a child to this FDN as the last child.

Specified by:

addChild in interface FoldingDefinitionNode

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.

Specified by:

addChild in interface FoldingDefinitionNode

Returns:

the child just added.

withReachableSetFoldingRule

QueryNodeBasedFDN withReachableSetFoldingRule(ReachableSetFoldingRule reachableSetFoldingRule)

Sets the reachable set folding rule. If the query node for this FDN has a reachable set, this parameter will control their location in the view result.

The default is folded under this node.

If the query node for this FDN has no reachable set, this method will have no effect on the result.

Returns:

this QueryNodeBasedFDN.

reachableSetFoldingRule

ReachableSetFoldingRule reachableSetFoldingRule()

Returns the previously set ReachableSetFoldingRule.