com.hp.ucmdb.api.view.result

Interface ViewResult

All Superinterfaces:

SupportsClientProperties<ViewResult>

All Known Subinterfaces:

ViewResultWithMap

public interface ViewResult
extends SupportsClientProperties<ViewResult>

The result of a view execution.

This class hold the topology the view is based on and the tree that is the result of the folding rules execution on the said topology.

Client properties are copied from the client properties of the view definition. These client properties are not modifiable.

Since:

UCMDB 9.0

Method Summary

Modifier and Type	Method and Description
Map<ViewResultTreeNodeID,ViewResultTreeNode>	getNearestNodesFromIds(Set<ViewResultTreeNodeID> ids) Returns a map of nearest matchs (node or closest parent existing) for the given ids.
Map<ViewResultTreeNodeID,ViewResultTreeNode>	getNearestNodesFromIds(ViewResultTreeNodeID... ids) See getNearestNodesFromIds(java.util.Set).
ViewResultTreeNode	lookupAccessedNodeFromTreeNodeId(ViewResultTreeNodeID id) a quick method that return null if the node with the given id is was not accessed yet.
Set<ViewResultTreeNode>	lookupNodes(Set<String> viewDefinitionNodeNames) Returns all the node in the view matching any of the given set of view definition node names.
Set<ViewResultTreeNode>	lookupNodesFromIds(Set<UcmdbId> ciIds) Returns all the nodes matching the given ci ids.
Set<ViewResultTreeNode>	lookupNodesFromIds(UcmdbId... ciIds) Returns all the nodes matching the given ci ids.
void	makeThreadSafe() Call this method to make the internal view structure safe to access by multiple threads.
ViewResultVersion	resultVersion()
List<? extends ViewResultTreeNode>	roots() The ordered list of view result tree roots.
Topology	topology() The topology this view result is based on.
ViewResultUtils	utils()
boolean	viewSupportsHasChanges() Returns true if the view that generated this view result supports the "has changes" question.

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

clientProperties, clientProperty, usedNamespaces, withClientProperty

Method Detail

topology

Topology topology()

The topology this view result is based on.

By default, CIs and Relations in the topology do not have the properties defined in the query(ies) underlying the view. This can be change by using the options object.

roots

List<? extends ViewResultTreeNode> roots()

The ordered list of view result tree roots. Note: This is in fact an ordered set - the same item may only appear once.

lookupNodes

Set<ViewResultTreeNode> lookupNodes(Set<String> viewDefinitionNodeNames)

Returns all the node in the view matching any of the given set of view definition node names.

lookupNodesFromIds

Set<ViewResultTreeNode> lookupNodesFromIds(Set<UcmdbId> ciIds)

Returns all the nodes matching the given ci ids.

lookupNodesFromIds

Set<ViewResultTreeNode> lookupNodesFromIds(UcmdbId... ciIds)

Returns all the nodes matching the given ci ids.

getNearestNodesFromIds

@NotFinalAPI
Map<ViewResultTreeNodeID,ViewResultTreeNode> getNearestNodesFromIds(Set<ViewResultTreeNodeID> ids)

Returns a map of nearest matchs (node or closest parent existing) for the given ids. this method can be used to compare ids between different view results (of same view or different views).

Note: the map may not hold all given ids. If an id is missing from the map, no ancestor of that id was found in this view result.

This method is intended for supporting the "view was updated - restore references on best effort" scenario. For example, restore selection in a visual representation after updating the view.

Parameters:

ids - the ids to find nearest nodes for. May not be null, may be empty.

Returns:

a map of the given ids object to the found tree result nodes. May not be null, may be empty.

getNearestNodesFromIds

@NotFinalAPI
Map<ViewResultTreeNodeID,ViewResultTreeNode> getNearestNodesFromIds(ViewResultTreeNodeID... ids)

See getNearestNodesFromIds(java.util.Set).

lookupAccessedNodeFromTreeNodeId

ViewResultTreeNode lookupAccessedNodeFromTreeNodeId(ViewResultTreeNodeID id)

a quick method that return null if the node with the given id is was not accessed yet.

Parameters:

id - the id.

Returns:

the node or null

resultVersion

@NotFinalAPI
ViewResultVersion resultVersion()

Returns:

the version of this view result.

viewSupportsHasChanges

@NotFinalAPI
boolean viewSupportsHasChanges()

Returns true if the view that generated this view result supports the "has changes" question.

Implementation note: This is a convenience method which is equivalent to calling: topology().querySupportsHasChanges();

See Also:

Topology.querySupportsHasChanges(), ViewService.hasChanges(java.lang.String, com.hp.ucmdb.api.view.result.ViewResultVersion)

utils

ViewResultUtils utils()

makeThreadSafe

void makeThreadSafe()

Call this method to make the internal view structure safe to access by multiple threads. As this inflict penalties on single-threaded usage, it must be called explicitly.

This method may be called only before any other view call. Calling this method after calling any other method may yield an exception. Multiple calls to this method are ignored.

The ViewResult is treated as thread-safe only after this method returns.