Package org.goplanit.io.converter.zoning

Class PlanitZoningWriter

java.lang.Object

org.goplanit.converter.BaseWriterImpl<T>

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

org.goplanit.io.converter.zoning.PlanitZoningWriter

All Implemented Interfaces:

ConverterEntity, ConverterWriter<Zoning>, ZoningWriter

public class PlanitZoningWriter
extends PlanitWriterImpl<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

Modifier and Type	Field	Description
static String	DEFAULT_ZONING_FILE_NAME	default network file name to use

Fields inherited from class org.goplanit.converter.BaseWriterImpl

idMapper

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PlanitZoningWriter(String zoningPath, String countryName, org.opengis.referencing.crs.CoordinateReferenceSystem zoningCrs, org.goplanit.xml.generated.XMLElementMacroscopicZoning xmlRawZoning)	Constructor

Method Summary

Modifier and Type	Method	Description
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.PlanitWriterImpl

createGmlCoordType, createGmlDirectPositionType, createGmlLineStringType, createGmlPointType, createGmlPolygonType, extractSrsName, getConnectoidIdMapper, getDestinationCrsTransformer, getGeoUtils, getLinkIdMapper, getLinkSegmentIdMapper, getLinkSegmentTypeIdMapper, getModeIdMapper, getTransferZoneGroupIdMapper, getVertexIdMapper, getZoneIdMapper, initialiseIdMappingFunctions, persist, prepareCoordinateReferenceSystem

Methods inherited from class org.goplanit.converter.BaseWriterImpl

getIdMapperType, identifyDestinationCoordinateReferenceSystem, setIdMapperType

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

Field Detail

DEFAULT_ZONING_FILE_NAME

public static final String DEFAULT_ZONING_FILE_NAME

default network file name to use

See Also:

Constant Field Values

Constructor Detail

PlanitZoningWriter

protected PlanitZoningWriter(String zoningPath,
                             String countryName,
                             org.opengis.referencing.crs.CoordinateReferenceSystem zoningCrs,
                             org.goplanit.xml.generated.XMLElementMacroscopicZoning xmlRawZoning)

Constructor

Parameters:

zoningPath - to persist zoning on

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

zoningCrs - to use

xmlRawZoning - XML zoning to populate

Method Detail

write

public void write(Zoning zoning)
           throws PlanItException

write a network to the writer's output format.

Specified by:

write in interface ConverterWriter<Zoning>

Parameters:

zoning - entity to write

Throws:

PlanItException - thrown if error

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