adams.data.instance
Class Instance

java.lang.Object
  adams.data.container.AbstractDataContainer<InstancePoint>
      adams.data.instance.Instance

All Implemented Interfaces:

CloneHandler, Mergeable<DataContainer>, DataContainer<InstancePoint>, IDHandler, MutableIDHandler, NotesHandler, MutableReportHandler<Report>, ReportHandler<Report>, Serializable, Comparable, Iterable<InstancePoint>, Collection<InstancePoint>

public class Instance
extends AbstractDataContainer<InstancePoint>
implements MutableReportHandler<Report>, NotesHandler

Stores values from weka.core.Instance objects, with X being the attribute index (integer) and Y being the internal value (double).

Version:

$Revision: 4925 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected static DataPointComparator	m_Comparator the default comparator.
protected weka.core.Instances	m_DatasetHeader a reference to the dataset the data was obtained from.
protected Notes	m_Notes the notes for the chromatogram.
protected Report	m_Report the automatically generated report.
static String	REPORT_ADDITIONAL_PREFIX the key prefix in the report for the additional attributes.
static String	REPORT_CLASS the key in the report for the class.
static String	REPORT_DATASET the key in the report for the dataset name.
static String	REPORT_DB_ID the key in the report for the database ID.
static String	REPORT_DISPLAY_ID the key in the report for the display ID.
static String	REPORT_ID the key in the report for the ID.
static String	REPORT_ROW the key in the report for the row in the dataset.

Fields inherited from class adams.data.container.AbstractDataContainer

m_ID, m_Points

Constructor Summary

Instance()
Initializes the sequence.

Method Summary

void	assign(DataContainer<InstancePoint> other) Obtains the stored variables from the other data point, but not the actual data points.
void	clear() Removes all the points and report and nulls the header reference.
DataPointComparator<InstancePoint>	getComparator() Returns the comparator in use.
weka.core.Instances	getDatasetHeader() Returns the header of the underlying dataset.
Notes	getNotes() Returns the currently stored notes.
Report	getReport() Returns the report.
boolean	hasDatasetHeader() Returns whether a header of a dataset is available.
boolean	hasReport() Checks whether a report is present.
DataPointComparator<InstancePoint>	newComparator() Returns the comparator in use.
InstancePoint	newPoint() Returns a new instance of a sequence point.
protected Report	newReport() Creates an empty report.
void	set(weka.core.Instance inst) Clears the container and adds the data from the weka.core.Instance (internal values).
void	set(weka.core.Instance inst, int index, int[] additional, Range range, HashSet<Integer> attTypes) Clears the container and adds the data from the weka.core.Instance (internal values).
void	setID(String value) Sets the ID of the sequence.
void	setReport(Report value) Sets a new report.
weka.core.Instance	toInstance() Generates a weka instance, if a dataset header is available.

Methods inherited from class adams.data.container.AbstractDataContainer

add, addAll, compareTo, compareToHeader, contains, containsAll, ensureCapacity, equals, equalsHeader, getClone, getHeader, getID, hashCode, isEmpty, iterator, mergeWith, modifiedListener, newInstance, remove, removeAll, retainAll, size, toArray, toArray, toList, toString, toTreeSet, toTreeSet, toVector, toVector, trimToSize

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

REPORT_DATASET

public static final String REPORT_DATASET

the key in the report for the dataset name.

See Also:

Constant Field Values

REPORT_DB_ID

public static final String REPORT_DB_ID

the key in the report for the database ID.

See Also:

Constant Field Values

REPORT_ID

public static final String REPORT_ID

the key in the report for the ID.

See Also:

Constant Field Values

REPORT_DISPLAY_ID

public static final String REPORT_DISPLAY_ID

the key in the report for the display ID.

See Also:

Constant Field Values

REPORT_CLASS

public static final String REPORT_CLASS

the key in the report for the class.

See Also:

Constant Field Values

REPORT_ROW

public static final String REPORT_ROW

the key in the report for the row in the dataset.

See Also:

Constant Field Values

REPORT_ADDITIONAL_PREFIX

public static final String REPORT_ADDITIONAL_PREFIX

the key prefix in the report for the additional attributes.

See Also:

Constant Field Values

m_Comparator

protected static DataPointComparator m_Comparator

the default comparator.

m_DatasetHeader

protected weka.core.Instances m_DatasetHeader

a reference to the dataset the data was obtained from.

m_Report

protected Report m_Report

the automatically generated report.

m_Notes

protected Notes m_Notes

the notes for the chromatogram.

Constructor Detail

Instance

public Instance()

Initializes the sequence.

Method Detail

setID

public void setID(String value)

Sets the ID of the sequence.

Specified by:

setID in interface MutableIDHandler

Overrides:

setID in class AbstractDataContainer<InstancePoint>

Parameters:

value - the new ID

newComparator

public DataPointComparator<InstancePoint> newComparator()

Returns the comparator in use.

Specified by:

newComparator in interface DataContainer<InstancePoint>

Returns:

the comparator to use

getComparator

public DataPointComparator<InstancePoint> getComparator()

Returns the comparator in use.

Specified by:

getComparator in interface DataContainer<InstancePoint>

Returns:

the comparator in use

newPoint

public InstancePoint newPoint()

Returns a new instance of a sequence point.

Specified by:

newPoint in interface DataContainer<InstancePoint>

Returns:

the new sequence point

newReport

protected Report newReport()

Creates an empty report.

Returns:

the empty report

clear

public void clear()

Removes all the points and report and nulls the header reference.

Specified by:

clear in interface Collection<InstancePoint>

Overrides:

clear in class AbstractDataContainer<InstancePoint>

See Also:

m_DatasetHeader

assign

public void assign(DataContainer<InstancePoint> other)

Obtains the stored variables from the other data point, but not the actual data points.

Specified by:

assign in interface DataContainer<InstancePoint>

Overrides:

assign in class AbstractDataContainer<InstancePoint>

Parameters:

other - the data point to get the values from

hasDatasetHeader

public boolean hasDatasetHeader()

Returns whether a header of a dataset is available.

Returns:

true if a header is available

getDatasetHeader

public weka.core.Instances getDatasetHeader()

Returns the header of the underlying dataset.

Returns:

the header, null if none currently set

set

public void set(weka.core.Instance inst)

Clears the container and adds the data from the weka.core.Instance (internal values).

Parameters:

inst - the instance to use

set

public void set(weka.core.Instance inst,
                int index,
                int[] additional,
                Range range,
                HashSet<Integer> attTypes)

Clears the container and adds the data from the weka.core.Instance (internal values). Uses only the attributes specified in the range.

Parameters:

inst - the instance to use

index - the row index in the original dataset, use -1 to ignore

additional - the indices of the additional attribute values to store in the report

range - the range of attributes to limit the instance to

attTypes - whether to restrict to attributes types, null or zero-length array means no restriction

See Also:

Attribute

hasReport

public boolean hasReport()

Checks whether a report is present.

Specified by:

hasReport in interface ReportHandler<Report>

Returns:

always true

setReport

public void setReport(Report value)

Sets a new report.

Specified by:

setReport in interface MutableReportHandler<Report>

Parameters:

value - the new report

getReport

public Report getReport()

Returns the report.

Specified by:

getReport in interface ReportHandler<Report>

Returns:

the report, can be null if none available

toInstance

public weka.core.Instance toInstance()

Generates a weka instance, if a dataset header is available.

Returns:

the generated Instance, null if no header available

getNotes

public Notes getNotes()

Returns the currently stored notes.

Specified by:

getNotes in interface NotesHandler

Returns:

the current notes