MapWriterConfiguration (mapsforge-map-writer 0.5.0-rc3 API)

java.lang.Object
- org.mapsforge.map.writer.model.MapWriterConfiguration

public class MapWriterConfiguration
extends Object

Configuration for the map file writer.

Constructor Summary

Constructors
Constructor and Description

MapWriterConfiguration()

Constructors
Constructor and Description
`MapWriterConfiguration()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addBboxConfiguration(String bbox)` Convenience method.
`void`	`addEncodingChoice(String encoding)` Convenience method.
`void`	`addMapStartPosition(String position)` Convenience method.
`void`	`addMapStartZoom(String zoom)` Convenience method.
`void`	`addOutputFile(String file)` Convenience method.
`void`	`addZoomIntervalConfiguration(String zoomIntervalConfiguaration)` Convenience method.
`BoundingBox`	`getBboxConfiguration()`
`int`	`getBboxEnlargement()`
`String`	`getComment()`
`String`	`getDataProcessorType()`
`long`	`getDate()`
`EncodingChoice`	`getEncodingChoice()`
`int`	`getFileSpecificationVersion()`
`LatLong`	`getMapStartPosition()`
`int`	`getMapStartZoomLevel()`
`File`	`getOutputFile()`
`String`	`getPreferredLanguage()`
`double`	`getSimplification()`
`OSMTagMapping`	`getTagMapping()`
`String`	`getWriterVersion()`
`ZoomIntervalConfiguration`	`getZoomIntervalConfiguration()`
`boolean`	`hasMapStartZoomLevel()` Convenience method.
`boolean`	`isDebugStrings()`
`boolean`	`isLabelPosition()`
`boolean`	`isPolygonClipping()`
`boolean`	`isSkipInvalidRelations()`
`boolean`	`isWayClipping()`
`void`	`loadTagMappingFile(String file)` Convenience method.
`void`	`setBboxConfiguration(BoundingBox bboxConfiguration)`
`void`	`setBboxEnlargement(int bboxEnlargement)`
`void`	`setComment(String comment)`
`void`	`setDataProcessorType(String dataProcessorType)`
`void`	`setDate(long date)`
`void`	`setDebugStrings(boolean debugStrings)`
`void`	`setEncodingChoice(EncodingChoice encodingChoice)`
`void`	`setFileSpecificationVersion(int fileSpecificationVersion)`
`void`	`setLabelPosition(boolean labelPosition)`
`void`	`setMapStartPosition(LatLong mapStartPosition)`
`void`	`setMapStartZoomLevel(int mapStartZoomLevel)`
`void`	`setOutputFile(File outputFile)`
`void`	`setPolygonClipping(boolean polygonClipping)`
`void`	`setPreferredLanguage(String preferredLanguage)`
`void`	`setSimplification(double simplification)`
`void`	`setSkipInvalidRelations(boolean skipInvalidRelations)`
`void`	`setWayClipping(boolean wayClipping)`
`void`	`setWriterVersion(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(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(String encoding)
```
    Convenience method.
    
    Parameters:
    encoding - the choice for the encoding, either auto, single or double are valid parameters
  - addMapStartPosition
```
public void addMapStartPosition(String position)
```
    Convenience method.
    
    Parameters:
    position - the map start position in format latitude, longitude
  - addMapStartZoom
```
public void addMapStartZoom(String zoom)
```
    Convenience method.
    
    Parameters:
    zoom - the map start zoom level
  - addOutputFile
```
public void addOutputFile(String file)
```
    Convenience method.
    
    Parameters:
    file - the path to the output file
  - addZoomIntervalConfiguration
```
public void addZoomIntervalConfiguration(String zoomIntervalConfiguaration)
```
    Convenience method.
    
    Parameters:
    zoomIntervalConfiguaration - the zoom interval configuration
  - getBboxConfiguration
```
public BoundingBox getBboxConfiguration()
```
    Returns:
    the bboxConfiguration
  - getBboxEnlargement
```
public int getBboxEnlargement()
```
    Returns:
    the bboxEnlargement
  - getComment
```
public String getComment()
```
    Returns:
    the comment
  - getDataProcessorType
```
public String getDataProcessorType()
```
    Returns:
    the dataProcessorType
  - getDate
```
public long getDate()
```
    Returns:
    the date
  - getEncodingChoice
```
public EncodingChoice getEncodingChoice()
```
    Returns:
    the encodingChoice
  - getFileSpecificationVersion
```
public int getFileSpecificationVersion()
```
    Returns:
    the fileSpecificationVersion
  - getMapStartPosition
```
public LatLong getMapStartPosition()
```
    Returns:
    the mapStartPosition
  - getMapStartZoomLevel
```
public int getMapStartZoomLevel()
```
    Returns:
    the mapStartZoomLevel
  - getOutputFile
```
public File getOutputFile()
```
    Returns:
    the outputFile
  - getPreferredLanguage
```
public String getPreferredLanguage()
```
    Returns:
    the preferredLanguage
  - getSimplification
```
public double getSimplification()
```
    Returns:
    the simplification
  - getTagMapping
```
public OSMTagMapping getTagMapping()
```
    Returns:
    the tagMapping
  - getWriterVersion
```
public 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
  - isWayClipping
```
public boolean isWayClipping()
```
    Returns:
    the wayClipping
  - loadTagMappingFile
```
public void loadTagMappingFile(String file)
```
    Convenience method.
    
    Parameters:
    file - the path to the output file
  - setBboxConfiguration
```
public void setBboxConfiguration(BoundingBox bboxConfiguration)
```
    Parameters:
    bboxConfiguration - the bboxConfiguration to set
  - setBboxEnlargement
```
public void setBboxEnlargement(int bboxEnlargement)
```
    Parameters:
    bboxEnlargement - the bboxEnlargement to set
  - setComment
```
public void setComment(String comment)
```
    Parameters:
    comment - the comment to set
  - setDataProcessorType
```
public void setDataProcessorType(String dataProcessorType)
```
    Parameters:
    dataProcessorType - the dataProcessorType to set
  - setDate
```
public void setDate(long date)
```
    Parameters:
    date - the date 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(LatLong mapStartPosition)
```
    Parameters:
    mapStartPosition - the mapStartPosition to set
  - setMapStartZoomLevel
```
public void setMapStartZoomLevel(int mapStartZoomLevel)
```
    Parameters:
    mapStartZoomLevel - the mapStartZoomLevel to set
  - setOutputFile
```
public void setOutputFile(File outputFile)
```
    Parameters:
    outputFile - the outputFile to set
  - setPolygonClipping
```
public void setPolygonClipping(boolean polygonClipping)
```
    Parameters:
    polygonClipping - the polygonClipping to set
  - setPreferredLanguage
```
public void setPreferredLanguage(String preferredLanguage)
```
    Parameters:
    preferredLanguage - the preferredLanguage to set
  - setSimplification
```
public void setSimplification(double simplification)
```
    Parameters:
    simplification - the simplification to set
  - setSkipInvalidRelations
```
public void setSkipInvalidRelations(boolean skipInvalidRelations)
```
    Parameters:
    skipInvalidRelations - the skipInvalidRelations to set
  - setWayClipping
```
public void setWayClipping(boolean wayClipping)
```
    Parameters:
    wayClipping - the wayClipping to set
  - setWriterVersion
```
public void setWriterVersion(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:
    
    IllegalArgumentException - thrown if configuration is invalid

Class MapWriterConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MapWriterConfiguration

Method Detail

addBboxConfiguration

addEncodingChoice

addMapStartPosition

addMapStartZoom

addOutputFile

addZoomIntervalConfiguration

getBboxConfiguration

getBboxEnlargement

getComment

getDataProcessorType

getDate

getEncodingChoice

getFileSpecificationVersion

getMapStartPosition

getMapStartZoomLevel

getOutputFile

getPreferredLanguage

getSimplification

getTagMapping

getWriterVersion

getZoomIntervalConfiguration

hasMapStartZoomLevel

isDebugStrings

isLabelPosition

isPolygonClipping

isSkipInvalidRelations

isWayClipping

loadTagMappingFile

setBboxConfiguration

setBboxEnlargement

setComment

setDataProcessorType

setDate

setDebugStrings

setEncodingChoice

setFileSpecificationVersion

setLabelPosition

setMapStartPosition

setMapStartZoomLevel

setOutputFile

setPolygonClipping

setPreferredLanguage

setSimplification

setSkipInvalidRelations

setWayClipping

setWriterVersion

setZoomIntervalConfiguration

validate