SequencePlotSequence (adams-pom 24.10.0-SNAPSHOT API)

java.lang.Object
- adams.data.container.AbstractDataContainer<XYSequencePoint>
- - adams.data.sequence.XYSequence
  - - adams.flow.sink.sequenceplotter.SequencePlotSequence

All Implemented Interfaces:

CloneHandler, Mergeable<DataContainer>, UniqueIDHandler, DataContainer<XYSequencePoint>, DataContainerWithSpreadSheetSupport<XYSequencePoint>, IDHandler, MutableIDHandler, SpreadSheetSupporter, Serializable, Comparable, Iterable<XYSequencePoint>, Collection<XYSequencePoint>
```
public class SequencePlotSequence
extends XYSequence
```
Extended XYSequence.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected String m_MetaDataKey
the meta-data key to include in the comparison of data points.
- Fields inherited from class adams.data.sequence.XYSequence
  FILE_EXTENSION, m_Comparator, m_Comparison, m_MappingX, m_MappingY, m_MaxX, m_MaxY, m_MinX, m_MinY
- Fields inherited from class adams.data.container.AbstractDataContainer
  m_ID, m_Points, m_UUID

Constructor Summary

Constructors
Constructor Description

SequencePlotSequence()
Initializes the sequence.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getMetaDataKey()`	Returns the meta-data key in use.
`DataPointComparator<XYSequencePoint>`	`newComparator()`	Returns the comparator in use.
`SequencePlotPoint`	`newPoint()`	Returns a new instance of a sequence point.
`void`	`setMetaDataKey(String value)`	Sets the meta-data key to use.

Methods inherited from class adams.data.sequence.XYSequence
assign, find, findClosest, getComparator, getComparison, getLabelsX, getLabelsY, getMappingsX, getMappingsY, getMappingX, getMappingY, getMaxX, getMaxY, getMinX, getMinY, hasMappingX, hasMappingY, invalidateMinMax, modifiedListener, putMappingX, putMappingY, removeMappingX, removeMappingY, setComparison, toSpreadSheet, toSpreadSheet, validateMinMax

Methods inherited from class adams.data.container.AbstractDataContainer
add, addAll, assign, clear, compareTo, compareToData, compareToHeader, contains, containsAll, ensureCapacity, equals, equalsData, equalsHeader, getClone, getHeader, getID, getUniqueID, hashCode, isEmpty, iterator, mergeWith, newInstance, remove, removeAll, retainAll, setID, size, toArray, toArray, toList, toList, toString, toTreeSet, toTreeSet, trimToSize

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

Methods inherited from interface java.util.Collection
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray, toArray

Methods inherited from interface java.lang.Comparable
compareTo

Methods inherited from interface adams.data.container.DataContainer
assign, compareToData, compareToHeader, equalsData, equalsHeader, getClone, getHeader, toList, toList, toTreeSet, toTreeSet

Methods inherited from interface adams.data.id.IDHandler
getID

Methods inherited from interface java.lang.Iterable
forEach

Methods inherited from interface adams.core.Mergeable
mergeWith

Methods inherited from interface adams.data.id.MutableIDHandler
setID

Methods inherited from interface adams.core.UniqueIDHandler
getUniqueID

- Field Detail
  - m_MetaDataKey
```
protected String m_MetaDataKey
```
    the meta-data key to include in the comparison of data points.
- Constructor Detail
  - SequencePlotSequence
```
public SequencePlotSequence()
```
    Initializes the sequence.
- Method Detail
  - newComparator
```
public DataPointComparator<XYSequencePoint> newComparator()
```
    Returns the comparator in use.
    
    Specified by:
    
    newComparator in interface DataContainer<XYSequencePoint>
    
    Overrides:
    
    newComparator in class XYSequence
    
    Returns:
    
    the comparator to use
  - setMetaDataKey
```
public void setMetaDataKey(String value)
```
    Sets the meta-data key to use.
    
    Parameters:
    
    value - the key, null if not to use
  - getMetaDataKey
```
public String getMetaDataKey()
```
    Returns the meta-data key in use.
    
    Returns:
    
    the key, null if not used
  - newPoint
```
public SequencePlotPoint newPoint()
```
    Returns a new instance of a sequence point.
    
    Specified by:
    
    newPoint in interface DataContainer<XYSequencePoint>
    
    Overrides:
    
    newPoint in class XYSequence
    
    Returns:
    
    the new sequence point