DynamicSeriesNamer

java.lang.Object

com.illumon.iris.db.plot.datasets.DynamicSeriesNamer

All Implemented Interfaces:: Serializable

public class DynamicSeriesNamer
extends Object
implements Serializable

Provide unique names for series.

See Also:: Serialized Form

Constructor Summary

Constructors

Constructor Description

DynamicSeriesNamer()

Method Summary

Modifier and Type	Method	Description
`void`	`add(Comparable name, PlotInfo plotInfo)`	Adds a new series name to the namer.
`void`	`clear()`
`List<Comparable>`	`getNames()`	Gets all the series names.
`String`	`makeUnusedName(String potentialName, PlotInfo plotInfo)`	Takes a potential series name and creates a unique name from it.
`void`	`removeAll(Collection<? extends Comparable> names)`	Remove all the specified series names.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- DynamicSeriesNamer
  
  public DynamicSeriesNamer()
Method Details
- add
  
  public void add(Comparable name, PlotInfo plotInfo)
  
  Adds a new series name to the namer.
  
  Parameters:
  
  name - new series name
  
  Throws:
  
  UnsupportedOperationException - if the name has already been added.
- removeAll
  
  public void removeAll(Collection<? extends Comparable> names)
  
  Remove all the specified series names.
  
  Parameters:
  
  names - series names to remove
- makeUnusedName
  
  public String makeUnusedName(String potentialName, PlotInfo plotInfo)
  
  Takes a potential series name and creates a unique name from it. If the series would be new, the original series name is returned.
  
  Parameters:
  
  potentialName - potential series name
  
  Returns:
  
  uniquified series name
- getNames
  
  public List<Comparable> getNames()
  
  Gets all the series names.
  The order of series in 3D-plots are determined by returned set.
  
  Returns:
  
  Set<String> of seriesNames
- clear
  
  public void clear()