org.opennms.features.topology.api.browsers

Interface SelectionAware

All Known Subinterfaces:

GraphProvider, TopologyServiceClient

All Known Implementing Classes:

AbstractTopologyProvider, BusinessServicesTopologyProvider, DefaultTopologyServiceClient, GraphMLTopologyProvider, LegacyApplicationTopologyProvider, LegacyTopologyProvider, LinkdSelectionAware, LinkdTopologyProvider, PathOutageProvider, SimpleGraphProvider, VmwareTopologyProvider

public interface SelectionAware

Interface marking if a GraphProvider is "selection aware". This allows GraphProviders to filter the browser tables (e.g. alarm, node, etc) based on the current selection. In order to achieve that all selected Vertices must be converted to a list of Restrictions. The list of Restriction is represented by SelectionChangedListener.Selection.

Method Summary

Modifier and Type	Method and Description
boolean	contributesTo(ContentType type) Allows the GraphProvider to define if it contributes to a certain ContentType.
SelectionChangedListener.Selection	getSelection(List<VertexRef> selectedVertices, ContentType type) Converts the provided selectedVertices to a Selection.

Method Detail

getSelection

SelectionChangedListener.Selection getSelection(List<VertexRef> selectedVertices,
                                                ContentType type)

Converts the provided selectedVertices to a Selection. The provided type represents the according browser table. This method is only invoked if contributesTo(ContentType) returns to for the provided type

Parameters:

selectedVertices - The vertices currently selected in the Topology UI.

type - The type to filter for. Represents the according browser table.

Returns:

The selection containing the List of Restrictions. Must NOT be null.

See Also:

SelectionChangedListener.Selection

contributesTo

boolean contributesTo(ContentType type)

Allows the GraphProvider to define if it contributes to a certain ContentType. If false it is not shown in the browsers tab at all

Parameters:

type - The type to check if this contribute to

Returns:

true if this contributes to the provided type