Package org.goplanit.io.converter.demands

Class PlanitDemandsWriterSettings

java.lang.Object

org.goplanit.converter.FileBasedConverterWriterSettings

org.goplanit.converter.SingleFileBasedConverterWriterSettings

org.goplanit.io.xml.util.PlanitXmlWriterSettings

org.goplanit.io.converter.demands.PlanitDemandsWriterSettings

All Implemented Interfaces:

ConverterWriterSettings

public class PlanitDemandsWriterSettings
extends PlanitXmlWriterSettings
implements ConverterWriterSettings

Configurable settings for the PLANit demands writer. Note that the default decimalformat used is a maximum of 4 digits to reduce the size of the OD matrices. This can however be altered by the user if desired.

Author:

markr

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_DEMANDS_XML	default demands file name to use
static String	DEFAULT_DESTINATION_SEPARATOR	default origin separator used in matrix values element
static String	DEFAULT_ORIGIN_SEPARATOR	default origin separator used in matrix values element

Fields inherited from class org.goplanit.io.xml.util.PlanitXmlWriterSettings

commaSeparator, decimalFormat, decimalSeparator, tupleSeparator

Fields inherited from class org.goplanit.converter.FileBasedConverterWriterSettings

DEFAULT_COUNTRY, destinationCoordinateReferenceSystem

Constructor Summary

Constructors

Constructor	Description
PlanitDemandsWriterSettings()	Default constructor
PlanitDemandsWriterSettings(String outputPathDirectory)	Constructor, requires user to se file name
PlanitDemandsWriterSettings(String outputPathDirectory, String fileName)	Constructor

Method Summary

Modifier and Type	Method	Description
String	getDestinationSeparator()
String	getOriginSeparator()
void	reset()	Reset content
void	setDestinationSeparator(String destinationSeparator)
void	setOriginSeparator(String originSeparator)
protected boolean	validate()	Validate the settings

Methods inherited from class org.goplanit.io.xml.util.PlanitXmlWriterSettings

getCommaSeparator, getDecimalFormat, getDecimalSeparator, getTupleSeparator, logSettings, setCommaSeparator, setDecimalFormat, setDecimalSeparator, setTupleSeparator

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

DEFAULT_ORIGIN_SEPARATOR

public static String DEFAULT_ORIGIN_SEPARATOR

default origin separator used in matrix values element

DEFAULT_DESTINATION_SEPARATOR

public static String DEFAULT_DESTINATION_SEPARATOR

default origin separator used in matrix values element

DEFAULT_DEMANDS_XML

public static final String DEFAULT_DEMANDS_XML

default demands file name to use

See Also:

Constant Field Values

Constructor Detail

PlanitDemandsWriterSettings

public PlanitDemandsWriterSettings()

Default constructor

PlanitDemandsWriterSettings

public PlanitDemandsWriterSettings(String outputPathDirectory)

Constructor, requires user to se file name

Parameters:

outputPathDirectory - to use

PlanitDemandsWriterSettings

public PlanitDemandsWriterSettings(String outputPathDirectory,
                                   String fileName)

Constructor

Parameters:

outputPathDirectory - to use

fileName - to use

Method Detail

validate

protected boolean validate()

Validate the settings

Overrides:

validate in class PlanitXmlWriterSettings

Returns:

true when valid, false otherwise

reset

public void reset()

Reset content

Specified by:

reset in interface ConverterWriterSettings

Overrides:

reset in class PlanitXmlWriterSettings

getOriginSeparator

public String getOriginSeparator()

setOriginSeparator

public void setOriginSeparator(String originSeparator)

getDestinationSeparator

public String getDestinationSeparator()

setDestinationSeparator

public void setDestinationSeparator(String destinationSeparator)