ZonesImpl (PLANitAllJava 0.2.0 API)

java.lang.Object
- org.planit.zoning.ZonesImpl<Z>

Type Parameters:

Z - zone type

All Implemented Interfaces:

Iterable<Z>, Zones<Z>

Direct Known Subclasses:

OdZonesImpl, TransferZonesImpl
```
public abstract class ZonesImpl<Z extends Zone>
extends Object
implements Zones<Z>
```
Partial implementation of the Zones <T> interface

Author:

markr

Field Summary

Fields
Modifier and Type Field Description

protected Map<Long,Z> zoneMap
Map storing all the zones by their row/column in the OD matrix

Constructor Summary

Constructors
Constructor Description

ZonesImpl(IdGroupingToken tokenId)
Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Z`	`get(long id)`	Retrieve zone by its Id
`protected IdGroupingToken`	`getGroupingTokenId()`	access to the id generation token
`Iterator<Z>`	`iterator()`
`Z`	`register(Z zone)`	Add zone to the internal container.
`int`	`size()`	Collect number of zones

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from interface org.planit.utils.zoning.Zones
getNumberOfCentroids, isEmpty, registerNew

- Field Detail
  - zoneMap
```
protected final Map<Long,Z extends Zone> zoneMap
```
    Map storing all the zones by their row/column in the OD matrix
- Constructor Detail
  - ZonesImpl
```
public ZonesImpl(IdGroupingToken tokenId)
```
    Constructor
    
    Parameters:
    
    tokenId - to use for id generation
- Method Detail
  - getGroupingTokenId
```
protected IdGroupingToken getGroupingTokenId()
```
    access to the id generation token
    
    Returns:
    
    id grouping token
  - iterator
```
public Iterator<Z> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Z extends Zone>
  - register
```
public Z register(Z zone)
```
    Add zone to the internal container. Use carefully to avoid issues with internal contiguous ids
    
    Specified by:
    
    register in interface Zones<Z extends Zone>
    
    Parameters:
    
    zone - the zone to be added
    
    Returns:
    
    the zone added
  - get
```
public Z get(long id)
```
    Retrieve zone by its Id
    
    Specified by:
    
    get in interface Zones<Z extends Zone>
    
    Parameters:
    
    id - the id of the zone
    
    Returns:
    
    zone the zone retrieved
  - size
```
public int size()
```
    Collect number of zones
    
    Specified by:
    
    size in interface Zones<Z extends Zone>
    
    Returns:
    
    the number of zones