Package org.goplanit.utils.zoning

Interface Zones<Z extends Zone>

Type Parameters:

Z - zone type

All Superinterfaces:

Cloneable, Iterable<Z>, LongMapWrapper<Z>, ManagedIdEntities<Z>, MapWrapper<Long,Z>

All Known Subinterfaces:

OdZones, TransferZones

All Known Implementing Classes:

OdZonesImpl, TransferZonesImpl, ZonesImpl

public interface Zones<Z extends Zone>
extends ManagedIdEntities<Z>

Interface to manage zones

Author:

markr

Method Summary

Modifier and Type	Method	Description
default Z	getByXmlId(String xmlId)	Find the first entry with matching XML id, not efficient as not indexed by XML id, so use carefully
default int	getNumberOfCentroids()	Each zone has exactly one centroid, so this is functionally equivalent to calling MapWrapper.size()

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface org.goplanit.utils.wrapper.LongMapWrapper

get, remove

Methods inherited from interface org.goplanit.utils.id.ManagedIdEntities

clone, containsKey, getFactory, getManagedIdClass, recreateIds, recreateIds, reset

Methods inherited from interface org.goplanit.utils.wrapper.MapWrapper

addAll, clear, contains, findFirst, forEachIn, get, getFirst, getKeyByValue, isEmpty, register, remove, size, toCollection, valuesAsNewSet

Method Detail

getNumberOfCentroids

default int getNumberOfCentroids()

Each zone has exactly one centroid, so this is functionally equivalent to calling MapWrapper.size()

Returns:

number of centroids

getByXmlId

default Z getByXmlId(String xmlId)

Find the first entry with matching XML id, not efficient as not indexed by XML id, so use carefully

Parameters:

xmlId - to find

Returns:

zone found, null if not present