edu.udo.cs.yale.example
Class SimpleExampleSet

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

All Implemented Interfaces:

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

public class SimpleExampleSet
extends AbstractExampleSet

A simple implementation of ExampleSet containing a list of attributes and a special attribute map. The data is queried from an example table which contains the data (example sets actually are only views on this table and does not keep any data). This simple example set implementation usually is the basic example set of the multi-layered data view.

Version:

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

Author:

Ingo Mierswa, Simon Fischer

Field Summary

private java.util.ArrayList<Attribute>	attributes The list of attributes contained in this example set.
private ExampleTable	exampleTable The table used for reading the examples from.
private java.util.Map<java.lang.Double,java.lang.Integer>	idMap Maps the id values on the line index in the example table.
private java.util.Map<java.lang.String,Attribute>	specialAttributeMap Maps names of named special attributes to Attributes
private java.util.Map<java.lang.String,java.lang.Object>	userDataMap A map to store user data in.

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

SimpleExampleSet(AbstractExampleTable exampleTable, Attribute label, Attribute predictedLabel, Attribute weight, Attribute idAttribute)
Constructs a new SimpleExampleSet backed by the given example table.

SimpleExampleSet(AbstractExampleTable exampleTable, java.util.Map<java.lang.String,Attribute> specialAttributes)
Constructs a new SimpleExampleSet backed by the given example table.

SimpleExampleSet(ExampleTable exampleTable, java.util.Collection<Attribute> regularAttributes)
Constructs a new SimpleExampleSet backed by the given example table.

SimpleExampleSet(SimpleExampleSet exampleSet)
Clone constructor.

Method Summary

private void	addAllAttributesWithoutCheck(java.util.Collection<Attribute> c) Adds all given attributes to this example set.
void	addAttribute(Attribute attribute) Adds a new attribute.
private void	addRegularAttributesFromExampleTable(AbstractExampleTable exampleTable) Adds all attributes from the given example table as regular attributes if they are not already known as special attributes.
void	clearUserData() Clears all user data.
private Example	createExample(DataRow dataRow) Creates an example for the given data row.
Attribute	getAttribute(int index) Returns the attribute with the given index.
Attribute	getAttribute(java.lang.String name) Returns the attribute with the given name.
private DataRow	getDataRowFromId(double id) This method can be used by subclasses to determine the data row with a given id value.
Example	getExample(int index) Returns the i-th example.
Example	getExampleFromId(double id) Returns the example with the given id value.
ExampleReader	getExampleReader() Deprecated.
ExampleTable	getExampleTable() Returns the underlying example table.
int	getNumberOfAttributes() Returns the number of regular attributes.
int	getSize() Deprecated.
Attribute	getSpecialAttribute(java.lang.String name) Returns the special attribute with the given name.
java.util.Collection<java.lang.String>	getSpecialAttributeNames() Returns a collection of all keys of special attributes.
java.util.Map<java.lang.String,Attribute>	getSpecialAttributes() Returns a map of all special attribute names to the corresponding attributes.
java.lang.Object	getUserData(java.lang.String key) Returns the user data set by setUserData()
java.util.Set<java.lang.String>	getUserDataKeys() Returns all askable keys of user data.
boolean	isSpecialAttribute(Attribute attribute) Returns true if one of the special attributes has the same index like the given one.
java.util.Iterator<Example>	iterator()
void	remapAllIds() Remaps all ids.
void	removeAttribute(Attribute attribute) Removes the attribute from the attribute list which has the same column index like the given one.
Attribute	replaceAttribute(Attribute first, Attribute second) Replaces the first attribute by the second.
void	setSpecialAttribute(java.lang.String name, Attribute attribute) Sets the given special attribute or deletes it if the attribute is null.
void	setUserData(java.lang.String key, java.lang.Object data) Sets arbitrary user data, e.g. to cache certain performance values etc.
int	size() Returns the number of examples in this example set.

Methods inherited from class edu.udo.cs.yale.example.AbstractExampleSet

addAllAttributes, clearPredictedLabel, clearWeight, clone, contains, containsValueType, copy, createClusterAttribute, createDataTable, createSpecialAttribute, createWeightAttribute, equals, getActions, getBlockEndIndex, getCluster, getId, getLabel, getName, getPredictedLabel, getVisualisationComponent, getWeight, recalculateAllAttributeStatistics, recalculateAttributeStatistics, recalculateAttributeStatistics, removeAllAttributes, removeAttribute, setAttributes, setCluster, setId, setLabel, setPredictedLabel, setWeight, toString, writeAttributeFile, writeDataFile, writeSparseAttributeFile, writeSparseDataFile

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.operator.ResultObject

toResultString

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

write, write

Field Detail

attributes

private java.util.ArrayList<Attribute> attributes

The list of attributes contained in this example set.

userDataMap

private java.util.Map<java.lang.String,java.lang.Object> userDataMap

A map to store user data in.

specialAttributeMap

private java.util.Map<java.lang.String,Attribute> specialAttributeMap

Maps names of named special attributes to Attributes

idMap

private java.util.Map<java.lang.Double,java.lang.Integer> idMap

Maps the id values on the line index in the example table.

exampleTable

private ExampleTable exampleTable

The table used for reading the examples from.

Constructor Detail

SimpleExampleSet

public SimpleExampleSet(SimpleExampleSet exampleSet)

Clone constructor.

SimpleExampleSet

public SimpleExampleSet(ExampleTable exampleTable,
                        java.util.Collection<Attribute> regularAttributes)

Constructs a new SimpleExampleSet backed by the given example table. The example set initially does not have any special attributes.

SimpleExampleSet

public SimpleExampleSet(AbstractExampleTable exampleTable,
                        Attribute label,
                        Attribute predictedLabel,
                        Attribute weight,
                        Attribute idAttribute)

Constructs a new SimpleExampleSet backed by the given example table. All attributes in the table apart from the special attributes become normal attributes.

SimpleExampleSet

public SimpleExampleSet(AbstractExampleTable exampleTable,
                        java.util.Map<java.lang.String,Attribute> specialAttributes)

Constructs a new SimpleExampleSet backed by the given example table. All attributes in the table apart from the special attributes become normal attributes. The special attributes are specified by the given map.

Method Detail

addRegularAttributesFromExampleTable

private void addRegularAttributesFromExampleTable(AbstractExampleTable exampleTable)

Adds all attributes from the given example table as regular attributes if they are not already known as special attributes.

addAllAttributesWithoutCheck

private void addAllAttributesWithoutCheck(java.util.Collection<Attribute> c)

Adds all given attributes to this example set. Performs no check if the attribute was not already contained in the example set which reduces runtime.

isSpecialAttribute

public boolean isSpecialAttribute(Attribute attribute)

Returns true if one of the special attributes has the same index like the given one.

addAttribute

public void addAttribute(Attribute attribute)

Description copied from interface: ExampleSet

Adds a new attribute.

removeAttribute

public void removeAttribute(Attribute attribute)

Removes the attribute from the attribute list which has the same column index like the given one.

replaceAttribute

public Attribute replaceAttribute(Attribute first,
                                  Attribute second)

Replaces the first attribute by the second. Returns the second attribute.

getExampleReader

@Deprecated
public ExampleReader getExampleReader()

Deprecated.

Description copied from interface: ExampleSet

Returns a reader that can be used to iterate over all examples of this set. This method should be used for all scans through the data. It is not guaranteed that asking for an example by using the index in the example table is efficiently implemented. Therefore for-loops for iterations are not an option.

iterator

public java.util.Iterator<Example> iterator()

getExampleTable

public ExampleTable getExampleTable()

Description copied from interface: ExampleSet

Returns the underlying example table. Most operators should operate on the example set and manipulate example to change table data instead of using the table directly.

getNumberOfAttributes

public int getNumberOfAttributes()

Returns the number of regular attributes.

getAttribute

public Attribute getAttribute(int index)

Returns the attribute with the given index.

getAttribute

public Attribute getAttribute(java.lang.String name)

Returns the attribute with the given name. Returns null if no regular and no special attribute with this name exists.

getSpecialAttribute

public Attribute getSpecialAttribute(java.lang.String name)

Returns the special attribute with the given name. Returns null if no special attribute with this name exists.

setSpecialAttribute

public void setSpecialAttribute(java.lang.String name,
                                Attribute attribute)

Sets the given special attribute or deletes it if the attribute is null. Rehashes the data id mapping to line indices in case of an id attribute.

getSpecialAttributeNames

public java.util.Collection<java.lang.String> getSpecialAttributeNames()

Description copied from interface: ExampleSet

Returns a collection of all keys of special attributes.

getSpecialAttributes

public java.util.Map<java.lang.String,Attribute> getSpecialAttributes()

Description copied from interface: ExampleSet

Returns a map of all special attribute names to the corresponding attributes.

getSize

@Deprecated
public int getSize()

Deprecated.

Description copied from interface: ExampleSet

Returns the number of examples in this example set. This number should not be used to create for-loops to iterate through all examples. TODO: remove

size

public int size()

Description copied from interface: ExampleSet

Returns the number of examples in this example set. This number should not be used to create for-loops to iterate through all examples.

getExample

public Example getExample(int index)

Description copied from interface: ExampleSet

Returns the i-th example. It is not guaranteed that asking for an example by using the index in the example table is efficiently implemented. Therefore for-loops for iterations are not an option and an ExampleReader should be used.

getExampleFromId

public Example getExampleFromId(double id)

Description copied from interface: ExampleSet

Returns the example with the given id value. If the example set does not contain an id attribute this method should return null.

createExample

private Example createExample(DataRow dataRow)

Creates an example for the given data row. Returns null if the given data is null.

getDataRowFromId

private DataRow getDataRowFromId(double id)

This method can be used by subclasses to determine the data row with a given id value. This data row is used to construct the desired example. This method returns null if no data row with the given id exists.

remapAllIds

public void remapAllIds()

Remaps all ids. This method should be invoked after Id tagging or example set loading.

clearUserData

public void clearUserData()

Description copied from interface: ExampleSet

Clears all user data. This method must be called whenever attributes are added or removed or the example set changes in a way that makes a new calculation of such values necessary.

setUserData

public void setUserData(java.lang.String key,
                        java.lang.Object data)

Description copied from interface: ExampleSet

Sets arbitrary user data, e.g. to cache certain performance values etc. Make sure to use a unique prefix for your keys.

getUserData

public java.lang.Object getUserData(java.lang.String key)

Description copied from interface: ExampleSet

Returns the user data set by setUserData()

See Also:

ExampleSet.setUserData(String,Object)

getUserDataKeys

public java.util.Set<java.lang.String> getUserDataKeys()

Description copied from interface: ExampleSet

Returns all askable keys of user data.