magpie.user

Class CommandHandler

java.lang.Object

magpie.user.CommandHandler

public class CommandHandler
extends java.lang.Object

This class turns text commands into actions.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	EchoCommands Whether to echo commands to screen
protected java.util.Set<java.lang.String>	ElementalProperties Which elemental properties to use when calculating features
protected java.lang.String	ElementalPropertyDirectory Directory that contain elemental property lookup files
long	StartTime Holds start time of default timer
protected Workspace	Workspace Keep track of which variables have been created

Constructor Summary

Constructors

Constructor and Description
CommandHandler()

Method Summary

Modifier and Type	Method and Description
protected void	assignment(java.util.List<java.lang.String> Command) Handle variable assignment
static java.lang.String[]	convertCommandToString(java.util.List<java.lang.Object> Command) Convert a command (List<Object>) to string.
protected java.util.List<java.lang.Object>	expandTextCommand(java.util.List<java.lang.String> TextCommand) Given a text command, change any word marked with a "$" in the front to the corresponding variable.
java.util.List<java.lang.String>	getCitationDescriptions(java.lang.String variableName) Print out citation information associated with a single variable
protected void	handlePrinting(java.util.List<java.lang.String> Command) Run commands that require printing something to screen.
protected void	handleSaving(java.util.List<java.lang.String> Command) Save objects to disk as various formats.
protected void	handleSettings(java.util.List<java.lang.String> Command) Handles commands that change global settings
static java.lang.Object	instantiateClass(java.lang.String ClassType, java.util.List<java.lang.Object> Options) Create new instance of a class given type and options.
void	printCitations(java.util.List<java.lang.String> command) Run command to print out citations.
void	readFile(java.lang.String Filename) Reads commands from a text file
void	runCommand(java.util.List<java.lang.String> TextCommand) Given a command, run some actions
protected java.lang.Object	runCommandOnVariable(java.lang.String variableName, java.util.List<java.lang.Object> Command) Pass commands to variables.
protected static java.lang.String	runEvaluationCommand(java.util.List<java.lang.Object> Command) Run an evaluation command.
protected java.lang.String	runTimerCommand(java.util.List<java.lang.String> Command) Run a certain time command.

Methods inherited from class java.lang.Object

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

Field Detail

Workspace

protected final Workspace Workspace

Keep track of which variables have been created

ElementalProperties

protected final java.util.Set<java.lang.String> ElementalProperties

Which elemental properties to use when calculating features

EchoCommands

public boolean EchoCommands

Whether to echo commands to screen

StartTime

public long StartTime

Holds start time of default timer

ElementalPropertyDirectory

protected java.lang.String ElementalPropertyDirectory

Directory that contain elemental property lookup files

Constructor Detail

CommandHandler

public CommandHandler()

Method Detail

runEvaluationCommand

protected static java.lang.String runEvaluationCommand(java.util.List<java.lang.Object> Command)
                                                throws java.lang.Exception

Run an evaluation command. Given a model to run, a Dataset to generate attributes, and prints out the predictions.

Usage: $<model> $<dataset> <entries...>
model: Model used to make predictions
dataset: Dataset template used to generate attributes
entries...: Strings representing entries to evaluate

Parameters:

Command - Command to evaluate

Returns:

Table of results

Throws:

java.lang.Exception

instantiateClass

public static java.lang.Object instantiateClass(java.lang.String ClassType,
                                                java.util.List<java.lang.Object> Options)
                                         throws java.lang.Exception

Create new instance of a class given type and options. Class name must be fully specified within the magpie package (i.e. "data.materials.CompositionDataset")

Parameters:

ClassType - Full name of class to create minus "magpie"

Options - Array specifying option commands (can be empty/null)

Returns:

Newly instantiated class

Throws:

java.lang.Exception - For various reasons

convertCommandToString

public static java.lang.String[] convertCommandToString(java.util.List<java.lang.Object> Command)

Convert a command (List<Object>) to string. Uses Object.toString()

Parameters:

Command - Command to be converted

Returns:

Command as an array of strings

runCommand

public void runCommand(java.util.List<java.lang.String> TextCommand)

Given a command, run some actions

Parameters:

TextCommand - List of words that comprise a command

expandTextCommand

protected java.util.List<java.lang.Object> expandTextCommand(java.util.List<java.lang.String> TextCommand)
                                                      throws java.lang.Exception

Given a text command, change any word marked with a "$" in the front to the corresponding variable.

Parameters:

TextCommand - Command as a list of text words

Returns:

Command as a list of objects

Throws:

java.lang.Exception

assignment

protected void assignment(java.util.List<java.lang.String> Command)
                   throws java.lang.Exception

Handle variable assignment

Parameters:

Command - Command to be parsed

Throws:

java.lang.Exception - If something goes wrong

handleSettings

protected void handleSettings(java.util.List<java.lang.String> Command)
                       throws java.lang.Exception

Handles commands that change global settings

Parameters:

Command - Command to be parsed

Throws:

java.lang.Exception - For various reasons

runCommandOnVariable

protected java.lang.Object runCommandOnVariable(java.lang.String variableName,
                                                java.util.List<java.lang.Object> Command)
                                         throws java.lang.Exception

Pass commands to variables. The requested operations may generate some output, but otherwise generate null.

Parameters:

variableName - Name of variable to act on

Command - Command to be executed

Returns:

Output from the requested operation, null if nothing generated

Throws:

java.lang.Exception - If execution fails

readFile

public void readFile(java.lang.String Filename)

Reads commands from a text file

Parameters:

Filename - Path of file to read

handlePrinting

protected void handlePrinting(java.util.List<java.lang.String> Command)
                       throws java.lang.Exception

Run commands that require printing something to screen.

Expects commands to be of the form: print <variable name> <command> [<options>]

Parameters:

Command - Print commands to be parsed

Throws:

java.lang.Exception - For various reasons

runTimerCommand

protected java.lang.String runTimerCommand(java.util.List<java.lang.String> Command)
                                    throws java.lang.Exception

Run a certain time command. Two options:

• start [<name>] - Initialize timer. If no name, alters default timer
• elapsed [<name>] - Return elapsed time. If no name, prints default timer

Parameters:

Command - Timer command to be parsed

Returns:

String describing result

Throws:

java.lang.Exception

handleSaving

protected void handleSaving(java.util.List<java.lang.String> Command)
                     throws java.lang.Exception

Save objects to disk as various formats.

Parameters:

Command - Command to be parsed

Throws:

java.lang.Exception

printCitations

public void printCitations(java.util.List<java.lang.String> command)
                    throws java.lang.Exception

Run command to print out citations. First word should be "citations". If there are additional words in the command, they should be names of variables

Usage: citations [<variable names...>]
variable names: Optional: Names of variables to be printed

Parameters:

command - Command to be run

Throws:

java.lang.Exception - If variables are not found in workspace

getCitationDescriptions

public java.util.List<java.lang.String> getCitationDescriptions(java.lang.String variableName)
                                                         throws java.lang.Exception

Print out citation information associated with a single variable

Parameters:

variableName - Variable to be assessed

Returns:

Lines of output for variable being assessed

Throws:

java.lang.Exception - If variable not found