OdZone (PLANitAllJavaOnly 0.4.0 API)

All Superinterfaces:

Comparable<IdAble>, ExternalIdAble, IdAble, ManagedId, Zone

All Known Implementing Classes:

OdZoneImpl
```
public interface OdZone
extends Zone
```
an OdZone is a zone where trips terminate and or commence

Author:

markr

Field Summary

Fields
Modifier and Type Field Description

static Class<OdZone> OD_ZONE_ID_CLASS
the class to use for the additional od zone id generation
- Fields inherited from interface org.goplanit.utils.zoning.Zone
  LOGGER, ZONE_ID_CLASS

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`OdZone`	`deepClone()`	An id entity should always support a deep copy, i.e., all "owned" members will be deep copied when a clone of this instance is created via this call.
`long`	`getOdZoneId()`	In addition to a zone id across all zones of any derived type, each Od zone also has a unique id across the Od zones specifically
`default Class<OdZone>`	`getOdZoneIdClass()`
`OdZone`	`shallowClone()`	Create a shallow copy of this entity

Methods inherited from interface org.goplanit.utils.id.ExternalIdAble
appendExternalId, appendExternalId, getExternalId, getIdsAsString, getSplitExternalId, getSplitExternalId, getXmlId, hasExternalId, hasXmlId, setExternalId, setXmlId, setXmlId

Methods inherited from interface org.goplanit.utils.id.IdAble
compareTo, getId, idEquals, idHashCode

Methods inherited from interface org.goplanit.utils.id.ManagedId
recreateManagedIds, resetChildManagedIdEntities

Methods inherited from interface org.goplanit.utils.zoning.Zone
addInputProperty, getCentroid, getEnvelope, getGeometry, getGeometry, getIdClass, getInputProperty, getName, hasCentroid, hasGeometry, hasInputProperty, hasName, setGeometry, setName

- Field Detail
  - OD_ZONE_ID_CLASS
```
static final Class<OdZone> OD_ZONE_ID_CLASS
```
    the class to use for the additional od zone id generation
- Method Detail
  - getOdZoneId
```
long getOdZoneId()
```
    In addition to a zone id across all zones of any derived type, each Od zone also has a unique id across the Od zones specifically
    
    Returns:
    
    od zone specific id
  - getOdZoneIdClass
```
default Class<OdZone> getOdZoneIdClass()
```
    Returns:
    
    od zone id class for id generation
  - shallowClone
```
OdZone shallowClone()
```
    Create a shallow copy of this entity
    
    Specified by:
    
    shallowClone in interface IdAble
    
    Specified by:
    
    shallowClone in interface Zone
    
    Returns:
    
    shallow copy of entity
  - deepClone
```
OdZone deepClone()
```
    An id entity should always support a deep copy, i.e., all "owned" members will be deep copied when a clone of this instance is created via this call. To be used with caution if not called by managed id container related code
    
    Specified by:
    
    deepClone in interface IdAble
    
    Specified by:
    
    deepClone in interface Zone
    
    Returns:
    
    deep copy of entity