com.groiss.ml.field

Class ProcessField

java.lang.Object

com.groiss.ml.field.ProcessField

All Implemented Interfaces:

Field

public abstract class ProcessField
extends Object
implements Field

A Field of this kind usually does not represent a field of a process form. Instead it can be used to mix in other properties which then can be used as an input for a machine learning algorithm.

Field Summary

Fields

Modifier and Type	Field and Description
protected ProcessDefinition	pd

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProcessField(ProcessDefinition pd) Creates a new field for the given ProcessDefinition
protected	ProcessField(ProcessDefinition pd, String fieldName) Creates a new field for the given ProcessDefinition with the given field name

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getFieldName() Returns the name of the field of the data source.
String	getSource() Returns the name of the class of the data source.
int	hashCode()
abstract void	insertValue(Instance inst, DataSet instances, ProcessInstance pi) Sets a value for the attribute related to this object itself for the Instance inst.
boolean	isAllowedAsOutputField() Returns false as fields of this type are normally not designed as output fields.
boolean	isInput()
boolean	isOutput()
void	setInput(boolean isInput)
void	setOutput(boolean isOutput)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.groiss.ml.field.Field

getAttribute, getFieldNamePretty, getFullFieldName, getSourcePretty

Field Detail

pd

protected ProcessDefinition pd

Constructor Detail

ProcessField

protected ProcessField(ProcessDefinition pd)

Creates a new field for the given ProcessDefinition

Parameters:

pd - the process definition of this field

ProcessField

protected ProcessField(ProcessDefinition pd,
                       String fieldName)

Creates a new field for the given ProcessDefinition with the given field name

Parameters:

pd - the process definition of this field

fieldName - the name for this field

Method Detail

insertValue

public abstract void insertValue(Instance inst,
                                 DataSet instances,
                                 ProcessInstance pi)

Sets a value for the attribute related to this object itself for the Instance inst. The Instance and the ProcessInstance object can be used to populate inst

Parameters:

inst - the Instance object to where the value for the related Attribute should be set

instances - this is where inst belongs to

pi - the ProcessInstance of the current step

getFieldName

public String getFieldName()

Description copied from interface: Field

Returns the name of the field of the data source.

Specified by:

getFieldName in interface Field

Returns:

the field which is to consider

getSource

public String getSource()

Description copied from interface: Field

Returns the name of the class of the data source.

Specified by:

getSource in interface Field

Returns:

a class name which indicates where to assign the field to

isAllowedAsOutputField

public boolean isAllowedAsOutputField()

Returns false as fields of this type are normally not designed as output fields. May be overwritten by subclasses.

Specified by:

isAllowedAsOutputField in interface Field

Returns:

true is usable as output field

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

isOutput

public boolean isOutput()

Specified by:

isOutput in interface Field

isInput

public boolean isInput()

Specified by:

isInput in interface Field

setOutput

public void setOutput(boolean isOutput)

Specified by:

setOutput in interface Field

setInput

public void setInput(boolean isInput)

Specified by:

setInput in interface Field