Package org.goplanit.io.xml.util

Class PlanitXmlWriterSettings

java.lang.Object

org.goplanit.converter.FileBasedConverterWriterSettings

org.goplanit.converter.SingleFileBasedConverterWriterSettings

org.goplanit.io.xml.util.PlanitXmlWriterSettings

All Implemented Interfaces:

ConverterWriterSettings

Direct Known Subclasses:

PlanitDemandsWriterSettings, PlanitNetworkWriterSettings, PlanitRoutedServicesWriterSettings, PlanitServiceNetworkWriterSettings, PlanitZoningWriterSettings

public class PlanitXmlWriterSettings
extends SingleFileBasedConverterWriterSettings

Settings relevant for persisting Planit Xml output

Author:

markr

Field Summary

Fields

Modifier and Type	Field	Description
protected Character	commaSeparator	tuple separator, default is CharacterUtils.COMMA
protected DecimalFormat	decimalFormat	number of decimals to use, default is Precision.DEFAULT_DECIMAL_FORMAT
protected Character	decimalSeparator	decimal separator, default is CharacterUtils.DECIMAL_POINT
protected Character	tupleSeparator	tuple separator, default is CharacterUtils.SPACE

Fields inherited from class org.goplanit.converter.FileBasedConverterWriterSettings

DEFAULT_COUNTRY, destinationCoordinateReferenceSystem

Constructor Summary

Constructors

Constructor	Description
PlanitXmlWriterSettings()	Default constructor
PlanitXmlWriterSettings(String outputPathDirectory)	Constructor
PlanitXmlWriterSettings(String outputPathDirectory, String countryName)	Constructor
PlanitXmlWriterSettings(String outputPathDirectory, String fileName, String countryName)	Constructor

Method Summary

Modifier and Type	Method	Description
Character	getCommaSeparator()	Separator to use for separating x,y entries of a single coordinate that is being persisted
DecimalFormat	getDecimalFormat()	Collect number of decimals used in writing double values
Character	getDecimalSeparator()	Separator to use for separating decimals from unit changes
Character	getTupleSeparator()	Separator to use for tuples of coordinates that are being persisted
void	logSettings()	Convenience method to log all the current settings
void	reset()	Reset content
void	setCommaSeparator(Character commaSeparator)	Set separator
void	setDecimalFormat(DecimalFormat decimalFormat)	Set number of decimals used in writing double values
void	setDecimalSeparator(Character decimalSeparator)	Set separator
void	setTupleSeparator(Character tupleSeparator)	Set separator
protected boolean	validate()	Validate the settings

Methods inherited from class org.goplanit.converter.SingleFileBasedConverterWriterSettings

getFileName, setFileName

Methods inherited from class org.goplanit.converter.FileBasedConverterWriterSettings

getCountry, getDestinationCoordinateReferenceSystem, getOutputDirectory, setCountry, setDestinationCoordinateReferenceSystem, setOutputDirectory

Methods inherited from class java.lang.Object

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

Field Detail

decimalFormat

protected DecimalFormat decimalFormat

number of decimals to use, default is Precision.DEFAULT_DECIMAL_FORMAT

tupleSeparator

protected Character tupleSeparator

tuple separator, default is CharacterUtils.SPACE

commaSeparator

protected Character commaSeparator

tuple separator, default is CharacterUtils.COMMA

decimalSeparator

protected Character decimalSeparator

decimal separator, default is CharacterUtils.DECIMAL_POINT

Constructor Detail

PlanitXmlWriterSettings

public PlanitXmlWriterSettings()

Default constructor

PlanitXmlWriterSettings

public PlanitXmlWriterSettings(String outputPathDirectory)

Constructor

Parameters:

outputPathDirectory - to use

PlanitXmlWriterSettings

public PlanitXmlWriterSettings(String outputPathDirectory,
                               String countryName)

Constructor

Parameters:

outputPathDirectory - to use

countryName - to use

PlanitXmlWriterSettings

public PlanitXmlWriterSettings(String outputPathDirectory,
                               String fileName,
                               String countryName)

Constructor

Parameters:

outputPathDirectory - to use

fileName - to use

countryName - to use

Method Detail

validate

protected boolean validate()

Validate the settings

Overrides:

validate in class SingleFileBasedConverterWriterSettings

Returns:

true when valid, false otherwise

logSettings

public void logSettings()

Convenience method to log all the current settings

Overrides:

logSettings in class SingleFileBasedConverterWriterSettings

getDecimalFormat

public DecimalFormat getDecimalFormat()

Collect number of decimals used in writing double values

Returns:

number of decimals used

setDecimalFormat

public void setDecimalFormat(DecimalFormat decimalFormat)

Set number of decimals used in writing double values

Parameters:

decimalFormat - number of decimals

getTupleSeparator

public Character getTupleSeparator()

Separator to use for tuples of coordinates that are being persisted

Returns:

separator

setTupleSeparator

public void setTupleSeparator(Character tupleSeparator)

Set separator

Parameters:

tupleSeparator - to use

getCommaSeparator

public Character getCommaSeparator()

Separator to use for separating x,y entries of a single coordinate that is being persisted

Returns:

separator

setCommaSeparator

public void setCommaSeparator(Character commaSeparator)

Set separator

Parameters:

commaSeparator - to use

getDecimalSeparator

public Character getDecimalSeparator()

Separator to use for separating decimals from unit changes

Returns:

separator

setDecimalSeparator

public void setDecimalSeparator(Character decimalSeparator)

Set separator

Parameters:

decimalSeparator - to use

reset

public void reset()

Reset content

Specified by:

reset in interface ConverterWriterSettings

Overrides:

reset in class SingleFileBasedConverterWriterSettings