com.partnersoft.formats.google

Class GoogleMapBuilder

java.lang.Object

com.partnersoft.formats.google.GoogleMapBuilder

public class GoogleMapBuilder
extends java.lang.Object

Builder for Google Map html files.

No output is generated until build() is called.

Reference at: http://code.google.com/apis/maps/documentation/

Copyright 2009 Partner Software, Inc.

Author:

Rich Stepanski

Constructor Summary

Constructors

Constructor and Description
GoogleMapBuilder(java.io.BufferedOutputStream out, GoogleMapLib.CreationOptions creationOption) Creates a new GoogleMapBuilder writing to the passed BufferedOutputStream.
GoogleMapBuilder(VfsFile destination) Creates a new GoogleMapBuilder writing to the passed VfsFile.
GoogleMapBuilder(VfsFile destination, GoogleMapLib.CreationOptions creationOption) Creates a new GoogleMapBuilder writing to the passed VfsFile.

Method Summary

Methods

Modifier and Type	Method and Description
void	addMapControl(GoogleMapLib.MapComponents component) Adds passed GoogleMapLib.MapComponent.
void	addMarker(double longitude, double latitude, java.lang.String styleName, java.lang.String htmlInfo) Adds GoogleMapMarker to this map.
void	addMarker(GoogleMapMarker marker) Adds GoogleMapMarker to this map.
void	addPolygon(GoogleMapPolygon polygon) Adds the passed GoogleMapPolygon to the map to be generated
void	addPolygon(java.lang.String lineColor, XyPolyline line, int lineWidth, double lineOpacity, java.lang.String fillColor, double fillOpacity) Creates a GoogleMapPolygon from the passed parameters and adds to the map to be generated
void	addPolyline(GoogleMapPolyline line) Adds the passed GoogleMapPolyline to the map to be generated
void	addPolyline(java.lang.String lineColor, XyPolyline polyline, int lineWidth, double lineOpacity) Generates a GoogleMapPolyline from the passed parameters and adds it to the map to be generated
void	build() Generates output to specified destination.
void	setCenter(double longitude, double latitude) Sets the starting center position for the map.
void	setGoogleKey(java.lang.String key) Sets the Google Map key used to allow generated file to be viewable from a non-local location.
void	setHtmlRefresh(int htmlRefreshInSeconds) Sets how often the generated html file should reload itself.
void	setMapHeight(int height) Sets the map height in pixels.
void	setMapOption(GoogleMapLib.MapOptions option, boolean enable) Enables or disables the passed option based on 'enable' value.
void	setMapWidth(int width) Sets the map width in pixels.
void	setMaximumZoom(int zoom) Sets the maximum zoom for all MapTypes The maximum is how far away from the map surface you can get.
void	setMinimumZoom(int zoom) Sets the minimum zoom for all MapTypes.
void	setStyle(java.lang.String styleName, java.lang.String url) Maps the passed style name to the passed url.
void	setTitle(java.lang.String docName) Sets the title for the generated google map.
void	setZoom(double zoom) Sets the starting zoom for the map.

Methods inherited from class java.lang.Object

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

Constructor Detail

GoogleMapBuilder

public GoogleMapBuilder(VfsFile destination)
                 throws java.io.IOException

Creates a new GoogleMapBuilder writing to the passed VfsFile. Defaults to creating a complete html file.

Parameters:

destination - - VfsFile to write to.

Throws:

java.io.IOException - if an exception occurs creation output stream to passed destination.

GoogleMapBuilder

public GoogleMapBuilder(VfsFile destination,
                GoogleMapLib.CreationOptions creationOption)
                 throws java.io.IOException

Creates a new GoogleMapBuilder writing to the passed VfsFile.

Parameters:

destination - - VfsFile to write to.

creationOption - - Flag determining what to build.

Throws:

java.io.IOException - if an exception occurs creation output stream to passed destination.

GoogleMapBuilder

public GoogleMapBuilder(java.io.BufferedOutputStream out,
                GoogleMapLib.CreationOptions creationOption)

Creates a new GoogleMapBuilder writing to the passed BufferedOutputStream.

Parameters:

out - - BufferedOutputStream to write to.

creationOption - - Flag determining what to build.

Method Detail

setCenter

public void setCenter(double longitude,
             double latitude)

Sets the starting center position for the map.

Note, if this method isn't called - the average latitude and longitude of all added objects will be used for center.

Parameters:

longitude - - initial longitude for map center.

latitude - - initial latitude for map center.

setGoogleKey

public void setGoogleKey(java.lang.String key)

Sets the Google Map key used to allow generated file to be viewable from a non-local location.

Key signup can be found at http://code.google.com/apis/maps/signup.html

Parameters:

key - - Google Map key as issued from Google.

setZoom

public void setZoom(double zoom)

Sets the starting zoom for the map.

Parameters:

zoom - - zoom level

setTitle

public void setTitle(java.lang.String docName)

Sets the title for the generated google map.

Parameters:

docName - - Title of document

setStyle

public void setStyle(java.lang.String styleName,
            java.lang.String url)

Maps the passed style name to the passed url. These are the style names that any markers refer to.

Parameters:

styleName - - Name of style to be defined

url - - url of icon

addMapControl

public void addMapControl(GoogleMapLib.MapComponents component)

Adds passed GoogleMapLib.MapComponent.

Default map controls are LARGE_MAP_CONTROL and MAP_TYPE_CONTROL

Parameters:

component - - GoogleMapLib.MapComponent to add to map.

setMapOption

public void setMapOption(GoogleMapLib.MapOptions option,
                boolean enable)

Enables or disables the passed option based on 'enable' value.

Parameters:

option - - GoogleMapLib.MapOptions option to enable/disable

enable - - if true, passed option is enabled. Option is disabled otherwise.

build

public void build()
           throws java.io.IOException

Generates output to specified destination.

Throws:

java.io.IOException - if an exception occurs writing output.

setMapWidth

public void setMapWidth(int width)

Sets the map width in pixels. This is the html map component width.

Parameters:

width - - width of map item

setMapHeight

public void setMapHeight(int height)

Sets the map height in pixels. This is the html map component height.

Parameters:

height - - height of map item

setMinimumZoom

public void setMinimumZoom(int zoom)

Sets the minimum zoom for all MapTypes. The minimum is how close to the map surface you can get. 0 is unlimited.

Parameters:

zoom - - minimum zoom, 0 is unlimited

setMaximumZoom

public void setMaximumZoom(int zoom)

Sets the maximum zoom for all MapTypes The maximum is how far away from the map surface you can get. 0 is unlimited.

Parameters:

zoom - maximum zoom, 0 is unlimited

addMarker

public void addMarker(double longitude,
             double latitude,
             java.lang.String styleName,
             java.lang.String htmlInfo)

Adds GoogleMapMarker to this map.

Parameters:

longitude - - longitude of marker

latitude - - latitude of marker

styleName - - name of style for marker (set via setStyle)

htmlInfo - - html info for marker (info window)

addMarker

public void addMarker(GoogleMapMarker marker)

Adds GoogleMapMarker to this map.

Parameters:

marker - - GoogleMapMarker to add to map

addPolyline

public void addPolyline(java.lang.String lineColor,
               XyPolyline polyline,
               int lineWidth,
               double lineOpacity)

Generates a GoogleMapPolyline from the passed parameters and adds it to the map to be generated

Parameters:

lineColor - - Hexadecimal color of line

polyline - - XyPolyline of line

lineWidth - - width of line

lineOpacity - - opacity of line (0-1) or (0-100 if > 1)

addPolyline

public void addPolyline(GoogleMapPolyline line)

Adds the passed GoogleMapPolyline to the map to be generated

Parameters:

line - - GoogleMapPolyline to add

addPolygon

public void addPolygon(java.lang.String lineColor,
              XyPolyline line,
              int lineWidth,
              double lineOpacity,
              java.lang.String fillColor,
              double fillOpacity)

Creates a GoogleMapPolygon from the passed parameters and adds to the map to be generated

Parameters:

lineColor - - Hexadecimal outline color

line - - XyPolyline describing outline

lineWidth - - width of line

lineOpacity - - opacity of outline (0-1 or 0-100 if > 1)

fillColor - - Hexadecimal fill color

fillOpacity - - opacity of fill (0-1 or 0-100 if > 1)

addPolygon

public void addPolygon(GoogleMapPolygon polygon)

Adds the passed GoogleMapPolygon to the map to be generated

Parameters:

polygon - - GoogleMapPolygon to add

setHtmlRefresh

public void setHtmlRefresh(int htmlRefreshInSeconds)

Sets how often the generated html file should reload itself.

Parameters:

htmlRefreshInSeconds - - Refresh rate for html in seconds