java.lang.Object
- org.goplanit.converter.FileBasedConverterWriterSettings
- - org.goplanit.geoio.util.GeoIoWriterSettings
  - - org.goplanit.geoio.converter.zoning.GeometryZoningWriterSettings

All Implemented Interfaces:

ConverterWriterSettings
```
public class GeometryZoningWriterSettings
extends GeoIoWriterSettings
implements ConverterWriterSettings
```
Settings relevant for persisting the PLANit zoning in any Geo IO output format

Author:

markr

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`DEFAULT_CONNECTOID_EDGES_FILE_NAME`	default connectoid edges file name to use (without extension)
`static String`	`DEFAULT_CONNECTOID_SEGMENTS_FILE_NAME`	default connectoid segments file name to use (without extension)
`static String`	`DEFAULT_OD_CONNECTOIDS_FILE_NAME`	default od connectoids file name to use (without extension)
`static String`	`DEFAULT_OD_ZONES_FILE_NAME`	default od zones file name to use (without extension)
`static boolean`	`DEFAULT_PERSIST_OD_CONNECTOIDS`	default persist OD connectoids flag value
`static boolean`	`DEFAULT_PERSIST_OD_ZONES`	default persist OD zones flag value
`static boolean`	`DEFAULT_PERSIST_TRANSFER_CONNECTOIDS`	default persist transfer connectoids flag value
`static boolean`	`DEFAULT_PERSIST_TRANSFER_ZONES`	default persist transfer zones flag value
`static boolean`	`DEFAULT_PERSIST_VIRTUAL_NETWORK`	default persist virtual network flag value
`static String`	`DEFAULT_TRANSFER_CONNECTOIDS_FILE_NAME`	default transfer connectoids file name to use (without extension)
`static String`	`DEFAULT_TRANSFER_ZONES_FILE_NAME`	default transfer zones file name to use (without extension)

Fields inherited from class org.goplanit.geoio.util.GeoIoWriterSettings
DEFAULT_EXTENSION

Fields inherited from class org.goplanit.converter.FileBasedConverterWriterSettings
DEFAULT_COUNTRY, destinationCoordinateReferenceSystem

Constructor Summary

Constructors
Constructor	Description
`GeometryZoningWriterSettings()`	Default constructor
`GeometryZoningWriterSettings(String outputPathDirectory)`	Constructor
`GeometryZoningWriterSettings(String outputPathDirectory, String countryName)`	Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getConnectoidEdgesFileName()`	File name to use (without extension or geometry type suffix)
`String`	`getConnectoidSegmentsFileName()`	File name to use (without extension or geometry type suffix)
`String`	`getOdConnectoidsFileName()`	File name to use (without extension or geometry type suffix)
`String`	`getOdZonesFileName()`	File name to use (without extension or geometry type suffix)
`String`	`getTransferConnectoidsFileName()`	File name to use (without extension or geometry type suffix)
`String`	`getTransferZonesFileName()`	transfer zones file name to use (without extension or geometry type suffix)
`boolean`	`isPersistOdConnectoids()`
`boolean`	`isPersistOdZones()`	flag indicating whether to persist od zones or not
`boolean`	`isPersistTransferConnectoids()`
`boolean`	`isPersistTransferZones()`	flag indicating whether to persist transfer zones or not
`boolean`	`isPersistVirtualNetwork()`	flag indicating whether we should persist the virtual network connecting the zones to a physical network via connectoids edges and edge segments, needs to be true in order for any settings related to the connectoid edges and edges segments to be picked up
`void`	`reset()`	Reset content
`void`	`setConnectoidEdgesFileName(String fileName)`	The file name to use (without extension or geometry type suffix)
`void`	`setConnectoidSegmentsFileName(String fileName)`	The file name to use (without extension or geometry type suffix)
`void`	`setOdConnectoidsFileName(String fileName)`	The file name to use (without extension or geometry type suffix)
`void`	`setOdZonesFileName(String fileName)`	The file name to use (without extension or geometry type suffix)
`void`	`setPersistOdConnectoids(boolean persistOdConnectoids)`
`void`	`setPersistOdZones(boolean persistOdZones)`	Indicate whether to persist OD zones
`void`	`setPersistTransferConnectoids(boolean fileName)`	The file name to use (without extension or geometry type suffix)
`void`	`setPersistTransferZones(boolean persistTransferZones)`	Indicate whether to persist transfer zones
`void`	`setPersistVirtualNetwork(boolean flag)`	Set flag indicating whether we should persist the virtual network connecting the zones to a physical network via connectoids edges and edge segments, needs to be true in order for any settings related to the connectoid edges and edges segments to be picked up
`void`	`setTransferConnectoidsFileName(String fileName)`	The file name to use (without extension or geometry type suffix)
`void`	`setTransferZonesFileName(String fileName)`	The file name to use (without extension or geometry type suffix)

Methods inherited from class org.goplanit.geoio.util.GeoIoWriterSettings
getFileExtension, logSettings

Methods inherited from class org.goplanit.converter.FileBasedConverterWriterSettings
getCountry, getDestinationCoordinateReferenceSystem, getOutputDirectory, setCountry, setDestinationCoordinateReferenceSystem, setOutputDirectory, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_OD_ZONES_FILE_NAME
```
public static final String DEFAULT_OD_ZONES_FILE_NAME
```
    default od zones file name to use (without extension)
    
    See Also:
    
    Constant Field Values
  - DEFAULT_OD_CONNECTOIDS_FILE_NAME
```
public static final String DEFAULT_OD_CONNECTOIDS_FILE_NAME
```
    default od connectoids file name to use (without extension)
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TRANSFER_ZONES_FILE_NAME
```
public static final String DEFAULT_TRANSFER_ZONES_FILE_NAME
```
    default transfer zones file name to use (without extension)
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TRANSFER_CONNECTOIDS_FILE_NAME
```
public static final String DEFAULT_TRANSFER_CONNECTOIDS_FILE_NAME
```
    default transfer connectoids file name to use (without extension)
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CONNECTOID_EDGES_FILE_NAME
```
public static final String DEFAULT_CONNECTOID_EDGES_FILE_NAME
```
    default connectoid edges file name to use (without extension)
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CONNECTOID_SEGMENTS_FILE_NAME
```
public static final String DEFAULT_CONNECTOID_SEGMENTS_FILE_NAME
```
    default connectoid segments file name to use (without extension)
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PERSIST_OD_ZONES
```
public static boolean DEFAULT_PERSIST_OD_ZONES
```
    default persist OD zones flag value
  - DEFAULT_PERSIST_OD_CONNECTOIDS
```
public static boolean DEFAULT_PERSIST_OD_CONNECTOIDS
```
    default persist OD connectoids flag value
  - DEFAULT_PERSIST_TRANSFER_ZONES
```
public static boolean DEFAULT_PERSIST_TRANSFER_ZONES
```
    default persist transfer zones flag value
  - DEFAULT_PERSIST_TRANSFER_CONNECTOIDS
```
public static boolean DEFAULT_PERSIST_TRANSFER_CONNECTOIDS
```
    default persist transfer connectoids flag value
  - DEFAULT_PERSIST_VIRTUAL_NETWORK
```
public static boolean DEFAULT_PERSIST_VIRTUAL_NETWORK
```
    default persist virtual network flag value
- Constructor Detail
  - GeometryZoningWriterSettings
```
public GeometryZoningWriterSettings()
```
    Default constructor
  - GeometryZoningWriterSettings
```
public GeometryZoningWriterSettings(String outputPathDirectory)
```
    Constructor
    
    Parameters:
    
    outputPathDirectory - to use
  - GeometryZoningWriterSettings
```
public GeometryZoningWriterSettings(String outputPathDirectory,
                                    String countryName)
```
    Constructor
    
    Parameters:
    
    outputPathDirectory - to use
    
    countryName - to use
- Method Detail
  - reset
```
public void reset()
```
    Reset content
    
    Specified by:
    
    reset in interface ConverterWriterSettings
    
    Overrides:
    
    reset in class GeoIoWriterSettings
  - isPersistOdZones
```
public boolean isPersistOdZones()
```
    flag indicating whether to persist od zones or not
    
    Returns:
    
    true when persisting od zones, false otherwise
  - setPersistOdZones
```
public void setPersistOdZones(boolean persistOdZones)
```
    Indicate whether to persist OD zones
    
    Parameters:
    
    persistOdZones - flag to set
  - isPersistTransferZones
```
public boolean isPersistTransferZones()
```
    flag indicating whether to persist transfer zones or not
    
    Returns:
    
    true when persisting transfer zones, false otherwise
  - setPersistTransferZones
```
public void setPersistTransferZones(boolean persistTransferZones)
```
    Indicate whether to persist transfer zones
    
    Parameters:
    
    persistTransferZones - flag to set
  - getOdZonesFileName
```
public String getOdZonesFileName()
```
    File name to use (without extension or geometry type suffix)
    
    Returns:
    
    file name chosen
  - setOdZonesFileName
```
public void setOdZonesFileName(String fileName)
```
    The file name to use (without extension or geometry type suffix)
    
    Parameters:
    
    fileName - file name to use
  - getTransferZonesFileName
```
public String getTransferZonesFileName()
```
    transfer zones file name to use (without extension or geometry type suffix)
    
    Returns:
    
    the transfer zone file name used
  - setTransferZonesFileName
```
public void setTransferZonesFileName(String fileName)
```
    The file name to use (without extension or geometry type suffix)
    
    Parameters:
    
    fileName - file name to use
  - isPersistVirtualNetwork
```
public boolean isPersistVirtualNetwork()
```
    flag indicating whether we should persist the virtual network connecting the zones to a physical network via connectoids edges and edge segments, needs to be true in order for any settings related to the connectoid edges and edges segments to be picked up
    
    Returns:
    
    flag
  - setPersistVirtualNetwork
```
public void setPersistVirtualNetwork(boolean flag)
```
    Set flag indicating whether we should persist the virtual network connecting the zones to a physical network via connectoids edges and edge segments, needs to be true in order for any settings related to the connectoid edges and edges segments to be picked up
    
    Parameters:
    
    flag - to set
  - isPersistOdConnectoids
```
public boolean isPersistOdConnectoids()
```
  - setPersistOdConnectoids
```
public void setPersistOdConnectoids(boolean persistOdConnectoids)
```
  - isPersistTransferConnectoids
```
public boolean isPersistTransferConnectoids()
```
  - setPersistTransferConnectoids
```
public void setPersistTransferConnectoids(boolean fileName)
```
    The file name to use (without extension or geometry type suffix)
    
    Parameters:
    
    fileName - file name to use
  - getOdConnectoidsFileName
```
public String getOdConnectoidsFileName()
```
    File name to use (without extension or geometry type suffix)
    
    Returns:
    
    file name chosen
  - setOdConnectoidsFileName
```
public void setOdConnectoidsFileName(String fileName)
```
    The file name to use (without extension or geometry type suffix)
    
    Parameters:
    
    fileName - file name to use
  - getTransferConnectoidsFileName
```
public String getTransferConnectoidsFileName()
```
    File name to use (without extension or geometry type suffix)
    
    Returns:
    
    file name chosen
  - setTransferConnectoidsFileName
```
public void setTransferConnectoidsFileName(String fileName)
```
    The file name to use (without extension or geometry type suffix)
    
    Parameters:
    
    fileName - file name to use
  - getConnectoidEdgesFileName
```
public String getConnectoidEdgesFileName()
```
    File name to use (without extension or geometry type suffix)
    
    Returns:
    
    file name chosen
  - setConnectoidEdgesFileName
```
public void setConnectoidEdgesFileName(String fileName)
```
    The file name to use (without extension or geometry type suffix)
    
    Parameters:
    
    fileName - file name to use
  - getConnectoidSegmentsFileName
```
public String getConnectoidSegmentsFileName()
```
    File name to use (without extension or geometry type suffix)
    
    Returns:
    
    file name chosen
  - setConnectoidSegmentsFileName
```
public void setConnectoidSegmentsFileName(String fileName)
```
    The file name to use (without extension or geometry type suffix)
    
    Parameters:
    
    fileName - file name to use

Class GeometryZoningWriterSettings

Field Summary

Fields inherited from class org.goplanit.geoio.util.GeoIoWriterSettings

Fields inherited from class org.goplanit.converter.FileBasedConverterWriterSettings

Constructor Summary

Method Summary

Methods inherited from class org.goplanit.geoio.util.GeoIoWriterSettings

Methods inherited from class org.goplanit.converter.FileBasedConverterWriterSettings

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_OD_ZONES_FILE_NAME

DEFAULT_OD_CONNECTOIDS_FILE_NAME

DEFAULT_TRANSFER_ZONES_FILE_NAME

DEFAULT_TRANSFER_CONNECTOIDS_FILE_NAME

DEFAULT_CONNECTOID_EDGES_FILE_NAME

DEFAULT_CONNECTOID_SEGMENTS_FILE_NAME

DEFAULT_PERSIST_OD_ZONES

DEFAULT_PERSIST_OD_CONNECTOIDS

DEFAULT_PERSIST_TRANSFER_ZONES

DEFAULT_PERSIST_TRANSFER_CONNECTOIDS

DEFAULT_PERSIST_VIRTUAL_NETWORK

Constructor Detail

GeometryZoningWriterSettings

GeometryZoningWriterSettings

GeometryZoningWriterSettings

Method Detail

reset

isPersistOdZones

setPersistOdZones

isPersistTransferZones

setPersistTransferZones

getOdZonesFileName

setOdZonesFileName

getTransferZonesFileName

setTransferZonesFileName

isPersistVirtualNetwork

setPersistVirtualNetwork

isPersistOdConnectoids

setPersistOdConnectoids

isPersistTransferConnectoids

setPersistTransferConnectoids

getOdConnectoidsFileName

setOdConnectoidsFileName

getTransferConnectoidsFileName

setTransferConnectoidsFileName

getConnectoidEdgesFileName

setConnectoidEdgesFileName

getConnectoidSegmentsFileName

setConnectoidSegmentsFileName