com.hp.ucmdb.api.topology.indirectlink

Interface IndirectLink

All Superinterfaces:

QueryLink<IndirectLink>, SupportsInvisibility<QueryLink<IndirectLink>>

public interface IndirectLink
extends QueryLink<IndirectLink>

Represent a query about an indirect link, defined by a series of allowed steps, between the "from" node and the "to" node.

The allowed steps are a set of indirect link steps definitions, each consists of "from", "to" and "link" part. Together, these form the rules by which a path may be traversed. If exists a path from the source node to the target node, using only the allowed steps (or a subset of them), the indirect link will "exist", either for condition purposes, result purposes or both.

If not invisible:
If showEntirePath() was not called, the indirect link will exist in the result as a TopologyRelation between the source TopologyCI and the target TopologyCI. The node name of the TopologyRelation will be the name of the IndirectLink.
If showEntirePath() was called, the actual path identified between the source TopologyCI and the target TopologyCI will exist in the result (steps of CI, Relation, CI). Any properties to query set will affect on both the inner nodes and inner links of the indirect link.

If invisible, calling "showEntirePath" is useless since the link can only be used as a condition on its adjacent query nodes.

An indirect link may be constraint to match at least and at most number of steps.

Since:

UCMDB 9.0

Field Summary

Fields inherited from interface com.hp.ucmdb.api.topology.QueryLink

UNBOUNDED

Method Summary

Modifier and Type	Method and Description
Map<String,? extends PropertiesToQuery>	getPropertiesToQueryPerType() Returns the properties to query for each type.
String	linksName() Returns the name for the step links.
int	maxNumberOfStepsMatched() Returns the maxNumberOfStepsMatched.
int	minNumberOfStepsMatched() Returns the minNumberOfStepsMatched.
String	nodesName() Returns the name for the step nodes.
PropertiesToQuery	propertiesToQuery(String subType) Returns an object that represents the properties to query for elements of the specified subtype.
boolean	shouldShowEntirePath() Returns if the entire path of the indirect link should be shown.
boolean	shouldStopAtFirstMatch() Returns the "shouldStopAtFirstTarget" flag.
IndirectLink	showEntirePath() Calling this method will cause the nodes and links from the steps to appear in the resulting topology.
Collection<? extends IndirectLinkStep>	steps() Returns the steps collection for this indirect link.
IndirectLink	stopAtFirstMatch() If called, the indirect link will stop at the first time it reaches a CI matching its target.
IndirectLink	withLinksName(String name) Defines the name for the links identified by the steps in this indirect link.
IndirectLink	withMaxNumberOfStepsMatched(int maxNumberOfStepsMatched) Sets the maximum number of steps that should be searched for while creating links using this definition in the topology.
IndirectLink	withMinNumberOfStepsMatched(int minNumberOfStepsMatched) Sets the minimum number of steps that should co-exist before a link will be created in the result topology.
IndirectLink	withNodesName(String name) Defines the name for the nodes identified by the steps in this indirect link.
EmptyIndirectLinkStep	withStep() Adds a step to this indirect link.

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

asDirectLink, asIndirectLink, asOnPropertiesLink, atLeast, atMost, exactly, getFromNode, getToNode, name, queryLinkType, restrictToSelfLinks, selfLinkFilter, setSelfLinkFilter, sourceMaxCardinality, sourceMinCardinality, sourceNode, targetMaxCardinality, targetMinCardinality, targetNode, withName, withoutSelfLinks, withSourceCardinality, withTargetCardinality

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

invisible, isInvisible

Method Detail

withStep

EmptyIndirectLinkStep withStep()

Adds a step to this indirect link.

steps

Collection<? extends IndirectLinkStep> steps()

Returns the steps collection for this indirect link.

withMinNumberOfStepsMatched

IndirectLink withMinNumberOfStepsMatched(int minNumberOfStepsMatched)

Sets the minimum number of steps that should co-exist before a link will be created in the result topology. If the minimum is set to 0, every source of the link will be linked to itself as target.
The default is 1.

Returns:

this object. The returned object can be used for method chaining.

See Also:

minNumberOfStepsMatched()

minNumberOfStepsMatched

int minNumberOfStepsMatched()

Returns the minNumberOfStepsMatched.

See Also:

withMinNumberOfStepsMatched(int).

withMaxNumberOfStepsMatched

IndirectLink withMaxNumberOfStepsMatched(int maxNumberOfStepsMatched)

Sets the maximum number of steps that should be searched for while creating links using this definition in the topology. This effectively constrains the length of the indirect link. The default is 5.

Returns:

this object. The returned object can be used for method chaining.

See Also:

maxNumberOfStepsMatched()

maxNumberOfStepsMatched

int maxNumberOfStepsMatched()

Returns the maxNumberOfStepsMatched.

See Also:

withMaxNumberOfStepsMatched(int).

stopAtFirstMatch

IndirectLink stopAtFirstMatch()

If called, the indirect link will stop at the first time it reaches a CI matching its target. Otherwise the indirect link may be continued, if its defining steps allow it, to continue.

Example, if exists a world of that looks like this:

 A1->B1->C1->A2->B2->C2.
 

And the steps defined are:

 A->B
 B->C
 C->A
 

And the source node is A and the target node is C.
Then:
If this method is not called, there will be three indirect links: A1->C1, A1->C2 and A2->C2.
If this method is called, there will be only two indirect links: A1->C1 and A2->C2.

Returns:

this object. The returned object can be used for method chaining.

See Also:

shouldStopAtFirstMatch()

shouldStopAtFirstMatch

boolean shouldStopAtFirstMatch()

Returns the "shouldStopAtFirstTarget" flag.

See Also:

stopAtFirstMatch()

showEntirePath

IndirectLink showEntirePath()

Calling this method will cause the nodes and links from the steps to appear in the resulting topology.

Without calling this method the matched nodes and links from the steps will not appear in the topology and only the indirect link will. Calling this path will cause the nodes and links from the matched steps to appear instead of the indirect link.

Returns:

this object. The returned object can be used for method chaining.

See Also:

shouldShowEntirePath()

shouldShowEntirePath

boolean shouldShowEntirePath()

Returns if the entire path of the indirect link should be shown.

withNodesName

IndirectLink withNodesName(String name)

Defines the name for the nodes identified by the steps in this indirect link. In the topology, it will be possible to identify the nodes using this name. All the nodes from all the steps of this indirect link share the same name.

Returns:

this object. The returned object can be used for method chaining.

See Also:

nodesName(), showEntirePath()

nodesName

String nodesName()

Returns the name for the step nodes.

See Also:

withNodesName(String)

withLinksName

IndirectLink withLinksName(String name)

Defines the name for the links identified by the steps in this indirect link. In the topology, it will be possible to identify the links using this name. All the links from all the steps of this indirect link share the same name.

Returns:

this object. The returned object can be used for method chaining.

See Also:

nodesName(), showEntirePath()

linksName

String linksName()

Returns the name for the step links.

See Also:

withLinksName(String)

propertiesToQuery

PropertiesToQuery propertiesToQuery(String subType)

Returns an object that represents the properties to query for elements of the specified subtype. Modification of this object changes those properties.

Returns:

properties to query for elements of the specified subtype

getPropertiesToQueryPerType

Map<String,? extends PropertiesToQuery> getPropertiesToQueryPerType()

Returns the properties to query for each type. If no subtype-specific properties to query are defined, the resulting map is empty.

Returns:

a map of the names of the subtypes to the properties to query for each type