Package org.goplanit.io.xml.util

Class PlanitXmlReaderSettings

java.lang.Object

org.goplanit.io.xml.util.PlanitXmlReaderSettings

All Implemented Interfaces:

ConverterReaderSettings

Direct Known Subclasses:

PlanitDemandsReaderSettings, PlanitNetworkReaderSettings, PlanitRoutedServicesReaderSettings, PlanitServiceNetworkReaderSettings, PlanitZoningReaderSettings

public class PlanitXmlReaderSettings
extends Object
implements ConverterReaderSettings

Settings relevant for a Planit Xml reader

Author:

markr

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	DEFAULT_SYNC_XMLIDS_TO_IDS
static String	DEFAULT_XML_EXTENSION

Constructor Summary

Constructors

Constructor	Description
PlanitXmlReaderSettings()	Default constructor using default file extension and user must set output dir afterwards manually
PlanitXmlReaderSettings(String inputDirectory)	Constructor
PlanitXmlReaderSettings(String inputDirectory, String xmlFileExtension)	Constructor

Method Summary

Modifier and Type	Method	Description
String	getInputDirectory()	The input path directory used
String	getXmlFileExtension()	the XML extension used to check for within path directory used
boolean	isSyncXmlIdsToIds()	Verify if reader is designated to replace parsed XML ids with internally generated ids
void	logSettings()	Log relevant settings
void	reset()	be able to reset all settings if needed
void	setInputDirectory(String inputDirectory)	Set the input path directory used
void	setSyncXmlIdsToIds(boolean syncXmlIdsToIds)	Determine if reader should replace parsed XML ids with internally generated ids
void	setXmlFileExtension(String xmlFileExtension)	the xml extension used to check for within path directory used

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_XML_EXTENSION

public static String DEFAULT_XML_EXTENSION

DEFAULT_SYNC_XMLIDS_TO_IDS

public static boolean DEFAULT_SYNC_XMLIDS_TO_IDS

Constructor Detail

PlanitXmlReaderSettings

public PlanitXmlReaderSettings()

Default constructor using default file extension and user must set output dir afterwards manually

PlanitXmlReaderSettings

public PlanitXmlReaderSettings(String inputDirectory)

Constructor

Parameters:

inputDirectory - to use

PlanitXmlReaderSettings

public PlanitXmlReaderSettings(String inputDirectory,
                               String xmlFileExtension)

Constructor

Parameters:

inputDirectory - to use

xmlFileExtension - to use

Method Detail

reset

public void reset()

be able to reset all settings if needed

Specified by:

reset in interface ConverterReaderSettings

logSettings

public void logSettings()

Log relevant settings

Specified by:

logSettings in interface ConverterReaderSettings

getInputDirectory

public String getInputDirectory()

The input path directory used

Returns:

directory used

setInputDirectory

public void setInputDirectory(String inputDirectory)

Set the input path directory used

Parameters:

inputDirectory - to use

getXmlFileExtension

public String getXmlFileExtension()

the XML extension used to check for within path directory used

Returns:

XML file extension used

setXmlFileExtension

public void setXmlFileExtension(String xmlFileExtension)

the xml extension used to check for within path directory used

Parameters:

xmlFileExtension - extension to use

isSyncXmlIdsToIds

public boolean isSyncXmlIdsToIds()

Verify if reader is designated to replace parsed XML ids with internally generated ids

Returns:

true when syncing is active, false otherwise

setSyncXmlIdsToIds

public void setSyncXmlIdsToIds(boolean syncXmlIdsToIds)

Determine if reader should replace parsed XML ids with internally generated ids

Parameters:

syncXmlIdsToIds - syncing active when true, false otherwise