org.opennms.web.map.view
Interface Manager

All Known Implementing Classes:

ManagerDefaultImpl, ManagerMapdImpl

public interface Manager

Author:

maurizio

Method Summary

void	clearMap()
void	closeMap() Close a VMap previusly opened.
void	deleteAllMapElements() delete all defined sub maps in existent maps
void	deleteAllNodeElements() delete all defined node elements in existent maps
void	deleteElementsOfMap(int mapId)
void	deleteMap()
void	deleteMap(int mapId) delete the map with identifier id
void	deleteMap(VMap map) delete the map in input
void	deleteMaps(int[] maps) delete the maps with the identifiers in input
void	deleteMaps(VMap[] maps) delete the maps in input
boolean	foundLoopOnMaps(VMap parentMap, int mapId)
VElementInfo[]	getAllElementInfo()
VMapInfo[]	getAllMapMenus() Get all defined maps.
VMap[]	getAllMaps(boolean refreshElems) Get all defined maps.
HashMap<Integer,Integer>	getAllNodesOccursOnMap(VMap map) Gets all nodes on the passed map (and its submaps) with theirs occurrences
List<String>	getCategories()
VElementInfo[]	getElementInfoLike(String like)
List<VLink>	getLinks(Collection<VElement> elems)
List<VLink>	getLinks(VElement[] elems)
List<VLink>	getLinksOnElem(VElement[] elems, VElement elem)
VMap[]	getMap(String mapname, String maptype, boolean refreshElems) Take the map label and type in input and return it in VMap form.
VMapInfo	getMapMenu(int mapId)
VMap[]	getMapsByName(String mapName, boolean refreshElems) Take the maps with name in input and return them in VMap[] form.
VMap[]	getMapsLike(String likeLabel, boolean refreshElems) Take the maps with label like the pattern in input and return them in VMap[] form.
VMapInfo[]	getMapsMenuByName(String mapName) Take the maps with name in input and return them in MapMenu[] form.
List	getMapsMenuTreeByName(String mapName) Take all the maps in the tree of maps considering the with name in input as the root of the tree.
Set<Integer>	getNodeidsOnElement(VElement elem) recursively gets all nodes contained by elem and its submaps (if elem is a map)
List<VMapInfo>	getVisibleMapsMenu(String user) gets all visible maps for user in input
VElement	newElement(int mapId, int elementId, String type) Create a new (not child) empty Submap with the identifier setted to id.
VElement	newElement(int mapId, int elementId, String type, int x, int y) Create a new (not child) empty Submap with the identifier setted to id.
VElement	newElement(int mapId, int elementId, String type, String iconname) Create a new (not child) empty Submap with the identifier setted to id.
VElement	newElement(int mapId, int elementId, String type, String iconname, int x, int y) Create a new (not child) empty Submap with the identifier setted to id.
VElement	newElement(int elementId, String type)
VElement	newElement(int elementId, String type, int x, int y)
VElement	newElement(int elementId, String type, String iconname, int x, int y)
VMap	newMap() Create a new empty VMap and return it.
VMap	newMap(String name, String accessMode, String owner, String userModifies, int width, int height) Create a new VMap and return it
VMap	openMap()
VMap	openMap(int id, boolean refreshElems) Take the map with id in input and return it in VMap form.
VMap	openMap(int id, String user, boolean refreshElems) Take the map with id in input and return it in VMap form.
VElement	refreshElement(VElement mapElement)
List<VElement>	refreshElements(VElement[] mapElements) Refreshes of avail,severity and status of the elements in input.
List<VLink>	refreshLinks(VLink[] mapLinks) TODO write this method simil way to refreshElement Not Yet Implemented
List<VElement>	refreshMap()
VMap	reloadMap(VMap map) Refreshs avail,severity and status of the map in input and its elements
void	save(VMap map) save the map in input
void	save(VMap[] maps) save the maps in input

Method Detail

getCategories

List<String> getCategories()
                           throws MapsException

Throws:

MapsException

newMap

VMap newMap()

Create a new empty VMap and return it.

Returns:

the new VMap created.

newMap

VMap newMap(String name,
            String accessMode,
            String owner,
            String userModifies,
            int width,
            int height)

Create a new VMap and return it

Parameters:

name -

accessMode -

owner -

userModifies -

width -

height -

Returns:

the new VMap

closeMap

void closeMap()

Close a VMap previusly opened.

openMap

VMap openMap()
             throws MapNotFoundException

Returns:

the default VMap, if exists

Throws:

MapsException

MapNotFoundException

openMap

VMap openMap(int id,
             boolean refreshElems)
             throws MapNotFoundException,
                    MapsException

Take the map with id in input and return it in VMap form.

Parameters:

id -

refreshElems - says if refresh the map's elements

Returns:

the VMap with identifier id

Throws:

MapsException

MapNotFoundException

openMap

VMap openMap(int id,
             String user,
             boolean refreshElems)
             throws MapNotFoundException,
                    MapsException

Take the map with id in input and return it in VMap form.

Parameters:

id -

user -

refreshElems - says if refresh the map's elements

Returns:

the VMap with identifier id

Throws:

MapsException

MapNotFoundException

clearMap

void clearMap()
              throws MapNotFoundException,
                     MapsException

Throws:

MapNotFoundException

MapsException

getMapMenu

VMapInfo getMapMenu(int mapId)
                    throws MapNotFoundException,
                           MapsException

Throws:

MapNotFoundException

MapsException

deleteElementsOfMap

void deleteElementsOfMap(int mapId)
                         throws MapsException

Throws:

MapsException

getLinks

List<VLink> getLinks(VElement[] elems)
                     throws MapsException

Throws:

MapsException

getLinks

List<VLink> getLinks(Collection<VElement> elems)
                     throws MapsException

Throws:

MapsException

getLinksOnElem

List<VLink> getLinksOnElem(VElement[] elems,
                           VElement elem)
                           throws MapsException

Throws:

MapsException

getMapsLike

VMap[] getMapsLike(String likeLabel,
                   boolean refreshElems)
                   throws MapsException

Take the maps with label like the pattern in input and return them in VMap[] form.

Parameters:

label -

refreshElems - says if refresh map's elements

Returns:

the VMaps array if any label matches the pattern in input, null otherwise

Throws:

MapsException

getMap

VMap[] getMap(String mapname,
              String maptype,
              boolean refreshElems)
              throws MapsManagementException,
                     MapNotFoundException,
                     MapsException

Take the map label and type in input and return it in VMap form.

Parameters:

mapname -

maptype -

refreshElems - says if refresh map's elements

Returns:

the VMap[] with corresponding mapname and maptype

Throws:

MapsException

MapsManagementException

MapNotFoundException

getMapsByName

VMap[] getMapsByName(String mapName,
                     boolean refreshElems)
                     throws MapNotFoundException,
                            MapsException

Take the maps with name in input and return them in VMap[] form.

Parameters:

mapName -

refhresElems - says if refresh maps' elements

Returns:

the VMaps array if any map has name in input, null otherwise

Throws:

MapsException

MapNotFoundException

getAllMaps

VMap[] getAllMaps(boolean refreshElems)
                  throws MapNotFoundException,
                         MapsException

Get all defined maps.

Parameters:

refreshElems - says if refresh maps' elements

Returns:

the VMaps array containing all maps defined

Throws:

MapsException

MapNotFoundException

getAllMapMenus

VMapInfo[] getAllMapMenus()
                          throws MapsException

Get all defined maps.

Returns:

the MapMenu array containing all maps defined

Throws:

MapsException

getMapsMenuByName

VMapInfo[] getMapsMenuByName(String mapName)
                             throws MapNotFoundException,
                                    MapsException

Take the maps with name in input and return them in MapMenu[] form.

Parameters:

mapName -

Returns:

the MapMenu array if any map has name in input, null otherwise

Throws:

MapsException

MapNotFoundException

getVisibleMapsMenu

List<VMapInfo> getVisibleMapsMenu(String user)
                                  throws MapsException

gets all visible maps for user in input

Parameters:

user -

Returns:

a List of MapMenu objects.

Throws:

MapsException

getMapsMenuTreeByName

List getMapsMenuTreeByName(String mapName)
                           throws MapNotFoundException,
                                  MapsException

Take all the maps in the tree of maps considering the with name in input as the root of the tree. If there are more maps with mapName (case insensitive) all trees with these maps as root are considered and returned.

Parameters:

mapName -

Returns:

a List with the MapMenu objects.

Throws:

MapsException

MapNotFoundException

newElement

VElement newElement(int mapId,
                    int elementId,
                    String type,
                    int x,
                    int y)
                    throws MapsException

Create a new (not child) empty Submap with the identifier setted to id.

Parameters:

mapId -

elementId -

type - the node type

Returns:

the new VElement

Throws:

MapsException

newElement

VElement newElement(int elementId,
                    String type,
                    int x,
                    int y)
                    throws MapsException

Throws:

MapsException

newElement

VElement newElement(int mapId,
                    int elementId,
                    String type)
                    throws MapsException

Create a new (not child) empty Submap with the identifier setted to id.

Parameters:

mapId -

elementId -

type - the node type

Returns:

the new VElement

Throws:

MapsException

newElement

VElement newElement(int elementId,
                    String type)
                    throws MapsException

Throws:

MapsException

newElement

VElement newElement(int mapId,
                    int elementId,
                    String type,
                    String iconname,
                    int x,
                    int y)
                    throws MapsException

Create a new (not child) empty Submap with the identifier setted to id.

Parameters:

mapId -

elementId -

type - the node type

Returns:

the new VElement

Throws:

MapsException

newElement

VElement newElement(int elementId,
                    String type,
                    String iconname,
                    int x,
                    int y)
                    throws MapsException

Throws:

MapsException

newElement

VElement newElement(int mapId,
                    int elementId,
                    String type,
                    String iconname)
                    throws MapsException

Create a new (not child) empty Submap with the identifier setted to id.

Parameters:

mapId -

elementId -

type - the node type

Returns:

the new VElement

Throws:

MapsException

deleteMap

void deleteMap(VMap map)
               throws MapsException,
                      MapNotFoundException

delete the map in input

Parameters:

map - to delete

Throws:

MapsException - if an error occour deleting map, MapNotFoundException if the map to delete doesn't exist.

MapNotFoundException

deleteMap

void deleteMap()
               throws MapsException,
                      MapNotFoundException

Throws:

MapsException

MapNotFoundException

deleteMap

void deleteMap(int mapId)
               throws MapsException

delete the map with identifier id

Parameters:

id - of the map to delete

Throws:

MapsException

deleteMaps

void deleteMaps(VMap[] maps)
                throws MapsException

delete the maps in input

Parameters:

maps - to delete

Throws:

MapsException

deleteMaps

void deleteMaps(int[] maps)
                throws MapsException

delete the maps with the identifiers in input

Parameters:

identifiers - of the maps to delete

Throws:

MapsException

save

void save(VMap map)
          throws MapsException

save the map in input

Parameters:

map - to save

Throws:

MapsException

save

void save(VMap[] maps)
          throws MapsException

save the maps in input

Parameters:

maps - to save

Throws:

MapsException

deleteAllNodeElements

void deleteAllNodeElements()
                           throws MapsException

delete all defined node elements in existent maps

Throws:

MapsException

deleteAllMapElements

void deleteAllMapElements()
                          throws MapsException

delete all defined sub maps in existent maps

Throws:

MapsException

refreshElements

List<VElement> refreshElements(VElement[] mapElements)
                               throws MapsException

Refreshes of avail,severity and status of the elements in input. The refresh is performed as follows: - default factory is used if no others defined; - if in the using factory is defined a source, the system will use this one else, the system will use default source (OpenNMS)

Parameters:

mapElements - the elements to refresh

incremental - return only changed elements, if the refresh implementation is capable of this operation

Returns:

List of VElement

Throws:

MapsException

refreshMap

List<VElement> refreshMap()
                          throws MapsException

Throws:

MapsException

refreshElement

VElement refreshElement(VElement mapElement)
                        throws MapsException

Throws:

MapsException

reloadMap

VMap reloadMap(VMap map)
               throws MapsException

Refreshs avail,severity and status of the map in input and its elements

Parameters:

map -

Returns:

the map refreshed

Throws:

MapsException

refreshLinks

List<VLink> refreshLinks(VLink[] mapLinks)
                         throws MapsException

TODO write this method simil way to refreshElement Not Yet Implemented

Throws:

MapsException

foundLoopOnMaps

boolean foundLoopOnMaps(VMap parentMap,
                        int mapId)
                        throws MapsException

Throws:

MapsException

getNodeidsOnElement

Set<Integer> getNodeidsOnElement(VElement elem)
                                 throws MapsException

recursively gets all nodes contained by elem and its submaps (if elem is a map)

Throws:

MapsException

getAllElementInfo

VElementInfo[] getAllElementInfo()
                                 throws MapsException

Throws:

MapsException

getElementInfoLike

VElementInfo[] getElementInfoLike(String like)
                                  throws MapsException

Throws:

MapsException

getAllNodesOccursOnMap

HashMap<Integer,Integer> getAllNodesOccursOnMap(VMap map)
                                                throws MapsException

Gets all nodes on the passed map (and its submaps) with theirs occurrences

Parameters:

map -

Returns:

HashMap (nodeid, occurrences) containing all nodes on the passed map (and its submaps) with theirs occourrences

Throws:

MapsException