org.opennms.web.map.mapd
Class ManagerMapdImpl

java.lang.Object
  org.opennms.web.map.mapd.ManagerMapdImpl

All Implemented Interfaces:

Manager

public class ManagerMapdImpl
extends Object
implements Manager

Author:

Antonio Russo

Constructor Summary

ManagerMapdImpl()

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	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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ManagerMapdImpl

public ManagerMapdImpl()

Method Detail

clearMap

public void clearMap()
              throws MapNotFoundException,
                     MapsException

Specified by:

clearMap in interface Manager

Throws:

MapNotFoundException

MapsException

closeMap

public void closeMap()

Description copied from interface: Manager

Close a VMap previusly opened.

Specified by:

closeMap in interface Manager

deleteAllMapElements

public void deleteAllMapElements()
                          throws MapsException

Description copied from interface: Manager

delete all defined sub maps in existent maps

Specified by:

deleteAllMapElements in interface Manager

Throws:

MapsException

deleteAllNodeElements

public void deleteAllNodeElements()
                           throws MapsException

Description copied from interface: Manager

delete all defined node elements in existent maps

Specified by:

deleteAllNodeElements in interface Manager

Throws:

MapsException

deleteElementsOfMap

public void deleteElementsOfMap(int mapId)
                         throws MapsException

Specified by:

deleteElementsOfMap in interface Manager

Throws:

MapsException

deleteMap

public void deleteMap(VMap map)
               throws MapsException,
                      MapNotFoundException

Description copied from interface: Manager

delete the map in input

Specified by:

deleteMap in interface Manager

Parameters:

map - to delete

Throws:

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

MapNotFoundException

deleteMap

public void deleteMap()
               throws MapsException,
                      MapNotFoundException

Specified by:

deleteMap in interface Manager

Throws:

MapsException

MapNotFoundException

deleteMap

public void deleteMap(int mapId)
               throws MapsException

Description copied from interface: Manager

delete the map with identifier id

Specified by:

deleteMap in interface Manager

Throws:

MapsException

deleteMaps

public void deleteMaps(VMap[] maps)
                throws MapsException

Description copied from interface: Manager

delete the maps in input

Specified by:

deleteMaps in interface Manager

Parameters:

maps - to delete

Throws:

MapsException

deleteMaps

public void deleteMaps(int[] maps)
                throws MapsException

Description copied from interface: Manager

delete the maps with the identifiers in input

Specified by:

deleteMaps in interface Manager

Throws:

MapsException

foundLoopOnMaps

public boolean foundLoopOnMaps(VMap parentMap,
                               int mapId)
                        throws MapsException

Specified by:

foundLoopOnMaps in interface Manager

Throws:

MapsException

getAllElementInfo

public VElementInfo[] getAllElementInfo()
                                 throws MapsException

Specified by:

getAllElementInfo in interface Manager

Throws:

MapsException

getAllMapMenus

public VMapInfo[] getAllMapMenus()
                          throws MapsException

Description copied from interface: Manager

Get all defined maps.

Specified by:

getAllMapMenus in interface Manager

Returns:

the MapMenu array containing all maps defined

Throws:

MapsException

getAllMaps

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

Description copied from interface: Manager

Get all defined maps.

Specified by:

getAllMaps in interface Manager

Parameters:

refreshElems - says if refresh maps' elements

Returns:

the VMaps array containing all maps defined

Throws:

MapsException

MapNotFoundException

getAllNodesOccursOnMap

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

Description copied from interface: Manager

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

Specified by:

getAllNodesOccursOnMap in interface Manager

Returns:

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

Throws:

MapsException

getCategories

public List<String> getCategories()
                           throws MapsException

Specified by:

getCategories in interface Manager

Throws:

MapsException

getElementInfoLike

public VElementInfo[] getElementInfoLike(String like)
                                  throws MapsException

Specified by:

getElementInfoLike in interface Manager

Throws:

MapsException

getLinks

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

Specified by:

getLinks in interface Manager

Throws:

MapsException

getLinks

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

Specified by:

getLinks in interface Manager

Throws:

MapsException

getLinksOnElem

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

Specified by:

getLinksOnElem in interface Manager

Throws:

MapsException

getMap

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

Description copied from interface: Manager

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

Specified by:

getMap in interface Manager

refreshElems - says if refresh map's elements

Returns:

the VMap[] with corresponding mapname and maptype

Throws:

MapsException

MapsManagementException

MapNotFoundException

getMapMenu

public VMapInfo getMapMenu(int mapId)
                    throws MapNotFoundException,
                           MapsException

Specified by:

getMapMenu in interface Manager

Throws:

MapNotFoundException

MapsException

getMapsByName

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

Description copied from interface: Manager

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

Specified by:

getMapsByName in interface Manager

Returns:

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

Throws:

MapsException

MapNotFoundException

getMapsLike

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

Description copied from interface: Manager

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

Specified by:

getMapsLike in interface Manager

refreshElems - says if refresh map's elements

Returns:

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

Throws:

MapsException

getMapsMenuByName

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

Description copied from interface: Manager

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

Specified by:

getMapsMenuByName in interface Manager

Returns:

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

Throws:

MapsException

MapNotFoundException

getMapsMenuTreeByName

public List getMapsMenuTreeByName(String mapName)
                           throws MapNotFoundException,
                                  MapsException

Description copied from interface: Manager

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.

Specified by:

getMapsMenuTreeByName in interface Manager

Returns:

a List with the MapMenu objects.

Throws:

MapsException

MapNotFoundException

getNodeidsOnElement

public Set<Integer> getNodeidsOnElement(VElement elem)
                                 throws MapsException

Description copied from interface: Manager

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

Specified by:

getNodeidsOnElement in interface Manager

Throws:

MapsException

getVisibleMapsMenu

public List<VMapInfo> getVisibleMapsMenu(String user)
                                  throws MapsException

Description copied from interface: Manager

gets all visible maps for user in input

Specified by:

getVisibleMapsMenu in interface Manager

Returns:

a List of MapMenu objects.

Throws:

MapsException

newElement

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

Description copied from interface: Manager

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

Specified by:

newElement in interface Manager

type - the node type

Returns:

the new VElement

Throws:

MapsException

newElement

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

Specified by:

newElement in interface Manager

Throws:

MapsException

newElement

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

Description copied from interface: Manager

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

Specified by:

newElement in interface Manager

type - the node type

Returns:

the new VElement

Throws:

MapsException

newElement

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

Specified by:

newElement in interface Manager

Throws:

MapsException

newElement

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

Description copied from interface: Manager

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

Specified by:

newElement in interface Manager

type - the node type

Returns:

the new VElement

Throws:

MapsException

newElement

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

Specified by:

newElement in interface Manager

Throws:

MapsException

newElement

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

Description copied from interface: Manager

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

Specified by:

newElement in interface Manager

type - the node type

Returns:

the new VElement

Throws:

MapsException

newMap

public VMap newMap()

Description copied from interface: Manager

Create a new empty VMap and return it.

Specified by:

newMap in interface Manager

Returns:

the new VMap created.

newMap

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

Description copied from interface: Manager

Create a new VMap and return it

Specified by:

newMap in interface Manager

Returns:

the new VMap

openMap

public VMap openMap()
             throws MapNotFoundException

Specified by:

openMap in interface Manager

Returns:

the default VMap, if exists

Throws:

MapNotFoundException

openMap

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

Description copied from interface: Manager

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

Specified by:

openMap in interface Manager

refreshElems - says if refresh the map's elements

Returns:

the VMap with identifier id

Throws:

MapsException

MapNotFoundException

openMap

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

Description copied from interface: Manager

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

Specified by:

openMap in interface Manager

refreshElems - says if refresh the map's elements

Returns:

the VMap with identifier id

Throws:

MapsException

MapNotFoundException

refreshElement

public VElement refreshElement(VElement mapElement)
                        throws MapsException

Specified by:

refreshElement in interface Manager

Throws:

MapsException

refreshElements

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

Description copied from interface: Manager

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)

Specified by:

refreshElements in interface Manager

Parameters:

mapElements - the elements to refresh

Returns:

List of VElement

Throws:

MapsException

refreshLinks

public List refreshLinks(VLink[] mapLinks)

Description copied from interface: Manager

TODO write this method simil way to refreshElement Not Yet Implemented

Specified by:

refreshLinks in interface Manager

refreshMap

public List<VElement> refreshMap()
                          throws MapsException

Specified by:

refreshMap in interface Manager

Throws:

MapsException

reloadMap

public VMap reloadMap(VMap map)
               throws MapsException

Description copied from interface: Manager

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

Specified by:

reloadMap in interface Manager

Returns:

the map refreshed

Throws:

MapsException

save

public void save(VMap map)
          throws MapsException

Description copied from interface: Manager

save the map in input

Specified by:

save in interface Manager

Parameters:

map - to save

Throws:

MapsException

save

public void save(VMap[] maps)
          throws MapsException

Description copied from interface: Manager

save the maps in input

Specified by:

save in interface Manager

Parameters:

maps - to save

Throws:

MapsException