org.opennms.web.map.db

Class DBManager

java.lang.Object

org.opennms.web.map.db.Manager

org.opennms.web.map.db.DBManager

public class DBManager
extends Manager

DBManager class.

Author:

maumig, Antonio Russo, DJ Gregor The class manages maps stored on DB. It uses the constructor parameters for the connection. If default constructor is called, it uses default OpenNMS db connector (Vault)

Field Summary

Fields inherited from class org.opennms.web.map.db.Manager

initialized

Constructor Summary

Constructors

Constructor and Description
DBManager() Constructor for DBManager.
DBManager(Map<String,String> params) Constructor for DBManager.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	closeResultSet(ResultSet rs)
protected void	closeStatement(Statement statement)
int	countMaps(int mapId) countMaps
void	deleteElement(DbElement e) deleteElement
void	deleteElement(int id, int mapid, String type) deleteElement
void	deleteElements(DbElement[] elems) deleteElements
int	deleteMap(int id) delete the map with id in input
void	deleteMapTypeElementsFromAllMaps() deleteMapTypeElementsFromAllMaps
void	deleteNodeTypeElementsFromAllMaps() deleteNodeTypeElementsFromAllMaps
void	finalize(Connection conn) finalize
List<VElementInfo>	getAlarmedElements() getAlarmedElements
Vector<VElementInfo>	getAllElementInfo() getAllElementInfo
DbElement[]	getAllElements() getAllElements
VMapInfo[]	getAllMapMenus() getAllMapMenus
DbMap[]	getAllMaps() getAllMaps
Map<Integer,Double>	getAvails(DbElement[] mapElements) getAvails
DbMap[]	getContainerMaps(int id, String type) getContainerMaps
List<Integer>	getDeletedNodes() gets a Vector containing the nodeids of all deleted nodes
DbElement	getElement(int id, int mapId, String type) getElement
DbElement[]	getElementsLike(String elementLabel) getElementsLike
DbElement[]	getElementsOfMap(int mapid) getElementsOfMap
Set<LinkInfo>	getLinksOnElements(Set<Integer> allnodes) getLinksOnElements
DbMap	getMap(int id) getMap
DbElement[]	getMapElementsOfMap(int mapid) getMapElementsOfMap
VMapInfo	getMapMenu(int mapId) getMapMenu
DbMap[]	getMaps(String mapname, String maptype) getMaps
DbMap[]	getMapsByName(String mapLabel) getMapsByName
DbMap[]	getMapsLike(String mapLabel) getMapsLike
VMapInfo[]	getMapsMenuByGroup(String group) getMapsMenuByGroup
VMapInfo[]	getMapsMenuByName(String mapLabel) getMapsMenuByName
VMapInfo[]	getMapsMenuByOther() getMapsMenuByOther
VMapInfo[]	getMapsMenuByOwner(String owner) getMapsMenuByOwner
Map<Integer,Set<Integer>>	getMapsStructure() getMapsStructure
DbElement[]	getNodeElementsOfMap(int mapid) getNodeElementsOfMap
Set<Integer>	getNodeIdsBySource(String query) getNodeIdsBySource
Set<Integer>	getNodeidsOnElement(DbElement elem) getNodeidsOnElement
boolean	isElementDeleted(int elementId, String type) isElementDeleted
boolean	isElementInMap(int elementId, int mapId, String type) isElementInMap
DbElement	newElement(int id, int mapId, String type) newElement
void	saveElement(DbElement e) saveElement
int	saveMap(DbMap m, Collection<DbElement> e) saveMap

Methods inherited from class java.lang.Object

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

Constructor Detail

DBManager

public DBManager()
          throws MapsException

Constructor for DBManager.

Throws:

MapsException - if any.

DBManager

public DBManager(Map<String,String> params)
          throws MapsException

Constructor for DBManager.

Parameters:

params - a java$util$Map object.

Throws:

MapsException - if any.

Method Detail

closeStatement

protected void closeStatement(Statement statement)

closeResultSet

protected void closeResultSet(ResultSet rs)

finalize

public void finalize(Connection conn)
              throws MapsException

finalize

Parameters:

conn - a Connection object.

Throws:

MapsException - if any.

saveMap

public int saveMap(DbMap m,
          Collection<DbElement> e)
            throws MapsException

saveMap

Specified by:

saveMap in class Manager

Parameters:

m - a DbMap object.

e - a Collection object.

Returns:

a int.

Throws:

MapsException - if any.

saveElement

public void saveElement(DbElement e)
                 throws MapsException

saveElement

Parameters:

e - a DbElement object.

Throws:

MapsException - if any.

deleteElements

public void deleteElements(DbElement[] elems)
                    throws MapsException

deleteElements

Parameters:

elems - an array of DbElement objects.

Throws:

MapsException - if any.

deleteElement

public void deleteElement(DbElement e)
                   throws MapsException

deleteElement

Parameters:

e - a DbElement object.

Throws:

MapsException - if any.

deleteElement

public void deleteElement(int id,
                 int mapid,
                 String type)
                   throws MapsException

deleteElement

Parameters:

id - a int.

mapid - a int.

type - a String object.

Throws:

MapsException - if any.

deleteMap

public int deleteMap(int id)
              throws MapsException

delete the map with id in input

Specified by:

deleteMap in class Manager

Parameters:

id - a int.

Returns:

number of maps deleted

Throws:

MapsException - if any.

deleteNodeTypeElementsFromAllMaps

public void deleteNodeTypeElementsFromAllMaps()
                                       throws MapsException

deleteNodeTypeElementsFromAllMaps

Specified by:

deleteNodeTypeElementsFromAllMaps in class Manager

Throws:

MapsException - if any.

deleteMapTypeElementsFromAllMaps

public void deleteMapTypeElementsFromAllMaps()
                                      throws MapsException

deleteMapTypeElementsFromAllMaps

Specified by:

deleteMapTypeElementsFromAllMaps in class Manager

Throws:

MapsException - if any.

getElement

public DbElement getElement(int id,
                   int mapId,
                   String type)
                     throws MapsException

getElement

Specified by:

getElement in class Manager

Parameters:

id - a int.

mapId - a int.

type - a String object.

Returns:

a DbElement object.

Throws:

MapsException - if any.

newElement

public DbElement newElement(int id,
                   int mapId,
                   String type)
                     throws MapsException

newElement

Specified by:

newElement in class Manager

Parameters:

id - a int.

mapId - a int.

type - a String object.

Returns:

a DbElement object.

Throws:

MapsException - if any.

getAllElements

public DbElement[] getAllElements()
                           throws MapsException

getAllElements

Specified by:

getAllElements in class Manager

Returns:

an array of DbElement objects.

Throws:

MapsException - if any.

getElementsOfMap

public DbElement[] getElementsOfMap(int mapid)
                             throws MapsException

getElementsOfMap

Specified by:

getElementsOfMap in class Manager

Parameters:

mapid - a int.

Returns:

an array of DbElement objects.

Throws:

MapsException - if any.

getNodeElementsOfMap

public DbElement[] getNodeElementsOfMap(int mapid)
                                 throws MapsException

getNodeElementsOfMap

Specified by:

getNodeElementsOfMap in class Manager

Parameters:

mapid - a int.

Returns:

an array of DbElement objects.

Throws:

MapsException - if any.

getMapElementsOfMap

public DbElement[] getMapElementsOfMap(int mapid)
                                throws MapsException

getMapElementsOfMap

Specified by:

getMapElementsOfMap in class Manager

Parameters:

mapid - a int.

Returns:

an array of DbElement objects.

Throws:

MapsException - if any.

getElementsLike

public DbElement[] getElementsLike(String elementLabel)
                            throws MapsException

getElementsLike

Specified by:

getElementsLike in class Manager

Parameters:

elementLabel - a String object.

Returns:

an array of DbElement objects.

Throws:

MapsException - if any.

getMapsStructure

public Map<Integer,Set<Integer>> getMapsStructure()
                                           throws MapsException

getMapsStructure

Specified by:

getMapsStructure in class Manager

Returns:

a java$util$Map object.

Throws:

MapsException - if any.

countMaps

public int countMaps(int mapId)
              throws MapsException

countMaps

Specified by:

countMaps in class Manager

Parameters:

mapId - a int.

Returns:

a int.

Throws:

MapsException - if any.

getMap

public DbMap getMap(int id)
             throws MapsException

getMap

Specified by:

getMap in class Manager

Parameters:

id - a int.

Returns:

a DbMap object.

Throws:

MapsException - if any.

getMaps

public DbMap[] getMaps(String mapname,
              String maptype)
                throws MapsException

getMaps

Specified by:

getMaps in class Manager

Parameters:

mapname - a String object.

maptype - a String object.

Returns:

an array of DbMap objects.

Throws:

MapsException - if any.

getAllMaps

public DbMap[] getAllMaps()
                   throws MapsException

getAllMaps

Specified by:

getAllMaps in class Manager

Returns:

an array of DbMap objects.

Throws:

MapsException - if any.

getMapsLike

public DbMap[] getMapsLike(String mapLabel)
                    throws MapsException

getMapsLike

Specified by:

getMapsLike in class Manager

Parameters:

mapLabel - a String object.

Returns:

an array of DbMap objects.

Throws:

MapsException - if any.

getMapsByName

public DbMap[] getMapsByName(String mapLabel)
                      throws MapsException

getMapsByName

Specified by:

getMapsByName in class Manager

Parameters:

mapLabel - a String object.

Returns:

an array of DbMap objects.

Throws:

MapsException - if any.

getContainerMaps

public DbMap[] getContainerMaps(int id,
                       String type)
                         throws MapsException

getContainerMaps

Specified by:

getContainerMaps in class Manager

Parameters:

id - a int.

type - a String object.

Returns:

an array of DbMap objects.

Throws:

MapsException - if any.

getAllMapMenus

public VMapInfo[] getAllMapMenus()
                          throws MapsException

getAllMapMenus

Specified by:

getAllMapMenus in class Manager

Returns:

an array of VMapInfo objects.

Throws:

MapsException - if any.

getMapMenu

public VMapInfo getMapMenu(int mapId)
                    throws MapsException

getMapMenu

Specified by:

getMapMenu in class Manager

Parameters:

mapId - a int.

Returns:

a VMapInfo object.

Throws:

MapsException - if any.

getMapsMenuByName

public VMapInfo[] getMapsMenuByName(String mapLabel)
                             throws MapsException

getMapsMenuByName

Specified by:

getMapsMenuByName in class Manager

Parameters:

mapLabel - a String object.

Returns:

an array of VMapInfo objects.

Throws:

MapsException - if any.

getMapsMenuByOwner

public VMapInfo[] getMapsMenuByOwner(String owner)
                              throws MapsException

getMapsMenuByOwner

Specified by:

getMapsMenuByOwner in class Manager

Parameters:

owner - a String object.

Returns:

an array of VMapInfo objects.

Throws:

MapsException - if any.

getMapsMenuByGroup

public VMapInfo[] getMapsMenuByGroup(String group)
                              throws MapsException

getMapsMenuByGroup

Specified by:

getMapsMenuByGroup in class Manager

Parameters:

group - a String object.

Returns:

an array of VMapInfo objects.

Throws:

MapsException - if any.

getMapsMenuByOther

public VMapInfo[] getMapsMenuByOther()
                              throws MapsException

getMapsMenuByOther

Specified by:

getMapsMenuByOther in class Manager

Returns:

an array of VMapInfo objects.

Throws:

MapsException - if any.

isElementInMap

public boolean isElementInMap(int elementId,
                     int mapId,
                     String type)
                       throws MapsException

isElementInMap

Specified by:

isElementInMap in class Manager

Parameters:

elementId - a int.

mapId - a int.

type - a String object.

Returns:

a boolean.

Throws:

MapsException - if any.

getAllElementInfo

public Vector<VElementInfo> getAllElementInfo()
                                       throws MapsException

getAllElementInfo

Specified by:

getAllElementInfo in class Manager

Returns:

a Vector object.

Throws:

MapsException - if any.

getAlarmedElements

public List<VElementInfo> getAlarmedElements()
                                      throws MapsException

getAlarmedElements

Specified by:

getAlarmedElements in class Manager

Returns:

a List object.

Throws:

MapsException - if any.

getAvails

public Map<Integer,Double> getAvails(DbElement[] mapElements)
                              throws MapsException

getAvails

Specified by:

getAvails in class Manager

Parameters:

mapElements - an array of DbElement objects.

Returns:

a java$util$Map object.

Throws:

MapsException - if any.

getDeletedNodes

public List<Integer> getDeletedNodes()
                              throws MapsException

gets a Vector containing the nodeids of all deleted nodes

Specified by:

getDeletedNodes in class Manager

Returns:

Vector of Integer containing all deleted nodes' ids

Throws:

MapsException - if any.

getNodeidsOnElement

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

getNodeidsOnElement

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

Specified by:

getNodeidsOnElement in class Manager

Parameters:

elem - a DbElement object.

Returns:

a Set object.

Throws:

MapsException - if any.

getLinksOnElements

public Set<LinkInfo> getLinksOnElements(Set<Integer> allnodes)
                                 throws MapsException

getLinksOnElements

Specified by:

getLinksOnElements in class Manager

Parameters:

allnodes - a Set object.

Returns:

a Set object.

Throws:

MapsException - if any.

getNodeIdsBySource

public Set<Integer> getNodeIdsBySource(String query)
                                throws MapsException

getNodeIdsBySource

Specified by:

getNodeIdsBySource in class Manager

Parameters:

query - a String object.

Returns:

a Set object.

Throws:

MapsException - if any.

isElementDeleted

public boolean isElementDeleted(int elementId,
                       String type)
                         throws MapsException

isElementDeleted

Specified by:

isElementDeleted in class Manager

Parameters:

elementId - a int.

type - a String object.

Returns:

a boolean.

Throws:

MapsException - if any.