org.encog.app.analyst.script

Class AnalystScript

java.lang.Object

org.encog.app.analyst.script.AnalystScript

public class AnalystScript
extends java.lang.Object

Holds a script for the Encog Analyst.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_CLASS The default MAX size for a class.

Constructor Summary

Constructors

Constructor and Description
AnalystScript() Construct an analyst script.

Method Summary

Modifier and Type	Method and Description
void	addTask(AnalystTask task) Add a task.
void	clearTasks() Clear all tasks.
AnalystField	defineClass(java.lang.String fieldName, FieldDirection d, NormalizationAction action, java.util.List<ClassItem> classes)
AnalystField	defineField(java.lang.String fieldName, FieldDirection d, NormalizationAction action, double theActualHigh, double theActualLow)
CSVFormat	determineFormat() Determine the output format.
boolean	expectInputHeaders(java.lang.String filename) Determine if input headers are expected.
AnalystField	findAnalystField(java.lang.String fieldName)
DataField	findDataField(java.lang.String name) Find the specified data field.
int	findDataFieldIndex(DataField df) Find the specified data field and return its index.
AnalystField	findNormalizedField(java.lang.String name, int slice) Find the specified normalized field.
java.lang.String	getBasePath()
DataField[]	getFields()
AnalystNormalize	getNormalize()
java.util.List<ScriptOpcode>	getOpcodes()
int	getPrecision()
AnalystProcess	getProcess()
ScriptProperties	getProperties()
AnalystSegregate	getSegregate()
AnalystTask	getTask(java.lang.String name) Get the specified task.
java.util.Map<java.lang.String,AnalystTask>	getTasks()
boolean	hasClasses()
void	init() Init this script.
boolean	isGenerated(java.lang.String filename) Determine if the specified file was generated.
void	load(java.io.InputStream stream) Load the script.
void	markGenerated(java.lang.String filename) Mark the sepcified filename as generated.
java.io.File	resolveFilename(java.lang.String sourceID) Resolve the specified filename.
void	save(java.io.OutputStream stream) Save to the specified output stream.
void	setBasePath(java.lang.String theBasePath) Set the base path.
void	setDefaultNormalizedRange(double low, double high)
void	setFields(DataField[] theFields)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_CLASS

public static final int DEFAULT_MAX_CLASS

The default MAX size for a class.

See Also:

Constant Field Values

Constructor Detail

AnalystScript

public AnalystScript()

Construct an analyst script.

Method Detail

addTask

public void addTask(AnalystTask task)

Add a task.

Parameters:

task - The task to add.

clearTasks

public void clearTasks()

Clear all tasks.

determineFormat

public CSVFormat determineFormat()

Determine the output format.

Returns:

The output format.

expectInputHeaders

public boolean expectInputHeaders(java.lang.String filename)

Determine if input headers are expected.

Parameters:

filename - The filename.

Returns:

True if headers are expected.

findDataField

public DataField findDataField(java.lang.String name)

Find the specified data field. Use name to find, and ignore case.

Parameters:

name - The name to search for.

Returns:

The specified data field.

findDataFieldIndex

public int findDataFieldIndex(DataField df)

Find the specified data field and return its index.

Parameters:

df - The data field to search for.

Returns:

The index of the specified data field, or -1 if not found.

findNormalizedField

public AnalystField findNormalizedField(java.lang.String name,
                                        int slice)

Find the specified normalized field. Search without case.

Parameters:

name - The name of the field we are searching for.

slice - The timeslice.

Returns:

The analyst field that was found.

getBasePath

public java.lang.String getBasePath()

Returns:

The base path.

getFields

public DataField[] getFields()

Returns:

the data fields.

getNormalize

public AnalystNormalize getNormalize()

Returns:

the normalize

getPrecision

public int getPrecision()

Returns:

The precision.

getProperties

public ScriptProperties getProperties()

Returns:

the properties

getSegregate

public AnalystSegregate getSegregate()

Returns:

the segregate

getTask

public AnalystTask getTask(java.lang.String name)

Get the specified task.

Parameters:

name - The name of the testk.

Returns:

The analyst task.

getTasks

public java.util.Map<java.lang.String,AnalystTask> getTasks()

Returns:

The tasks.

init

public void init()

Init this script.

isGenerated

public boolean isGenerated(java.lang.String filename)

Determine if the specified file was generated.

Parameters:

filename - The filename to check.

Returns:

True, if the specified file was generated.

load

public void load(java.io.InputStream stream)

Load the script.

Parameters:

stream - The stream to load from.

markGenerated

public void markGenerated(java.lang.String filename)

Mark the sepcified filename as generated.

Parameters:

filename - The filename.

resolveFilename

public java.io.File resolveFilename(java.lang.String sourceID)

Resolve the specified filename.

Parameters:

sourceID - The filename to resolve.

Returns:

The file path.

save

public void save(java.io.OutputStream stream)

Save to the specified output stream.

Parameters:

stream - The output stream.

setBasePath

public void setBasePath(java.lang.String theBasePath)

Set the base path.

Parameters:

theBasePath - The base path.

setFields

public void setFields(DataField[] theFields)

Parameters:

theFields - the fields to set

findAnalystField

public AnalystField findAnalystField(java.lang.String fieldName)

getProcess

public AnalystProcess getProcess()

getOpcodes

public java.util.List<ScriptOpcode> getOpcodes()

Returns:

the opcodes

hasClasses

public boolean hasClasses()

defineField

public AnalystField defineField(java.lang.String fieldName,
                                FieldDirection d,
                                NormalizationAction action,
                                double theActualHigh,
                                double theActualLow)

setDefaultNormalizedRange

public void setDefaultNormalizedRange(double low,
                                      double high)

defineClass

public AnalystField defineClass(java.lang.String fieldName,
                                FieldDirection d,
                                NormalizationAction action,
                                java.util.List<ClassItem> classes)