Package org.goplanit.io.converter.zoning

Class PlanitZoningWriter

java.lang.Object

org.goplanit.converter.BaseWriterImpl<T>

org.goplanit.converter.CrsWriterImpl<T>

org.goplanit.io.converter.PlanitWriterImpl<T>

org.goplanit.io.converter.network.UnTypedPlanitCrsWriterImpl<Zoning>

org.goplanit.io.converter.zoning.PlanitZoningWriter

All Implemented Interfaces:

ConverterEntity, ConverterWriter<Zoning>, ZoningWriter

public class PlanitZoningWriter
extends UnTypedPlanitCrsWriterImpl<Zoning>
implements ZoningWriter

A class that takes a PLANit zoning and persists it to file in the Planit native XML format.

Author:

markr

Field Summary

Fields inherited from class org.goplanit.converter.BaseWriterImpl

idMapper

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PlanitZoningWriter(String zoningPath, String countryName, org.goplanit.xml.generated.XMLElementMacroscopicZoning xmlRawZoning)	Constructor
protected	PlanitZoningWriter(PlanitZoningWriterSettings settings, org.goplanit.xml.generated.XMLElementMacroscopicZoning xmlRawZoning)	Constructor

Method Summary

Modifier and Type	Method	Description
ZoningIdMapper	getPrimaryIdMapper()	The (main) Id mapper used by this writer (only present after write has been completed)
PlanitZoningWriterSettings	getSettings()	any settings to configure the writer can be configured by collecting these settings
void	reset()	reset the reader to allow for marking unnecessary resources for garbage collection
void	write(Zoning zoning)	write a network to the writer's output format.

Methods inherited from class org.goplanit.io.converter.network.UnTypedPlanitCrsWriterImpl

createGmlCoordType, createGmlDirectPositionType, createGmlLineStringType, createGmlPointType, createGmlPolygonType

Methods inherited from class org.goplanit.io.converter.PlanitWriterImpl

getSettingsAsXmlWriterSettings, getXmlModeReference, persist

Methods inherited from class org.goplanit.converter.CrsWriterImpl

createTransformedCoordinate, extractSrsName, getDestinationCoordinateReferenceSystem, getDestinationCrsTransformer, getGeoUtils, getTransformedCoordinates, prepareCoordinateReferenceSystem

Methods inherited from class org.goplanit.converter.BaseWriterImpl

getComponentIdMappers, getIdMapperType, setIdMapperType, setParentIdMappers

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.goplanit.converter.ConverterWriter

getIdMapperType, setIdMapperType

Methods inherited from interface org.goplanit.converter.zoning.ZoningWriter

getTypeDescription

Constructor Detail

PlanitZoningWriter

protected PlanitZoningWriter(String zoningPath,
                             String countryName,
                             org.goplanit.xml.generated.XMLElementMacroscopicZoning xmlRawZoning)

Constructor

Parameters:

zoningPath - to persist zoning on

countryName - to optimise projection for (if available, otherwise ignore)

xmlRawZoning - XML zoning to populate

PlanitZoningWriter

protected PlanitZoningWriter(PlanitZoningWriterSettings settings,
                             org.goplanit.xml.generated.XMLElementMacroscopicZoning xmlRawZoning)

Constructor

Parameters:

settings - to use

xmlRawZoning - XML zoning to populate

Method Detail

getPrimaryIdMapper

public ZoningIdMapper getPrimaryIdMapper()

The (main) Id mapper used by this writer (only present after write has been completed)

Specified by:

getPrimaryIdMapper in class BaseWriterImpl<Zoning>

Returns:

mapper

write

public void write(Zoning zoning)

write a network to the writer's output format.

Specified by:

write in interface ConverterWriter<Zoning>

Parameters:

zoning - entity to write

reset

public void reset()

reset the reader to allow for marking unnecessary resources for garbage collection

Specified by:

reset in interface ConverterEntity

getSettings

public PlanitZoningWriterSettings getSettings()

any settings to configure the writer can be configured by collecting these settings

Specified by:

getSettings in interface ConverterWriter<Zoning>

Returns:

the settings to configure the writer