Package org.goplanit.io.converter.zoning

Class PlanitZoningWriterFactory

java.lang.Object

org.goplanit.io.converter.zoning.PlanitZoningWriterFactory

public class PlanitZoningWriterFactory
extends Object

Factory for creating PLANit Zoning Writers

Author:

markr

Constructor Summary

Constructors

Constructor	Description
PlanitZoningWriterFactory()

Method Summary

Modifier and Type	Method	Description
static PlanitZoningWriter	create()	Create a PLANitZoningWriter which can persist a PLANit zoning in the native PLANit XML format.
static PlanitZoningWriter	create(String zoningPath, String countryName)	Create a PLANitZoningWriter which can persist a PLANit zoning in the native PLANit XML format
static PlanitZoningWriter	create(String zoningPath, String countryName, org.goplanit.xml.generated.XMLElementMacroscopicZoning xmlRawZoning)	Create a PLANitZoningWriter which can persist a PLANit zoning in the native PLANit XML format.
static PlanitZoningWriter	create(PlanitZoningWriterSettings settings)	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

PlanitZoningWriterFactory

public PlanitZoningWriterFactory()

Method Detail

create

public static PlanitZoningWriter create()

Create a PLANitZoningWriter which can persist a PLANit zoning in the native PLANit XML format. User is expected to provide the required inputs via settings and writer after creation as they are not pre-populated.

Returns:

created zoning writer

create

public static PlanitZoningWriter create(String zoningPath,
                                        String countryName)

Create a PLANitZoningWriter which can persist a PLANit zoning in the native PLANit XML format

Parameters:

zoningPath - the file to use for persisting

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

Returns:

created zoning writer

create

public static PlanitZoningWriter create(String zoningPath,
                                        String countryName,
                                        org.goplanit.xml.generated.XMLElementMacroscopicZoning xmlRawZoning)

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:

zoningPath - the file to use for persisting

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

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

Returns:

created zoning writer

create

public static PlanitZoningWriter create(PlanitZoningWriterSettings settings)

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 for persisting

Returns:

created zoning writer