Package org.goplanit.io.converter.network

Class PlanitNetworkWriterFactory

java.lang.Object

org.goplanit.io.converter.network.PlanitNetworkWriterFactory

public class PlanitNetworkWriterFactory
extends Object

Factory for creating PLANit Network writers

Author:

markr

Constructor Summary

Constructors

Constructor	Description
PlanitNetworkWriterFactory()

Method Summary

Modifier and Type	Method	Description
static PlanitNetworkWriter	create()	Create a PLANitNetworkWriter which can persist a PLANit network in the native PLANit XML format witha ll defaults.
static PlanitNetworkWriter	create(String networkPath)	Create a PLANitNetworkWriter which can persist a PLANit network in the native PLANit XML format
static PlanitNetworkWriter	create(String networkPath, String countryName)	Create a PLANitNetworkWriter which can persist a PLANit network in the native PLANit XML format
static PlanitNetworkWriter	create(String networkPath, String countryName, org.goplanit.xml.generated.XMLElementMacroscopicNetwork xmlRawNetwork)	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

PlanitNetworkWriterFactory

public PlanitNetworkWriterFactory()

Method Detail

create

public static PlanitNetworkWriter create()

Create a PLANitNetworkWriter which can persist a PLANit network in the native PLANit XML format witha ll defaults. It is expected the user sets the required minimum configuration afterwards to be able to persist

Returns:

created PLANit network writer

create

public static PlanitNetworkWriter create(String networkPath)

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

Parameters:

networkPath - the path to use for persisting

Returns:

created PLANit network writer

create

public static PlanitNetworkWriter create(String networkPath,
                                         String countryName)

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

Parameters:

networkPath - the path to use for persisting

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

Returns:

created PLANit network writer

create

public static PlanitNetworkWriter create(String networkPath,
                                         String countryName,
                                         org.goplanit.xml.generated.XMLElementMacroscopicNetwork xmlRawNetwork)

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

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

Returns:

created PLANit network writer