Package org.goplanit.io.converter.service

Class PlanitServiceNetworkWriterFactory

java.lang.Object

org.goplanit.io.converter.service.PlanitServiceNetworkWriterFactory

public class PlanitServiceNetworkWriterFactory
extends Object

Factory for creating PLANit Service Network writers

Author:

markr

Constructor Summary

Constructors

Constructor	Description
PlanitServiceNetworkWriterFactory()

Method Summary

Modifier and Type	Method	Description
static PlanitServiceNetworkWriter	create()	Create a PLANitServiceNetworkWriter which can persist a PLANit Service network in the native PLANit XML format with all defaults.
static PlanitServiceNetworkWriter	create(String serviceNetworkPath)	Create a PLANitServiceNetworkWriter which can persist a PLANit Service network in the native PLANit XML format
static PlanitServiceNetworkWriter	create(String serviceNetworkPath, String countryName)	Create a PLANitServiceNetworkWriter which can persist a PLANit Service network in the native PLANit XML format
static PlanitServiceNetworkWriter	create(String networkPath, String countryName, org.goplanit.xml.generated.XMLElementServiceNetwork xmlRawServiceNetwork)	Create a PLANitNetworkWriter which can persist a PLANit network in the native PLANit XML format.

Methods inherited from class java.lang.Object

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

Constructor Detail

PlanitServiceNetworkWriterFactory

public PlanitServiceNetworkWriterFactory()

Method Detail

create

public static PlanitServiceNetworkWriter create()

Create a PLANitServiceNetworkWriter which can persist a PLANit Service network in the native PLANit XML format with all defaults. It is expected the user sets the required minimum configuration afterwards to be able to persist

Returns:

created PLANit serviceNetwork writer

create

public static PlanitServiceNetworkWriter create(String serviceNetworkPath)

Create a PLANitServiceNetworkWriter which can persist a PLANit Service network in the native PLANit XML format

Parameters:

serviceNetworkPath - the path to use for persisting

Returns:

created PLANit serviceNetwork writer

create

public static PlanitServiceNetworkWriter create(String serviceNetworkPath,
                                                String countryName)

Create a PLANitServiceNetworkWriter which can persist a PLANit Service network in the native PLANit XML format

Parameters:

serviceNetworkPath - the path to use for persisting

countryName - the country to base the projection method on if available

Returns:

created PLANit serviceNetwork writer

create

public static PlanitServiceNetworkWriter create(String networkPath,
                                                String countryName,
                                                org.goplanit.xml.generated.XMLElementServiceNetwork xmlRawServiceNetwork)

Create a PLANitNetworkWriter which can persist a PLANit network in the native PLANit XML format. By providing the XML memory model instance to populate we make it possible for the writer to embed the persisting in another larger XML memory model that is marshalled by an entity other than this writer in the future

Parameters:

networkPath - the file to use for persisting

countryName - the country to base the projection method on if available

xmlRawServiceNetwork - , use this specific xml memory model equivalent in this instance before marshalling via JAXb

Returns:

created PLANit serviceNetwork writer