edu.udo.cs.yale.example
Class AbstractExampleSet

java.lang.Object
  edu.udo.cs.yale.operator.AbstractIOObject
      edu.udo.cs.yale.operator.ResultObjectAdapter
          edu.udo.cs.yale.example.AbstractExampleSet

All Implemented Interfaces:

ExampleSet, IOObject, ResultObject, java.lang.Cloneable, java.lang.Iterable<Example>

Direct Known Subclasses:

ExampleSetAdapter, SimpleExampleSet

public abstract class AbstractExampleSet
extends ResultObjectAdapter
implements ExampleSet

Implements wrapper methods of abstract example set. Implements all ResultObject methods.
Apart from the interface methods the implementing classes must have a public single argument clone constructor. This constructor is invoked by reflection from the clone method. Do not forget to call the superclass method.

Version:

$Id: AbstractExampleSet.java,v 2.74 2006/03/27 13:21:58 ingomierswa Exp $

Author:

Ingo Mierswa, Simon Fischer

Field Summary

Fields inherited from interface edu.udo.cs.yale.example.ExampleSet

ATTRIBUTE_NAME, BATCH_NAME, CLUSTER_NAME, CONFIDENCE_NAME, ID_NAME, KNOWN_ATTRIBUTE_TYPES, LABEL_NAME, PREDICTION_NAME, TYPE_ATTRIBUTE, TYPE_BATCH, TYPE_CLUSTER, TYPE_ID, TYPE_LABEL, TYPE_PREDICTION, TYPE_WEIGHT, WEIGHT_NAME

Constructor Summary

AbstractExampleSet()
Zero argument constructor for subclasses.

AbstractExampleSet(AbstractExampleSet exampleSet)
Clone constructor.

Method Summary

void	addAllAttributes(java.util.Collection<Attribute> c) Adds all given attributes to this example set.
void	clearPredictedLabel() Removes the predicted label.
void	clearWeight() Removes the weight attribute.
java.lang.Object	clone() Clones the example set by invoking a single argument clone constructor.
boolean	contains(Attribute attribute) Returns true if this example set contains the given attribute.
boolean	containsValueType(int valueType) Returns true if this example set contains an attribute with the given value type (see Ontology).
IOObject	copy() Returns not a copy but the very same object.
Attribute	createClusterAttribute() Creates a new cluster attribute of appropriate type.
protected DataTable	createDataTable(IOContainer container) This method is used to create a DataTable from this example set.
Attribute	createSpecialAttribute(java.lang.String name, int valueType) Creates a new (single) special attribute with given name and value type.
Attribute	createWeightAttribute() Creates a new weight attribute.
private static boolean	equals(Attribute a1, Attribute a2) Returns true iff both attributes are null or a1.equals(a2) returns true.
boolean	equals(java.lang.Object o) Returns true, if all attributes including labels and other special attributes are equal.
java.util.List<javax.swing.Action>	getActions() Returns a list of all actions which can be performed for this result object.
int	getBlockEndIndex(int startindex) Returns the last attribute index belonging to the block starting at startindex.
Attribute	getCluster() Returns the cluster attribute.
Attribute	getId() Returns the ID attribute, i.e. an attribute containing a unique integer for each example.
Attribute	getLabel() Returns the label attribute used for classification and regression.
java.lang.String	getName() This method overrides the implementation of ResultObjectAdapter and returns "ExampleSet".
Attribute	getPredictedLabel() Returns the label predicted by some model.
java.awt.Component	getVisualisationComponent(IOContainer container) Returns component with several views controlled by radio buttons.
Attribute	getWeight() Returns the weight attribute.
void	recalculateAllAttributeStatistics() Recalculates the attribute statistics for all attributes.
void	recalculateAttributeStatistics(Attribute attribute) Recalculate the attribute statistics of the given attribute.
void	recalculateAttributeStatistics(java.util.List attributeList) Here the Example Set is parsed only once, all the information is retained for each example set.
void	removeAllAttributes() Removes all attributes.
Attribute	removeAttribute(int index) Removes the attribute with the given index.
void	setAttributes(ExampleSet exampleSet) Copies thie list of attributes from the given example set.
void	setCluster(Attribute cluster) Sets the cluster attribute.
void	setId(Attribute idAttribute) Sets the ID attribute.
void	setLabel(Attribute label) Sets the label attribute used for classification and regression.
void	setPredictedLabel(Attribute predictedLabel) Sets the predicted label.
void	setWeight(Attribute weight) Seturns the weight attribute.
java.lang.String	toString()
private static void	writeAttributeData(java.lang.String tag, Attribute attribute, int sourcecol, java.io.PrintWriter aout, boolean sparse) Writes the data of this attribute in the given stream.
void	writeAttributeFile(java.io.File attFile, java.io.File dataFile) Writes the attribute descriptions for all examples.
void	writeDataFile(java.io.File dataFile) Writes the data and the attribute description to a file.
void	writeSparseAttributeFile(java.io.File attFile, java.io.File dataFile, int format) Writes the attribute descriptions for all examples.
void	writeSparseDataFile(java.io.File dataFile, int format) Writes the data into a sparse file format.

Methods inherited from class edu.udo.cs.yale.operator.ResultObjectAdapter

addAction, toHTML, toResultString

Methods inherited from class edu.udo.cs.yale.operator.AbstractIOObject

read, read, read, write, write

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface edu.udo.cs.yale.example.ExampleSet

addAttribute, clearUserData, getAttribute, getAttribute, getExample, getExampleFromId, getExampleReader, getExampleTable, getNumberOfAttributes, getSize, getSpecialAttribute, getSpecialAttributeNames, getSpecialAttributes, getUserData, getUserDataKeys, remapAllIds, removeAttribute, replaceAttribute, setSpecialAttribute, setUserData, size

Methods inherited from interface edu.udo.cs.yale.operator.ResultObject

toResultString

Methods inherited from interface edu.udo.cs.yale.operator.IOObject

write, write

Methods inherited from interface java.lang.Iterable

iterator

Constructor Detail

AbstractExampleSet

public AbstractExampleSet()

Zero argument constructor for subclasses.

AbstractExampleSet

public AbstractExampleSet(AbstractExampleSet exampleSet)

Clone constructor. Does nothing.

Method Detail

getName

public java.lang.String getName()

This method overrides the implementation of ResultObjectAdapter and returns "ExampleSet".

Specified by:

getName in interface ResultObject

Overrides:

getName in class ResultObjectAdapter

addAllAttributes

public void addAllAttributes(java.util.Collection<Attribute> c)

Adds all given attributes to this example set. Performs a check first if the attribute was not already contained in the example set.

Specified by:

addAllAttributes in interface ExampleSet

removeAllAttributes

public void removeAllAttributes()

Description copied from interface: ExampleSet

Removes all attributes.

Specified by:

removeAllAttributes in interface ExampleSet

removeAttribute

public Attribute removeAttribute(int index)

Description copied from interface: ExampleSet

Removes the attribute with the given index.

Specified by:

removeAttribute in interface ExampleSet

Returns:

The removed attribute

setAttributes

public void setAttributes(ExampleSet exampleSet)

Description copied from interface: ExampleSet

Copies thie list of attributes from the given example set.

Specified by:

setAttributes in interface ExampleSet

getLabel

public Attribute getLabel()

Description copied from interface: ExampleSet

Returns the label attribute used for classification and regression.

Specified by:

getLabel in interface ExampleSet

setLabel

public void setLabel(Attribute label)

Description copied from interface: ExampleSet

Sets the label attribute used for classification and regression.

Specified by:

setLabel in interface ExampleSet

getPredictedLabel

public Attribute getPredictedLabel()

Description copied from interface: ExampleSet

Returns the label predicted by some model.

Specified by:

getPredictedLabel in interface ExampleSet

setPredictedLabel

public void setPredictedLabel(Attribute predictedLabel)

Description copied from interface: ExampleSet

Sets the predicted label.

Specified by:

setPredictedLabel in interface ExampleSet

clearPredictedLabel

public void clearPredictedLabel()

Description copied from interface: ExampleSet

Removes the predicted label.

Specified by:

clearPredictedLabel in interface ExampleSet

getWeight

public Attribute getWeight()

Description copied from interface: ExampleSet

Returns the weight attribute.

Specified by:

getWeight in interface ExampleSet

setWeight

public void setWeight(Attribute weight)

Description copied from interface: ExampleSet

Seturns the weight attribute.

Specified by:

setWeight in interface ExampleSet

clearWeight

public void clearWeight()

Description copied from interface: ExampleSet

Removes the weight attribute.

Specified by:

clearWeight in interface ExampleSet

getCluster

public Attribute getCluster()

Description copied from interface: ExampleSet

Returns the cluster attribute.

Specified by:

getCluster in interface ExampleSet

setCluster

public void setCluster(Attribute cluster)

Description copied from interface: ExampleSet

Sets the cluster attribute.

Specified by:

setCluster in interface ExampleSet

getId

public Attribute getId()

Description copied from interface: ExampleSet

Returns the ID attribute, i.e. an attribute containing a unique integer for each example. May be null.

Specified by:

getId in interface ExampleSet

setId

public void setId(Attribute idAttribute)

Description copied from interface: ExampleSet

Sets the ID attribute.

Specified by:

setId in interface ExampleSet

createWeightAttribute

public Attribute createWeightAttribute()

Description copied from interface: ExampleSet

Creates a new weight attribute. If the example set already has a weight attribute, it is overwritten.

Specified by:

createWeightAttribute in interface ExampleSet

createClusterAttribute

public Attribute createClusterAttribute()

Description copied from interface: ExampleSet

Creates a new cluster attribute of appropriate type. If the example set already has a cluster attribute, it is overwritten.

Specified by:

createClusterAttribute in interface ExampleSet

createSpecialAttribute

public Attribute createSpecialAttribute(java.lang.String name,
                                        int valueType)

Description copied from interface: ExampleSet

Creates a new (single) special attribute with given name and value type. If the example set already has a special attribute with this name, it is overwritten.

Specified by:

createSpecialAttribute in interface ExampleSet

contains

public boolean contains(Attribute attribute)

Description copied from interface: ExampleSet

Returns true if this example set contains the given attribute.

Specified by:

contains in interface ExampleSet

containsValueType

public boolean containsValueType(int valueType)

Description copied from interface: ExampleSet

Returns true if this example set contains an attribute with the given value type (see Ontology).

Specified by:

containsValueType in interface ExampleSet

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

createDataTable

protected DataTable createDataTable(IOContainer container)

This method is used to create a DataTable from this example set. The default implementation returns an instance of DataTableExampleSetAdapter. The given IOContainer is used to check if there are compatible attribute weights which would used as column weights of the returned table. Subclasses might want to override this method in order to allow for other data tables.

getVisualisationComponent

public java.awt.Component getVisualisationComponent(IOContainer container)

Returns component with several views controlled by radio buttons. The first view is a meta data viewer, the second a data viewer and the last one a plotter panel. For this plotter the data table created by createDataTable(IOContainer) is used.

Specified by:

getVisualisationComponent in interface ResultObject

Overrides:

getVisualisationComponent in class ResultObjectAdapter

getBlockEndIndex

public int getBlockEndIndex(int startindex)

Description copied from interface: ExampleSet

Returns the last attribute index belonging to the block starting at startindex.

Specified by:

getBlockEndIndex in interface ExampleSet

getActions

public java.util.List<javax.swing.Action> getActions()

Description copied from class: ResultObjectAdapter

Returns a list of all actions which can be performed for this result object.

Specified by:

getActions in interface ResultObject

Overrides:

getActions in class ResultObjectAdapter

writeDataFile

public void writeDataFile(java.io.File dataFile)
                   throws java.io.IOException

Description copied from interface: ExampleSet

Writes the data and the attribute description to a file.

Specified by:

writeDataFile in interface ExampleSet

Throws:

java.io.IOException

writeSparseDataFile

public void writeSparseDataFile(java.io.File dataFile,
                                int format)
                         throws java.io.IOException

Writes the data into a sparse file format.

Specified by:

writeSparseDataFile in interface ExampleSet

format - specified by SparseFormatExampleSource

Throws:

java.io.IOException

writeAttributeFile

public void writeAttributeFile(java.io.File attFile,
                               java.io.File dataFile)
                        throws java.io.IOException

Writes the attribute descriptions for all examples. Writes first all regular attributes and then the special attributes (just like the data write format of Example.toString(). Please note that the given data file will only be used to determine the relative position.

Specified by:

writeAttributeFile in interface ExampleSet

Throws:

java.io.IOException

writeSparseAttributeFile

public void writeSparseAttributeFile(java.io.File attFile,
                                     java.io.File dataFile,
                                     int format)
                              throws java.io.IOException

Writes the attribute descriptions for all examples. Writes only the special attributes which are supported by the sparse format of the method Example.toSparseString(int format). Please note that the given data file is only be used to determine the relative position.

Specified by:

writeSparseAttributeFile in interface ExampleSet

format - specified by SparseFormatExampleSource

Throws:

java.io.IOException

writeAttributeData

private static void writeAttributeData(java.lang.String tag,
                                       Attribute attribute,
                                       int sourcecol,
                                       java.io.PrintWriter aout,
                                       boolean sparse)

Writes the data of this attribute in the given stream.

equals

public boolean equals(java.lang.Object o)

Returns true, if all attributes including labels and other special attributes are equal.

Specified by:

equals in interface ExampleSet

Overrides:

equals in class java.lang.Object

equals

private static boolean equals(Attribute a1,
                              Attribute a2)

Returns true iff both attributes are null or a1.equals(a2) returns true.

copy

public IOObject copy()

Description copied from class: AbstractIOObject

Returns not a copy but the very same object. This is ok for IOObjects which cannot be altered after creation. However, IOObjects which might be changed (e.g. ExampleSets) should overwrite this method and return a proper copy.

Specified by:

copy in interface IOObject

Overrides:

copy in class AbstractIOObject

clone

public java.lang.Object clone()

Clones the example set by invoking a single argument clone constructor.

Specified by:

clone in interface ExampleSet

Overrides:

clone in class java.lang.Object

recalculateAllAttributeStatistics

public void recalculateAllAttributeStatistics()

Recalculates the attribute statistics for all attributes. They are average value, variance, minimum, and maximum. For nominal attributes the occurences for all values are counted. This method collects all attributes (regular and special) in a list and invokes recalculateAttributeStatistics(List attributes) and performs only data scan.

Specified by:

recalculateAllAttributeStatistics in interface ExampleSet

recalculateAttributeStatistics

public void recalculateAttributeStatistics(java.util.List attributeList)

Here the Example Set is parsed only once, all the information is retained for each example set.

recalculateAttributeStatistics

public void recalculateAttributeStatistics(Attribute attribute)

Recalculate the attribute statistics of the given attribute.

Specified by:

recalculateAttributeStatistics in interface ExampleSet