proper.core
Interface ProperInterface

All Known Implementing Classes:

About, Application, ApplicationFrame, ArffComparer, Arffer, ArffFilter, ArffViewer, ArgumentObject, BagArffer, Bagger, Builder, ChildFrame, Classifier, ColumnLister, CommandLineFrame, Connector, ConnectorObject, Creator, CSVParser, Data, DatabaseApplication, DatabaseChildFrame, DatabaseEngine, DatabaseLister, Databases, DataMessage, Dropper, DummyFrame, Editor, Engine, Executor, ExecutorObject, Experimenter, Experimenter, ExperimentFrame, Explorer, Export, FileMessage, Fingerprint, Flattener, ForeignKeys, Help, Import, Importer, Indexer, Instancer, JobAdder, Jobber, JobClient, JobMessage, JobMonitor, Jobs, JobServer, Joiner, Logger, Message, MIExperimenter, Milk, Milk, MILK, MilkClassifier, MilkExperimenter, Modifier, Namer, Parser, PostProcessor, PrologParser, Propagation, Propagator, Proper, ProperFrame, ProperObject, Reader, Reducer, Relaggs, Relaggs, RELAGGS, RelaggsStructure, RelationDiscoverer, Relations, Relations, ReMilk, REMILK, ReMilker, Run, Server, Setup, Sparser, SqlEngine, SqlViewer, Standalone, TableLister, Tester, Traverser, Weka, WekaClassifier, WekaExperimenter, Writer, XSLer

public interface ProperInterface

This interface implements some behavior for verbose string handling and redirecting output.
All methods with the prefix debug have the same functionality as the ones without, only used to distinguish distinguish output during development that should not be included in a release.

Version:

$Revision: 1.2 $

Author:

FracPete

Field Summary

static java.lang.String

VERSION the version number of Proper

Method Summary

void	addListener(ProperInterface o) adds the object to the listener list
void	addOutput(java.io.PrintStream out) adds the printstream to use for outputting data, i.e.
boolean	classInVerbose(java.lang.String classname) checks whether the given class name is part of the verbose string
void	debugprint(boolean x) prints the given boolean to the current ouput stream (debug)
void	debugprint(int x) prints the given int to the current output stream (debug)
void	debugprint(java.lang.Object x) prints the given object to the current ouput stream (debug)
void	debugprint(java.lang.String x) prints the given string to the current ouput stream (debug)
void	debugprintln() prints a new line to the current ouput stream (debug)
void	debugprintln(boolean x) prints the given boolean to the current ouput stream (debug)
void	debugprintln(int x) prints the given int to the current ouput stream (debug)
void	debugprintln(java.lang.Object x) prints the given object to the current ouput stream (debug)
void	debugprintln(java.lang.String x) prints the given string to the current ouput stream (debug)
java.util.Vector	getListeners() returns the current list of listeners
java.lang.Runtime	getRuntime() returns the runtime instance for this application
boolean	getVerbose() the current verbose state
int	getVerboseLevel() the current verbose level
int	getVerboseLevelForClass(java.lang.String classname) returns the verbose level for this class from the given classname-list
java.lang.String	getVerboseString() returns the verbose string
java.lang.String	getVerboseStringForClass(java.lang.String classname) returns the verbose string (can be "") for this class from the given classname-list
void	notifyListener(ProperInterface o) notifies the specified listener of changes
void	notifyListeners() notifies all the listeners of changes
void	print(boolean x) prints the given boolean to the current ouput stream
void	print(int x) prints the given int to the current output stream
void	print(java.lang.Object x) prints the given object to the current ouput stream
void	print(java.lang.String x) prints the given string to the current ouput stream
void	println() prints a new line to the current ouput stream
void	println(boolean x) prints the given boolean to the current ouput stream
void	println(int x) prints the given int to the current ouput stream
void	println(java.lang.Object x) prints the given object to the current ouput stream
void	println(java.lang.String x) prints the given string to the current ouput stream
void	printMemory() prints out the currently free and total memory in the JVM
void	removeListener(ProperInterface o) removes the object from the listeners
void	setOutput(java.io.PrintStream out) sets the printstream to use for outputting data, i.e.
void	setVerbose(boolean verbose) sets the verbose state (lots of information of more silent)
void	setVerboseLevel(int verboseLevel) sets the verbose level (0 = nothing, >0 = more)
void	setVerboseString(java.lang.String verboseStr) sets the string with the class names (comma separated and w/o path) that should set their verbose flag to TRUE a number at the end of the classname, separated by a colon, e.g.

Field Detail

VERSION

static final java.lang.String VERSION

the version number of Proper

See Also:

Constant Field Values

Method Detail

addListener

void addListener(ProperInterface o)

adds the object to the listener list

removeListener

void removeListener(ProperInterface o)

removes the object from the listeners

getListeners

java.util.Vector getListeners()

returns the current list of listeners

notifyListener

void notifyListener(ProperInterface o)

notifies the specified listener of changes

notifyListeners

void notifyListeners()

notifies all the listeners of changes

setVerbose

void setVerbose(boolean verbose)

sets the verbose state (lots of information of more silent)

getVerbose

boolean getVerbose()

the current verbose state

setVerboseLevel

void setVerboseLevel(int verboseLevel)

sets the verbose level (0 = nothing, >0 = more)

getVerboseLevel

int getVerboseLevel()

the current verbose level

setOutput

void setOutput(java.io.PrintStream out)

sets the printstream to use for outputting data, i.e. stdout and this stream

addOutput

void addOutput(java.io.PrintStream out)

adds the printstream to use for outputting data, i.e. adds the stream to the existing ones

getVerboseStringForClass

java.lang.String getVerboseStringForClass(java.lang.String classname)

returns the verbose string (can be "") for this class from the given classname-list

Parameters:

classname - the list of classes to verbose

getVerboseLevelForClass

int getVerboseLevelForClass(java.lang.String classname)

returns the verbose level for this class from the given classname-list

Parameters:

classname - the list of classes to verbose

classInVerbose

boolean classInVerbose(java.lang.String classname)

checks whether the given class name is part of the verbose string

setVerboseString

void setVerboseString(java.lang.String verboseStr)

sets the string with the class names (comma separated and w/o path) that should set their verbose flag to TRUE
a number at the end of the classname, separated by a colon, e.g. "bla.blurp:1" means verbose level 1 for class "bla.blurp"

getVerboseString

java.lang.String getVerboseString()

returns the verbose string

getRuntime

java.lang.Runtime getRuntime()

returns the runtime instance for this application

printMemory

void printMemory()

prints out the currently free and total memory in the JVM

print

void print(int x)

prints the given int to the current output stream

print

void print(boolean x)

prints the given boolean to the current ouput stream

print

void print(java.lang.String x)

prints the given string to the current ouput stream

print

void print(java.lang.Object x)

prints the given object to the current ouput stream

println

void println()

prints a new line to the current ouput stream

println

void println(int x)

prints the given int to the current ouput stream

println

void println(boolean x)

prints the given boolean to the current ouput stream

println

void println(java.lang.String x)

prints the given string to the current ouput stream

println

void println(java.lang.Object x)

prints the given object to the current ouput stream

debugprint

void debugprint(int x)

prints the given int to the current output stream (debug)

debugprint

void debugprint(boolean x)

prints the given boolean to the current ouput stream (debug)

debugprint

void debugprint(java.lang.String x)

prints the given string to the current ouput stream (debug)

debugprint

void debugprint(java.lang.Object x)

prints the given object to the current ouput stream (debug)

debugprintln

void debugprintln()

prints a new line to the current ouput stream (debug)

debugprintln

void debugprintln(int x)

prints the given int to the current ouput stream (debug)

debugprintln

void debugprintln(boolean x)

prints the given boolean to the current ouput stream (debug)

debugprintln

void debugprintln(java.lang.String x)

prints the given string to the current ouput stream (debug)

debugprintln

void debugprintln(java.lang.Object x)

prints the given object to the current ouput stream (debug)