weka.core

Class Check

java.lang.Object

weka.core.Check

All Implemented Interfaces:

OptionHandler, RevisionHandler

Direct Known Subclasses:

CheckGOE, CheckOptionHandler, CheckScheme

public abstract class Check
extends Object
implements OptionHandler, RevisionHandler

Abstract general class for testing in Weka.

Version:

$Revision: 1.2 $

Author:

FracPete (fracpete at waikato dot ac dot nz)

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	m_Debug Debugging mode, gives extra output if true
protected boolean	m_Silent Silent mode, for no output at all to stdout

Constructor Summary

Constructors

Constructor and Description
Check()

Method Summary

Modifier and Type	Method and Description
abstract void	doTests() Begin the tests, reporting results to System.out
protected Object	forName(String prefix, Class cls, String classname, String[] options) Tries to instantiate a new instance of the given class and checks whether it is an instance of the specified class.
boolean	getDebug() Get whether debugging is turned on
String[]	getOptions() Gets the current settings of the CheckClassifier.
boolean	getSilent() Get whether silent mode is turned on
Enumeration	listOptions() Returns an enumeration describing the available options.
protected void	print(Object msg) prints the given message to stdout, if not silent mode
protected void	println() prints a LF to stdout, if not silent mode
protected void	println(Object msg) prints the given message (+ LF) to stdout, if not silent mode
protected static void	runCheck(Check check, String[] options) runs the CheckScheme with the given options
void	setDebug(boolean debug) Set debugging mode
void	setOptions(String[] options) Parses a given list of options.
void	setSilent(boolean value) Set slient mode, i.e., no output at all to stdout

Methods inherited from class java.lang.Object

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

Methods inherited from interface weka.core.RevisionHandler

getRevision

Field Detail

m_Debug

protected boolean m_Debug

Debugging mode, gives extra output if true

m_Silent

protected boolean m_Silent

Silent mode, for no output at all to stdout

Constructor Detail

Check

public Check()

Method Detail

listOptions

public Enumeration 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(String[] options)
                throws Exception

Parses a given list of options.

Specified by:

setOptions in interface OptionHandler

Parameters:

options - the list of options as an array of strings

Throws:

Exception - if an option is not supported

getOptions

public String[] getOptions()

Gets the current settings of the CheckClassifier.

Specified by:

getOptions in interface OptionHandler

Returns:

an array of strings suitable for passing to setOptions

forName

protected Object forName(String prefix,
                         Class cls,
                         String classname,
                         String[] options)
                  throws Exception

Tries to instantiate a new instance of the given class and checks whether it is an instance of the specified class. For convenience one can also specify a classname prefix (e.g., "weka.classifiers") to avoid long classnames and then instantiate it with the shortened classname (e.g., "trees.J48").

Parameters:

prefix - the classname prefix (without trailing dot)

cls - the class to check whether the generated object is an instance of

classname - the classname to instantiate

options - optional options for the object

Returns:

the configured object

Throws:

Exception - if instantiation fails

doTests

public abstract void doTests()

Begin the tests, reporting results to System.out

setDebug

public void setDebug(boolean debug)

Set debugging mode

Parameters:

debug - true if debug output should be printed

getDebug

public boolean getDebug()

Get whether debugging is turned on

Returns:

true if debugging output is on

setSilent

public void setSilent(boolean value)

Set slient mode, i.e., no output at all to stdout

Parameters:

value - whether silent mode is active or not

getSilent

public boolean getSilent()

Get whether silent mode is turned on

Returns:

true if silent mode is on

print

protected void print(Object msg)

prints the given message to stdout, if not silent mode

Parameters:

msg - the text to print to stdout

println

protected void println(Object msg)

prints the given message (+ LF) to stdout, if not silent mode

Parameters:

msg - the message to println to stdout

println

protected void println()

prints a LF to stdout, if not silent mode

runCheck

protected static void runCheck(Check check,
                               String[] options)

runs the CheckScheme with the given options

Parameters:

check - the checkscheme to setup and run

options - the commandline parameters to use