weka.filters

Class CheckSource

java.lang.Object

weka.filters.CheckSource

All Implemented Interfaces:

OptionHandler, RevisionHandler

public class CheckSource
extends java.lang.Object
implements OptionHandler, RevisionHandler

A simple class for checking the source generated from Filters implementing the weka.filters.Sourcable interface. It takes a filter, the classname of the generated source and the dataset the source was generated with as parameters and tests the output of the built filter against the output of the generated source. Use option '-h' to display all available commandline options. Valid options are:

 -W <classname and options>
  The filter (incl. options) that was used to generate
  the source code.
 

 -S <classname>
  The classname of the generated source code.
 

 -t <file>
  The training set with which the source code was generated.
 

 -c <index>
  The class index of the training set. 'first' and 'last' are
  valid indices.
  (default: none)
 

Options after -- are passed to the designated filter.

See Also:

Sourcable

Field Summary

Fields

Modifier and Type	Field and Description
protected int	m_ClassIndex the class index
protected java.io.File	m_Dataset the dataset to use for testing
protected Filter	m_Filter the classifier used for generating the source code
protected Filter	m_SourceCode the generated source code

Constructor Summary

Constructors

Constructor and Description
CheckSource()

Method Summary

Modifier and Type	Method and Description
protected boolean	compare(Instance inst1, Instance inst2) compares two Instance
protected boolean	compare(Instances inst1, Instances inst2) compares the two Instances objects
boolean	execute() performs the comparison test
int	getClassIndex() Gets the class index of the dataset.
java.io.File	getDataset() Gets the dataset to use for testing, can be null.
Filter	getFilter() Gets the filter being used for the tests, can be null.
java.lang.String[]	getOptions() Gets the current settings of the filter.
java.lang.String	getRevision() Returns the revision string.
Filter	getSourceCode() Gets the class to test.
java.util.Enumeration<Option>	listOptions() Returns an enumeration describing the available options.
static void	main(java.lang.String[] args) Executes the tests, use "-h" to list the commandline options.
void	setClassIndex(int value) Sets the class index of the dataset.
void	setDataset(java.io.File value) Sets the dataset to use for testing.
void	setFilter(Filter value) Sets the filter to use for the comparison.
void	setOptions(java.lang.String[] options) Parses a given list of options.
void	setSourceCode(Filter value) Sets the class to test.

Methods inherited from class java.lang.Object

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

Field Detail

m_Filter

protected Filter m_Filter

the classifier used for generating the source code

m_SourceCode

protected Filter m_SourceCode

the generated source code

m_Dataset

protected java.io.File m_Dataset

the dataset to use for testing

m_ClassIndex

protected int m_ClassIndex

the class index

Constructor Detail

CheckSource

public CheckSource()

Method Detail

listOptions

public java.util.Enumeration<Option> listOptions()

Returns an enumeration describing the available options.

Specified by:

listOptions in interface OptionHandler

Returns:

an enumeration of all the available options.

setOptions

public void setOptions(java.lang.String[] options)
                throws java.lang.Exception

Parses a given list of options.

Valid options are:

 -W <classname and options>
  The filter (incl. options) that was used to generate
  the source code.
 

 -S <classname>
  The classname of the generated source code.
 

 -t <file>
  The training set with which the source code was generated.
 

 -c <index>
  The class index of the training set. 'first' and 'last' are
  valid indices.
  (default: none)
 

Options after -- are passed to the designated filter.

Specified by:

setOptions in interface OptionHandler

Parameters:

options - the list of options as an array of strings

Throws:

java.lang.Exception - if an option is not supported

getOptions

public java.lang.String[] getOptions()

Gets the current settings of the filter.

Specified by:

getOptions in interface OptionHandler

Returns:

an array of strings suitable for passing to setOptions

setFilter

public void setFilter(Filter value)

Sets the filter to use for the comparison.

Parameters:

value - the filter to use

getFilter

public Filter getFilter()

Gets the filter being used for the tests, can be null.

Returns:

the currently set filter

setSourceCode

public void setSourceCode(Filter value)

Sets the class to test.

Parameters:

value - the class to test

getSourceCode

public Filter getSourceCode()

Gets the class to test.

Returns:

the currently set class, can be null.

setDataset

public void setDataset(java.io.File value)

Sets the dataset to use for testing.

Parameters:

value - the dataset to use.

getDataset

public java.io.File getDataset()

Gets the dataset to use for testing, can be null.

Returns:

the dataset to use.

setClassIndex

public void setClassIndex(int value)

Sets the class index of the dataset.

Parameters:

value - the class index of the dataset.

getClassIndex

public int getClassIndex()

Gets the class index of the dataset.

Returns:

the current class index.

compare

protected boolean compare(Instance inst1,
                          Instance inst2)

compares two Instance

Parameters:

inst1 - the first Instance object to compare

inst2 - the second Instance object to compare

Returns:

true if both are the same

compare

protected boolean compare(Instances inst1,
                          Instances inst2)

compares the two Instances objects

Parameters:

inst1 - the first Instances object to compare

inst2 - the second Instances object to compare

Returns:

true if both are the same

execute

public boolean execute()
                throws java.lang.Exception

performs the comparison test

Returns:

true if tests were successful

Throws:

java.lang.Exception - if tests fail

getRevision

public java.lang.String getRevision()

Returns the revision string.

Specified by:

getRevision in interface RevisionHandler

Returns:

the revision

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Executes the tests, use "-h" to list the commandline options.

Parameters:

args - the commandline parameters

Throws:

java.lang.Exception - if something goes wrong