edu.udo.cs.yale.operator.io
Class ExampleSetWriter

java.lang.Object
  edu.udo.cs.yale.operator.Operator
      edu.udo.cs.yale.operator.io.ExampleSetWriter

All Implemented Interfaces:

ConfigurationListener

public class ExampleSetWriter
extends Operator

Writes values of all examples in an ExampleSet to a file. Dense, sparse, and user defined formats (specified by the parameter 'format') can be used. Attribute description files may be generated for dense and sparse format as well. These formats can be read using the ExampleSource and SparseFormatExampleSource operators.

dense:

Each line of the generated data file is of the form

 regular attributes <special attributes>
 

For example, each line could have the form

 value1 value2 ... valueN <id> <label> <prediction> ... <confidences>
 

Values in parenthesis are optional and are only printed if they are available. The confidences are only given for nominal predictions. Other special attributes might be the example weight or the cluster number.

sparse:

Only non 0 values are written to the file, prefixed by a column index. See the description of SparseFormatExampleSource for details.

special:

Using the parameter 'special_format', the user can specify the exact format. The $ sign has a special meaning and introduces a command (the following character) Additional arguments to this command may be supplied enclosing it in square brackets.

$a:

All attributes separated by the default separator

$a[separator]:

All attributes separated by separator

$s[separator][indexSeparator]:

Sparse format. For all non zero attributes the following strings are concatenated: the column index, the value of indexSeparator, the attribute value. Attributes are separated by separator.

$v[name]:

The value of the attribute with the given name (both regular and special attributes)

$k[index]:

The value of the attribute with the given index

$l:

The label

$p:

The predicted label

$d:

All prediction confidences for all classes in the form conf(class)=value

$d[class]:

The prediction confidence for the defined class as a simple number

$i:

The id

$w:

The weight

$b:

The batch number

$n:

The newline character

$t:

The tabulator character

$$:

The dollar sign

$[:

The '[' character

$]:

The ']' character

Make sure the format string ends with $n if you want examples to be separated by newlines!

Version:

$Id: ExampleSetWriter.java,v 1.15 2006/03/27 13:22:00 ingomierswa Exp $

Author:

Simon Fischer, Ingo Mierswa

See Also:

ExampleSet

Field Summary

private static int	DENSE_FORMAT
private static java.lang.String[]	formatNames

Constructor Summary

ExampleSetWriter(OperatorDescription description)

Method Summary

IOObject[]	apply() Implement this method in subclasses.
java.lang.Class[]	getInputClasses() Returns the classes that are needed as input.
java.lang.Class[]	getOutputClasses() Returns the classes that are guaranteed to be returned by apply() as additional output.
java.util.List<ParameterType>	getParameterTypes() Returns a list of ParameterTypes describing the parameters of this operator.
private void	writeSpecialFormat(ExampleSet exampleSet, java.io.File dataFile)

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

addError, addValue, addWarning, apply, checkDeprecations, checkIO, checkProperties, clearErrorList, cloneOperator, createExperimentTree, createExperimentTree, createFromXML, createMarkedExperimentTree, delete, experimentFinished, experimentStarts, getAddOnlyAdditionalOutput, getApplyCount, getDeliveredOutputClasses, getDeprecationInfo, getDesiredInputClasses, getErrorList, getExperiment, getInnerOperatorsXML, getInput, getInput, getInput, getInputDescription, getIOContainerForInApplyLoopBreakpoint, getName, getNumberOfSteps, getOperatorClassName, getOperatorDescription, getParameter, getParameterAsBoolean, getParameterAsColor, getParameterAsDouble, getParameterAsFile, getParameterAsInt, getParameterAsString, getParameterList, getParameters, getParameterType, getParent, getStartTime, getStatus, getUserDescription, getValue, getValues, getXML, hasBreakpoint, hasBreakpoint, hasInput, inApplyLoop, isEnabled, isParameterSet, logMessage, performAdditionalChecks, register, remove, rename, resume, setBreakpoint, setEnabled, setExperiment, setInput, setListParameter, setOperatorParameters, setParameter, setParameters, setParent, setUserDescription, toString, writeXML

Methods inherited from class java.lang.Object

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

Field Detail

formatNames

private static java.lang.String[] formatNames

DENSE_FORMAT

private static final int DENSE_FORMAT

See Also:

Constant Field Values

Constructor Detail

ExampleSetWriter

public ExampleSetWriter(OperatorDescription description)

Method Detail

apply

public IOObject[] apply()
                 throws OperatorException

Description copied from class: Operator

Implement this method in subclasses.

Specified by:

apply in class Operator

Throws:

OperatorException

writeSpecialFormat

private void writeSpecialFormat(ExampleSet exampleSet,
                                java.io.File dataFile)
                         throws OperatorException

Throws:

OperatorException

getInputClasses

public java.lang.Class[] getInputClasses()

Description copied from class: Operator

Returns the classes that are needed as input. May be null or an empty (no desired input). As default, all delivered input objects are consumed and must be also delivered as output in both Operator.getOutputClasses() and Operator.apply() if this is necessary. This default behavior can be changed by overriding Operator.getInputDescription(Class). Subclasses which implement this method should not make use of parameters since this method is invoked by getParameterTypes(). Therefore, parameters are not fully available at this point of time and this might lead to exceptions. Please use InputDescriptions instead.

Specified by:

getInputClasses in class Operator

getOutputClasses

public java.lang.Class[] getOutputClasses()

Description copied from class: Operator

Returns the classes that are guaranteed to be returned by apply() as additional output. Please note that input object which should not be consumed must also be defined by this method (e.g. for preprocessing operators). The default behavior for input consumation is defined by Operator.getInputDescription(Class) and can be changed by overwriting this method. Objects which are not consumed must not be defined as additional output in this method. May be null or an empy array (no additional output is produced).

Specified by:

getOutputClasses in class Operator

getParameterTypes

public java.util.List<ParameterType> getParameterTypes()

Description copied from class: Operator

Returns a list of ParameterTypes describing the parameters of this operator. The default implementation returns an empty list if no input objects can be retained and special parameters for those input objects which can be prevented from being consumed.

Overrides:

getParameterTypes in class Operator