nl.liacs.timeseries.main

Class Operation

java.lang.Object

nl.liacs.timeseries.main.Operation

All Implemented Interfaces:

java.util.concurrent.Callable<double[]>

public class Operation
extends java.lang.Object
implements java.util.concurrent.Callable<double[]>

Operation is one of the most fundamental constructs in the application. An Operation holds all the information necessary to load data and perform a user defined action.

An Operation is formed from a String that supplies all required information. Such a String must adhere to the following strict format:
tableSourcePath; columnName(s); OperationName(parameter(s), ); delay .
The various parts are separated by the operation settings separator. This path will be used by the file loader.

tableSourcePath: the path of the Table on which the Operation is to be performed.

columnName(s): the name(s) of the column(s) on which the Operation is to be performed. Note that only a limited number of Features require multiple columns to operate on. All other Operations work on a single column at a time, and to perform such an Operation on multiple columns, multiple Operations should be created, one for each column. When multiple columns are listed they should be separated by the column list separator.

OperationName(parameter(s), ...): the name of the Operation to perform. It should correspond to the simple name of a Class in either the kernel or feature package of the application. Consult the default constructor for each Class for the list of expected parameters.

delay: the delay to take into account. Both positive and negative integers are allowed, as well as 0.

Author:

Marvin Meeng Last updated 11.07.2012

See Also:

Separator, Table, FileLoader, Quickie, Class

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	angle_brackets_replacement
static java.lang.String	COLUMN_DELIMITER
static java.lang.String	comma_replacement
static java.lang.String	curly_brackets_replacement
static java.lang.String	DELIMITER
static java.lang.String	minus_replacement
static java.lang.String	point_replacement
static java.lang.String	round_brackets_replacement
static java.lang.String	square_brackets_replacement
static java.lang.String	whitespace_replacement

Constructor Summary

Constructors

Constructor and Description
Operation(java.lang.String theOperation) Creates an Operation from the input parameter.

Method Summary

Methods

Modifier and Type	Method and Description
double[]	call() Returns the result for this Operation.
java.lang.String	get(OperationTableModel.OperationTableHeader theColumn) Returns the value of the Operation corresponding to the OperationTableHeader column parameter.
java.lang.String	getTablePath() Returns the String representation of the Path of the Table on which the Operation is to be performed.
java.lang.String	toColumnName() Returns a short String representation of the Operation.

Methods inherited from class java.lang.Object

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

Field Detail

DELIMITER

public static final java.lang.String DELIMITER

See Also:

Constant Field Values

COLUMN_DELIMITER

public static final java.lang.String COLUMN_DELIMITER

See Also:

Constant Field Values

round_brackets_replacement

public static java.lang.String round_brackets_replacement

square_brackets_replacement

public static java.lang.String square_brackets_replacement

curly_brackets_replacement

public static java.lang.String curly_brackets_replacement

angle_brackets_replacement

public static java.lang.String angle_brackets_replacement

point_replacement

public static java.lang.String point_replacement

comma_replacement

public static java.lang.String comma_replacement

minus_replacement

public static java.lang.String minus_replacement

whitespace_replacement

public static java.lang.String whitespace_replacement

Constructor Detail

Operation

public Operation(java.lang.String theOperation)

Creates an Operation from the input parameter.

The input parameter String must adhere to the format given is the class description.

Parameters:

theOperation - The String to form an Operation from.

See Also:

Table, Separator, Class

Method Detail

getTablePath

public java.lang.String getTablePath()

Returns the String representation of the Path of the Table on which the Operation is to be performed.

Returns:

The String representation of the Path.

See Also:

Table, FileLoader

toColumnName

public java.lang.String toColumnName()

Returns a short String representation of the Operation.

The short representation of an Operation has most special characters removed that could cause problems when interpreted in external applications. For example, comma and tab characters may cause problems in spreadsheet and database applications. See the various public static final String *_replacement for which characters will be replaced by what.

Returns:

The short String representation of the Operation.

get

public java.lang.String get(OperationTableModel.OperationTableHeader theColumn)

Returns the value of the Operation corresponding to the OperationTableHeader column parameter.

Parameters:

theColumn - The OperationTableHeader column for which to return the Operation's value.

Returns:

The String value.

See Also:

OperationTableModel.OperationTableHeader

call

public double[] call()
              throws java.lang.Exception

Returns the result for this Operation.

The returned result is identical to the result obtained through a direct invocation of the applyTo() method of a Kernel or Feature.

The execution of an Operation can fail in many ways. If no Class can be found corresponding the Operation, the method will return null.
If no Class instance can be created for the corresponding Operation, due to a constructor error, the method will return null.
If the Table on which to perform the Operation can not be loaded, the method will return null.

Specified by:

call in interface java.util.concurrent.Callable<double[]>

Returns:

A double[] containing the result.

Throws:

java.lang.Exception

See Also:

Table, AbstractKernel.applyTo(double[], int)