Algorithm 5.0.0 API


public interface Algorithm<T extends ClusterItem>

Logic for computing clusters

Method Summary

Modifier and Type	Method	Description
`abstract Boolean`	`addItem(T item)`	Adds an item to the algorithm
`abstract Boolean`	`addItems(Collection<T> items)`	Adds a collection of items to the algorithm
`abstract Unit`	`clearItems()`
`abstract Boolean`	`removeItem(T item)`	Removes an item from the algorithm
`abstract Boolean`	`updateItem(T item)`	Updates the provided item in the algorithm
`abstract Boolean`	`removeItems(Collection<T> items)`	Removes a collection of items from the algorithm
`abstract Set<Cluster<T>>`	`getClusters(Float zoom)`
`abstract Unit`	`lock()`
`abstract Unit`	`unlock()`
`abstract Collection<T>`	`getItems()`
`abstract Integer`	`getMaxDistanceBetweenClusteredItems()`
`abstract Unit`	`setMaxDistanceBetweenClusteredItems(Integer maxDistanceBetweenClusteredItems)`

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

- Method Detail
  - addItem
```
 abstract Boolean addItem(T item)
```
    Adds an item to the algorithm
    
    Parameters:
    
    item - the item to be added
  - addItems
```
 abstract Boolean addItems(Collection<T> items)
```
    Adds a collection of items to the algorithm
    
    Parameters:
    
    items - the items to be added
  - clearItems
```
 abstract Unit clearItems()
```
  - removeItem
```
 abstract Boolean removeItem(T item)
```
    Removes an item from the algorithm
    
    Parameters:
    
    item - the item to be removed
  - updateItem
```
 abstract Boolean updateItem(T item)
```
    Updates the provided item in the algorithm
    
    Parameters:
    
    item - the item to be updated
  - removeItems
```
 abstract Boolean removeItems(Collection<T> items)
```
    Removes a collection of items from the algorithm
    
    Parameters:
    
    items - the items to be removed
  - getClusters
```
 abstract Set<Cluster<T>> getClusters(Float zoom)
```
  - lock
```
 abstract Unit lock()
```
  - unlock
```
 abstract Unit unlock()
```
  - getItems
```
 abstract Collection<T> getItems()
```
  - getMaxDistanceBetweenClusteredItems
```
 abstract Integer getMaxDistanceBetweenClusteredItems()
```
  - setMaxDistanceBetweenClusteredItems
```
 abstract Unit setMaxDistanceBetweenClusteredItems(Integer maxDistanceBetweenClusteredItems)
```