org.mapsforge.map.writer.model

Class MapWriterConfiguration

java.lang.Object

org.mapsforge.map.writer.model.MapWriterConfiguration

public class MapWriterConfiguration
extends java.lang.Object

Configuration for the map file writer.

Constructor Summary

Constructors

Constructor and Description
MapWriterConfiguration()

Method Summary

Modifier and Type	Method and Description
void	addBboxConfiguration(java.lang.String bbox) Convenience method.
void	addEncodingChoice(java.lang.String encoding) Convenience method.
void	addMapStartPosition(java.lang.String position) Convenience method.
void	addMapStartZoom(java.lang.String zoom) Convenience method.
void	addOutputFile(java.lang.String file) Convenience method.
void	addPreferredLanguages(java.lang.String preferredLanguages) Convenience method.
void	addZoomIntervalConfiguration(java.lang.String zoomIntervalConfiguaration) Convenience method.
org.mapsforge.core.model.BoundingBox	getBboxConfiguration()
int	getBboxEnlargement()
java.lang.String	getComment()
java.lang.String	getDataProcessorType()
EncodingChoice	getEncodingChoice()
int	getFileSpecificationVersion()
org.mapsforge.core.model.LatLong	getMapStartPosition()
int	getMapStartZoomLevel()
java.io.File	getOutputFile()
java.util.List<java.lang.String>	getPreferredLanguages()
double	getSimplification()
byte	getSimplificationMaxZoom()
OSMTagMapping	getTagMapping()
int	getThreads()
java.lang.String	getWriterVersion()
ZoomIntervalConfiguration	getZoomIntervalConfiguration()
boolean	hasMapStartZoomLevel() Convenience method.
boolean	isDebugStrings()
boolean	isLabelPosition()
boolean	isPolygonClipping()
boolean	isSkipInvalidRelations()
boolean	isTagValues()
boolean	isWayClipping()
void	loadTagMappingFile(java.lang.String file) Convenience method.
void	setBboxConfiguration(org.mapsforge.core.model.BoundingBox bboxConfiguration)
void	setBboxEnlargement(int bboxEnlargement)
void	setComment(java.lang.String comment)
void	setDataProcessorType(java.lang.String dataProcessorType)
void	setDebugStrings(boolean debugStrings)
void	setEncodingChoice(EncodingChoice encodingChoice)
void	setFileSpecificationVersion(int fileSpecificationVersion)
void	setLabelPosition(boolean labelPosition)
void	setMapStartPosition(org.mapsforge.core.model.LatLong mapStartPosition)
void	setMapStartZoomLevel(int mapStartZoomLevel)
void	setOutputFile(java.io.File outputFile)
void	setPolygonClipping(boolean polygonClipping)
void	setPreferredLanguages(java.util.List<java.lang.String> preferredLanguages)
void	setSimplification(double simplification)
void	setSimplificationMaxZoom(byte simplificationMaxZoom)
void	setSkipInvalidRelations(boolean skipInvalidRelations)
void	setTagValues(boolean tagValues)
void	setThreads(int threads)
void	setWayClipping(boolean wayClipping)
void	setWriterVersion(java.lang.String writerVersion)
void	setZoomIntervalConfiguration(ZoomIntervalConfiguration zoomIntervalConfiguration)
void	validate() Validates this configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapWriterConfiguration

public MapWriterConfiguration()

Method Detail

addBboxConfiguration

public void addBboxConfiguration(java.lang.String bbox)

Convenience method.

Parameters:

bbox - the bounding box specification in format minLat, minLon, maxLat, maxLon in exactly this order as degrees

addEncodingChoice

public void addEncodingChoice(java.lang.String encoding)

Convenience method.

Parameters:

encoding - the choice for the encoding, either auto, single or double are valid parameters

addMapStartPosition

public void addMapStartPosition(java.lang.String position)

Convenience method.

Parameters:

position - the map start position in format latitude, longitude

addMapStartZoom

public void addMapStartZoom(java.lang.String zoom)

Convenience method.

Parameters:

zoom - the map start zoom level

addOutputFile

public void addOutputFile(java.lang.String file)

Convenience method.

Parameters:

file - the path to the output file

addPreferredLanguages

public void addPreferredLanguages(java.lang.String preferredLanguages)

Convenience method.

Parameters:

preferredLanguages - the preferred language(s) separated with ','

addZoomIntervalConfiguration

public void addZoomIntervalConfiguration(java.lang.String zoomIntervalConfiguaration)

Convenience method.

Parameters:

zoomIntervalConfiguaration - the zoom interval configuration

getBboxConfiguration

public org.mapsforge.core.model.BoundingBox getBboxConfiguration()

Returns:

the bboxConfiguration

getBboxEnlargement

public int getBboxEnlargement()

Returns:

the bboxEnlargement

getComment

public java.lang.String getComment()

Returns:

the comment

getDataProcessorType

public java.lang.String getDataProcessorType()

Returns:

the dataProcessorType

getEncodingChoice

public EncodingChoice getEncodingChoice()

Returns:

the encodingChoice

getFileSpecificationVersion

public int getFileSpecificationVersion()

Returns:

the fileSpecificationVersion

getMapStartPosition

public org.mapsforge.core.model.LatLong getMapStartPosition()

Returns:

the mapStartPosition

getMapStartZoomLevel

public int getMapStartZoomLevel()

Returns:

the mapStartZoomLevel

getOutputFile

public java.io.File getOutputFile()

Returns:

the outputFile

getPreferredLanguages

public java.util.List<java.lang.String> getPreferredLanguages()

Returns:

the preferred language(s)

getSimplification

public double getSimplification()

Returns:

the simplification

getSimplificationMaxZoom

public byte getSimplificationMaxZoom()

Returns:

the simplification map zoom

getTagMapping

public OSMTagMapping getTagMapping()

Returns:

the tagMapping

getThreads

public int getThreads()

Returns:

the threads

getWriterVersion

public java.lang.String getWriterVersion()

Returns:

the writerVersion

getZoomIntervalConfiguration

public ZoomIntervalConfiguration getZoomIntervalConfiguration()

Returns:

the zoomIntervalConfiguration

hasMapStartZoomLevel

public boolean hasMapStartZoomLevel()

Convenience method.

Returns:

true if map start zoom level is set

isDebugStrings

public boolean isDebugStrings()

Returns:

the debugStrings

isLabelPosition

public boolean isLabelPosition()

Returns:

the labelPosition

isPolygonClipping

public boolean isPolygonClipping()

Returns:

the polygonClipping

isSkipInvalidRelations

public boolean isSkipInvalidRelations()

Returns:

the skipInvalidRelations

isTagValues

public boolean isTagValues()

Returns:

the tagValues

isWayClipping

public boolean isWayClipping()

Returns:

the wayClipping

loadTagMappingFile

public void loadTagMappingFile(java.lang.String file)

Convenience method.

Parameters:

file - the path to the output file

setBboxConfiguration

public void setBboxConfiguration(org.mapsforge.core.model.BoundingBox bboxConfiguration)

Parameters:

bboxConfiguration - the bboxConfiguration to set

setBboxEnlargement

public void setBboxEnlargement(int bboxEnlargement)

Parameters:

bboxEnlargement - the bboxEnlargement to set

setComment

public void setComment(java.lang.String comment)

Parameters:

comment - the comment to set

setDataProcessorType

public void setDataProcessorType(java.lang.String dataProcessorType)

Parameters:

dataProcessorType - the dataProcessorType to set

setDebugStrings

public void setDebugStrings(boolean debugStrings)

Parameters:

debugStrings - the debugStrings to set

setEncodingChoice

public void setEncodingChoice(EncodingChoice encodingChoice)

Parameters:

encodingChoice - the encodingChoice to set

setFileSpecificationVersion

public void setFileSpecificationVersion(int fileSpecificationVersion)

Parameters:

fileSpecificationVersion - the fileSpecificationVersion to set

setLabelPosition

public void setLabelPosition(boolean labelPosition)

Parameters:

labelPosition - the labelPosition to set

setMapStartPosition

public void setMapStartPosition(org.mapsforge.core.model.LatLong mapStartPosition)

Parameters:

mapStartPosition - the mapStartPosition to set

setMapStartZoomLevel

public void setMapStartZoomLevel(int mapStartZoomLevel)

Parameters:

mapStartZoomLevel - the mapStartZoomLevel to set

setOutputFile

public void setOutputFile(java.io.File outputFile)

Parameters:

outputFile - the outputFile to set

setPolygonClipping

public void setPolygonClipping(boolean polygonClipping)

Parameters:

polygonClipping - the polygonClipping to set

setPreferredLanguages

public void setPreferredLanguages(java.util.List<java.lang.String> preferredLanguages)

Parameters:

preferredLanguages - the preferred language(s) to set

setSimplification

public void setSimplification(double simplification)

Parameters:

simplification - the simplification to set

setSimplificationMaxZoom

public void setSimplificationMaxZoom(byte simplificationMaxZoom)

Parameters:

simplificationMaxZoom - the simplification max zoom to set

setSkipInvalidRelations

public void setSkipInvalidRelations(boolean skipInvalidRelations)

Parameters:

skipInvalidRelations - the skipInvalidRelations to set

setTagValues

public void setTagValues(boolean tagValues)

Parameters:

tagValues - the tagValues to set

setThreads

public void setThreads(int threads)

Parameters:

threads - the threads to set

setWayClipping

public void setWayClipping(boolean wayClipping)

Parameters:

wayClipping - the wayClipping to set

setWriterVersion

public void setWriterVersion(java.lang.String writerVersion)

Parameters:

writerVersion - the writerVersion to set

setZoomIntervalConfiguration

public void setZoomIntervalConfiguration(ZoomIntervalConfiguration zoomIntervalConfiguration)

Parameters:

zoomIntervalConfiguration - the zoomIntervalConfiguration to set

validate

public void validate()

Validates this configuration.

Throws:

java.lang.IllegalArgumentException - thrown if configuration is invalid