Package org.opennms.features.topology.api

Interface GraphContainer

All Superinterfaces:

DisplayState

All Known Implementing Classes:

VEProviderGraphContainer

public interface GraphContainer
extends DisplayState

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	GraphContainer.Callback	Callback which is invoked after the GraphProvider has been changed.
static interface	GraphContainer.ChangeListener

Method Summary

Modifier and Type	Method	Description
void	addChangeListener(GraphContainer.ChangeListener listener)
void	addCriteria(Criteria criteria)
void	clearCriteria()
<T extends Criteria> java.util.Set<T>	findCriteria(java.lang.Class<T> criteriaType)	Allows queriing the GraphContainer for specific types of criteria.
<T extends Criteria> T	findSingleCriteria(java.lang.Class<T> criteriaType)	Does the same as findCriteria(Class), but only returns one Criteria.
void	fireGraphChanged()
VaadinApplicationContext	getApplicationContext()
AutoRefreshSupport	getAutoRefreshSupport()
Criteria[]	getCriteria()
Graph	getGraph()
IconManager	getIconManager()
MapViewManager	getMapViewManager()
java.lang.String	getMetaTopologyId()
com.vaadin.v7.data.Property<java.lang.Double>	getScaleProperty()
SelectionManager	getSelectionManager()
java.lang.String	getSessionId()
TopologyServiceClient	getTopologyServiceClient()
java.util.Collection<VertexRef>	getVertexRefForest(java.util.Collection<VertexRef> vertexRefs)
boolean	hasAutoRefreshSupport()
void	removeChangeListener(GraphContainer.ChangeListener listener)
void	removeCriteria(Criteria criteria)
void	saveLayout()
void	selectTopologyProvider(GraphProvider graphProvider, GraphContainer.Callback... callbacks)	Selects the specified GraphProvider.
void	setApplicationContext(VaadinApplicationContext applicationContext)
void	setDirty(boolean dirty)
void	setIconManager(IconManager iconManager)
void	setMetaTopologyId(java.lang.String metaTopologyId)
void	setSelectedNamespace(java.lang.String namespace)
void	setSelectionManager(SelectionManager selectionManager)

Methods inherited from interface org.opennms.features.topology.api.DisplayState

getLayoutAlgorithm, getScale, getSemanticZoomLevel, redoLayout, setLayoutAlgorithm, setScale, setSemanticZoomLevel

Method Detail

setMetaTopologyId

void setMetaTopologyId(java.lang.String metaTopologyId)

getMetaTopologyId

java.lang.String getMetaTopologyId()

getTopologyServiceClient

TopologyServiceClient getTopologyServiceClient()

getCriteria

Criteria[] getCriteria()

addCriteria

void addCriteria(Criteria criteria)

removeCriteria

void removeCriteria(Criteria criteria)

clearCriteria

void clearCriteria()

selectTopologyProvider

void selectTopologyProvider(GraphProvider graphProvider,
                            GraphContainer.Callback... callbacks)

Selects the specified GraphProvider.

Parameters:

graphProvider - the provider to select.

callbacks - callbacks to invoke after the provider has been selected (e.g. apply semantic zoom level, etc)

addChangeListener

void addChangeListener(GraphContainer.ChangeListener listener)

removeChangeListener

void removeChangeListener(GraphContainer.ChangeListener listener)

getSelectionManager

SelectionManager getSelectionManager()

setSelectionManager

void setSelectionManager(SelectionManager selectionManager)

getGraph

Graph getGraph()

setApplicationContext

void setApplicationContext(VaadinApplicationContext applicationContext)

getAutoRefreshSupport

AutoRefreshSupport getAutoRefreshSupport()

hasAutoRefreshSupport

boolean hasAutoRefreshSupport()

getVertexRefForest

java.util.Collection<VertexRef> getVertexRefForest(java.util.Collection<VertexRef> vertexRefs)

setSelectedNamespace

void setSelectedNamespace(java.lang.String namespace)

getMapViewManager

MapViewManager getMapViewManager()

getScaleProperty

com.vaadin.v7.data.Property<java.lang.Double> getScaleProperty()

getSessionId

java.lang.String getSessionId()

getApplicationContext

VaadinApplicationContext getApplicationContext()

setDirty

void setDirty(boolean dirty)

fireGraphChanged

void fireGraphChanged()

findCriteria

<T extends Criteria> java.util.Set<T> findCriteria(java.lang.Class<T> criteriaType)

Allows queriing the GraphContainer for specific types of criteria.

Type Parameters:

T - The criteria class.

Parameters:

criteriaType - The type to look for. May not be null.

Returns:

All criteria assigned to this GraphContainer which are of the same type (or a sub type) of criteriaType.

findSingleCriteria

<T extends Criteria> T findSingleCriteria(java.lang.Class<T> criteriaType)

Does the same as findCriteria(Class), but only returns one Criteria. If multiple criteria for the same type are found, the first one is returned. No exception is thrown in that case.

Type Parameters:

T - The criteria class.

Parameters:

criteriaType - The type to look for.

Returns:

The first found criteria, or null if none is found.

getIconManager

IconManager getIconManager()

setIconManager

void setIconManager(IconManager iconManager)

saveLayout

void saveLayout()