it.eng.spagobi.engines.geo.map.provider
Interface IMapProvider

All Superinterfaces:
IGeoEngineComponent
All Known Implementing Classes:
AbstractMapProvider, SOMapProvider

public interface IMapProvider
extends IGeoEngineComponent

The Interface IMapProvider.

Author:
Andrea Gioia (andrea.gioia@eng.it)

Method Summary
 java.util.List getFeatureNamesInMap(java.lang.String mapName)
          Gets the feature names in map.
 java.util.List getMapNamesByFeature(java.lang.String featureName)
          Gets the map names by feature.
 java.lang.String getSelectedMapName()
          Gets the selected map name.
 org.w3c.dom.svg.SVGDocument getSVGMapDOMDocument()
          Gets the sVG map dom document.
 org.w3c.dom.svg.SVGDocument getSVGMapDOMDocument(java.lang.String mapName)
          Gets the sVG map dom document.
 javax.xml.stream.XMLStreamReader getSVGMapStreamReader()
          Gets the sVG map stream reader.
 javax.xml.stream.XMLStreamReader getSVGMapStreamReader(java.lang.String mapName)
          Gets the sVG map stream reader.
 void setSelectedMapName(java.lang.String mapName)
          Sets the selected map name.
 
Methods inherited from interface it.eng.spagobi.engines.geo.component.IGeoEngineComponent
init, setEnv
 

Method Detail

getSVGMapStreamReader

javax.xml.stream.XMLStreamReader getSVGMapStreamReader()
                                                       throws GeoEngineException
Gets the sVG map stream reader.

Returns:
the sVG map stream reader
Throws:
GeoEngineException - the geo engine exception

getSVGMapStreamReader

javax.xml.stream.XMLStreamReader getSVGMapStreamReader(java.lang.String mapName)
                                                       throws GeoEngineException
Gets the sVG map stream reader.

Parameters:
mapName - the map name
Returns:
the sVG map stream reader
Throws:
GeoEngineException - the geo engine exception

getSVGMapDOMDocument

org.w3c.dom.svg.SVGDocument getSVGMapDOMDocument()
                                                 throws GeoEngineException
Gets the sVG map dom document.

Returns:
the sVG map dom document
Throws:
GeoEngineException - the geo engine exception

getSVGMapDOMDocument

org.w3c.dom.svg.SVGDocument getSVGMapDOMDocument(java.lang.String mapName)
                                                 throws GeoEngineException
Gets the sVG map dom document.

Parameters:
mapName - the map name
Returns:
the sVG map dom document
Throws:
GeoEngineException - the geo engine exception

getSelectedMapName

java.lang.String getSelectedMapName()
Gets the selected map name.

Returns:
the selected map name

setSelectedMapName

void setSelectedMapName(java.lang.String mapName)
Sets the selected map name.

Parameters:
mapName - the new selected map name

getMapNamesByFeature

java.util.List getMapNamesByFeature(java.lang.String featureName)
                                    throws java.lang.Exception
Gets the map names by feature.

Parameters:
featureName - the feature name
Returns:
the map names by feature
Throws:
java.lang.Exception - the exception

getFeatureNamesInMap

java.util.List getFeatureNamesInMap(java.lang.String mapName)
                                    throws java.lang.Exception
Gets the feature names in map.

Parameters:
mapName - the map name
Returns:
the feature names in map
Throws:
java.lang.Exception - the exception