com.nutiteq.kml
Class KmlUrlReader

java.lang.Object
  extended by com.nutiteq.kml.KmlUrlReader
All Implemented Interfaces:
KmlService

public class KmlUrlReader
extends java.lang.Object
implements KmlService

Basic KML URL reader, adds standard BBOX, zoom and max=10 parameters in default way. Usage example with MapItem:
mapItem.addKmlService(new KmlUrlReader("http://www.panoramio.com/panoramio.kml?LANG=en_US.utf8&",true));


Constructor Summary
KmlUrlReader(java.lang.String kmlUrl, boolean needsUpdateAfterRead)
          Constructor for the built-in KML reader.
KmlUrlReader(java.lang.String kmlUrl, int maxElements, boolean needsUpdateAfterRead)
          Constructor for the built-in KML reader.
KmlUrlReader(java.lang.String kmlUrl, int maxElements, boolean needsUpdateAfterRead, boolean serverSideRender)
          Constructor for the built-in KML reader.
KmlUrlReader(java.lang.String kmlUrl, int maxElements, boolean needsUpdateAfterRead, boolean serverSideRender, java.lang.String defaultIcon)
          Constructor for the built-in KML reader.
KmlUrlReader(java.lang.String kmlUrl, int maxElements, boolean needsUpdateAfterRead, java.lang.String defaultIcon)
          Constructor for the built-in KML reader.
 
Method Summary
 java.lang.String getDefaultIcon()
           
 com.nutiteq.kml.KmlReadListener getPlaceReadListener()
           
 java.lang.String getServiceUrl(WgsBoundingBox boundingBox, int zoom)
          Called after if needsUpdate has returned true.
 int maxResults()
          Maximum number of results returned from this service.
 boolean needsUpdate(WgsBoundingBox boundingBox, int zoom)
          Does the service need an update.
 void placesAdded()
           
 void resetRead()
           
 boolean serverSideRender()
           
 void setPlaceReadListener(com.nutiteq.kml.KmlReadListener placeReadListener)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

KmlUrlReader

public KmlUrlReader(java.lang.String kmlUrl,
                    boolean needsUpdateAfterRead)
Constructor for the built-in KML reader. Asks for 10 items.

Parameters:
kmlUrl - URL where to read the KML
needsUpdateAfterRead - true if KML service is dynamic (in time and regarding BBOX), false otherwise

KmlUrlReader

public KmlUrlReader(java.lang.String kmlUrl,
                    int maxElements,
                    boolean needsUpdateAfterRead)
Constructor for the built-in KML reader.

Parameters:
kmlUrl - URL where to read the KML
maxElements - how many elements to request from server.
needsUpdateAfterRead - true if KML service is dynamic (in time and regarding BBOX), false otherwise

KmlUrlReader

public KmlUrlReader(java.lang.String kmlUrl,
                    int maxElements,
                    boolean needsUpdateAfterRead,
                    java.lang.String defaultIcon)
Constructor for the built-in KML reader.

Parameters:
kmlUrl - URL where to read the KML
maxElements - how many elements to request from server.
needsUpdateAfterRead - true if KML service is dynamic (in time and regarding BBOX), false otherwise
defaultIcon - default marker image location for the KML places

KmlUrlReader

public KmlUrlReader(java.lang.String kmlUrl,
                    int maxElements,
                    boolean needsUpdateAfterRead,
                    boolean serverSideRender)
Constructor for the built-in KML reader.

Parameters:
kmlUrl - URL where to read the KML
maxElements - how many elements to request from server.
needsUpdateAfterRead - true if KML service is dynamic (in time and regarding BBOX), false otherwise
serverSideRender - are elements drawn on map server side

KmlUrlReader

public KmlUrlReader(java.lang.String kmlUrl,
                    int maxElements,
                    boolean needsUpdateAfterRead,
                    boolean serverSideRender,
                    java.lang.String defaultIcon)
Constructor for the built-in KML reader.

Parameters:
kmlUrl - URL where to read the KML
maxElements - how many elements to request from server.
needsUpdateAfterRead - true if KML service is dynamic (in time and regarding BBOX), false otherwise
serverSideRender - are elements drawn on map server side
Method Detail

getDefaultIcon

public java.lang.String getDefaultIcon()
Specified by:
getDefaultIcon in interface KmlService

getServiceUrl

public java.lang.String getServiceUrl(WgsBoundingBox boundingBox,
                                      int zoom)
Description copied from interface: KmlService
Called after if needsUpdate has returned true.

Specified by:
getServiceUrl in interface KmlService
Parameters:
boundingBox - bounding box for screen view of the map (coordinates in WGS84)
zoom - zoom level used
Returns:
url for retrieving displayed kml.

maxResults

public int maxResults()
Description copied from interface: KmlService
Maximum number of results returned from this service. If, for some reason, server returns more results, extra results will be ignored.

Specified by:
maxResults in interface KmlService
Returns:
number of placemarks returned by this service on one request.

needsUpdate

public boolean needsUpdate(WgsBoundingBox boundingBox,
                           int zoom)
Description copied from interface: KmlService
Does the service need an update. Called after move method.

Specified by:
needsUpdate in interface KmlService
Parameters:
boundingBox - bounding box for new map location (coordinates in WGS84)
zoom - current zoom level
Returns:
does the service need an update

resetRead

public void resetRead()

serverSideRender

public boolean serverSideRender()

placesAdded

public void placesAdded()
Specified by:
placesAdded in interface KmlService

getPlaceReadListener

public com.nutiteq.kml.KmlReadListener getPlaceReadListener()

setPlaceReadListener

public void setPlaceReadListener(com.nutiteq.kml.KmlReadListener placeReadListener)
Specified by:
setPlaceReadListener in interface KmlService