Package org.goplanit.io.converter.demands

Class PlanitDemandsWriterFactory

java.lang.Object

org.goplanit.io.converter.demands.PlanitDemandsWriterFactory

public class PlanitDemandsWriterFactory
extends Object

Factory for creating PLANit Demands Writers

Author:

markr

Constructor Summary

Constructors

Constructor	Description
PlanitDemandsWriterFactory()

Method Summary

Modifier and Type	Method	Description
static PlanitDemandsWriter	create()	Create a PLANitDemandsWriter which can persist a PLANit demands in the native PLANit XML format.
static PlanitDemandsWriter	create(String demandsPath)	Create a PLANitDemandsWriter which can persist a PLANit demands in the native PLANit XML format.
static PlanitDemandsWriter	create(String demandsPath, Zoning parentZoning)	Create a PLANitDemandsWriter which can persist a PLANit demands in the native PLANit XML format
static PlanitDemandsWriter	create(PlanitDemandsWriterSettings settings, Zoning parentZoning, org.goplanit.xml.generated.XMLElementMacroscopicDemand xmlRawDemands)	Create a PLANitZoningWriter which can persist a PLANit zoning 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

PlanitDemandsWriterFactory

public PlanitDemandsWriterFactory()

Method Detail

create

public static PlanitDemandsWriter create()

Create a PLANitDemandsWriter which can persist a PLANit demands in the native PLANit XML format. The reference zoning is expected to be set manually, or will be provided automatically when using a converter. The user is expected to provide the output location via the settings afterwards.

Returns:

created demands writer

create

public static PlanitDemandsWriter create(String demandsPath)

Create a PLANitDemandsWriter which can persist a PLANit demands in the native PLANit XML format. The reference zoning is expected to be set manually, or will be provided automatically when using a converter.

Parameters:

demandsPath - the path to use for persisting

Returns:

created demands writer

create

public static PlanitDemandsWriter create(String demandsPath,
                                         Zoning parentZoning)

Create a PLANitDemandsWriter which can persist a PLANit demands in the native PLANit XML format

Parameters:

demandsPath - the path to use for persisting

parentZoning - to use

Returns:

created demands writer

create

public static PlanitDemandsWriter create(PlanitDemandsWriterSettings settings,
                                         Zoning parentZoning,
                                         org.goplanit.xml.generated.XMLElementMacroscopicDemand xmlRawDemands)

Create a PLANitZoningWriter which can persist a PLANit zoning 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:

settings - the settings to use

parentZoning - to use

xmlRawDemands - , use this specific XML memory model instance to populate and marshall via JAXb

Returns:

created demands writer