weka.knowledgeflow.steps

Class SetPropertiesFromEnvironment

java.lang.Object

weka.knowledgeflow.steps.BaseStep

weka.knowledgeflow.steps.SetPropertiesFromEnvironment

All Implemented Interfaces:

java.io.Serializable, BaseStepExtender, Step

@KFStep(name="SetPropertiesFromEnvironment",
        category="Flow",
        toolTipText="Set properties of the connected algorithm-based step (e.g. Classifier, Clusterer etc.) using values stored in the flow environment. If no property path for a particular setting value is specified, then it is assumed that the value provided is scheme name + options in command-line form, in which case the underlying scheme of the connected step will be constructed and set; otherwise, the property path is used to set a value on the existing underlying scheme.",
        iconPath="weka/gui/knowledgeflow/icons/SetPropertiesFromEnvironment.gif")
public class SetPropertiesFromEnvironment
extends BaseStep

Step that accesses property values stored in the flow environment and attempts to set them on the algorithm-based step that it is connected to.

See Also:

Serialized Form

Field Summary

Fields inherited from class weka.knowledgeflow.steps.BaseStep

m_stepIsResourceIntensive, m_stepManager, m_stepName

Constructor Summary

Constructors

Constructor and Description
SetPropertiesFromEnvironment()

Method Summary

Modifier and Type	Method and Description
protected java.lang.Object	drillToProperty(java.lang.Object baseObject, java.util.List<java.lang.String> propertyPath) Drill down to the last element in the supplied property path list on the given base object
java.util.List<java.lang.String>	getIncomingConnectionTypes() Get a list of acceptable incoming connection types
java.util.List<java.lang.String>	getOutgoingConnectionTypes() Get a list of outgoing connection types that this step can produce.
protected java.beans.PropertyDescriptor	getPropDescriptor(java.lang.Object target, java.lang.String propName) Gets the property descriptor for the supplied property name on the supplied target object
protected void	setProperties(WekaAlgorithmWrapper target, java.util.Map<java.lang.String,java.lang.String> propertiesToSet) Set properties on the specified target objet
protected void	setValue(java.lang.Object target, java.lang.String targetName, java.lang.String propName, java.lang.Object valToSet) Sets the value of the property on the target object
void	stepInit() Initialize the step.
protected java.lang.Object	stringToVal(java.lang.String propVal, java.lang.Object target, java.lang.String propName) Attempts to convert a property value in string form to the object type that the actual property accepts

Methods inherited from class weka.knowledgeflow.steps.BaseStep

environmentSubstitute, getCustomEditorForStep, getDefaultSettings, getInteractiveViewers, getInteractiveViewersImpls, getName, getStepManager, globalInfo, isResourceIntensive, isStopRequested, outputStructureForConnectionType, processIncoming, setName, setStepIsResourceIntensive, setStepManager, setStepMustRunSingleThreaded, start, stepMustRunSingleThreaded, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

SetPropertiesFromEnvironment

public SetPropertiesFromEnvironment()

Method Detail

stepInit

public void stepInit()
              throws WekaException

Initialize the step.

Throws:

WekaException - if a problem occurs

getIncomingConnectionTypes

public java.util.List<java.lang.String> getIncomingConnectionTypes()

Get a list of acceptable incoming connection types

Returns:

a list of acceptable incoming connection types

getOutgoingConnectionTypes

public java.util.List<java.lang.String> getOutgoingConnectionTypes()

Description copied from interface: Step

Get a list of outgoing connection types that this step can produce. Ideally (and if appropriate), this should take into account the state of the step and the incoming connections. E.g. depending on what incoming connection is present, a step might be able to produce a trainingSet output, a testSet output or neither, but not both.

Returns:

a list of outgoing connections that this step can produce

setProperties

protected void setProperties(WekaAlgorithmWrapper target,
                             java.util.Map<java.lang.String,java.lang.String> propertiesToSet)

Set properties on the specified target objet

Parameters:

target - the target to set properties on

propertiesToSet - the properties to try and set

stringToVal

protected java.lang.Object stringToVal(java.lang.String propVal,
                                       java.lang.Object target,
                                       java.lang.String propName)
                                throws WekaException

Attempts to convert a property value in string form to the object type that the actual property accepts

Parameters:

propVal - the string representation of the property value

target - the target object to receive the property value

propName - the name of the property

Returns:

the property value to set as an object

Throws:

WekaException - if a problem occurs

setValue

protected void setValue(java.lang.Object target,
                        java.lang.String targetName,
                        java.lang.String propName,
                        java.lang.Object valToSet)
                 throws WekaException

Sets the value of the property on the target object

Parameters:

target - the target object

targetName - the name of the step owning the target object

propName - the property name

valToSet - the value to set

Throws:

WekaException - if a problem occurs

getPropDescriptor

protected java.beans.PropertyDescriptor getPropDescriptor(java.lang.Object target,
                                                          java.lang.String propName)
                                                   throws java.beans.IntrospectionException

Gets the property descriptor for the supplied property name on the supplied target object

Parameters:

target - the target object

propName - the property name

Returns:

the property descriptor, or null if no such property exists

Throws:

java.beans.IntrospectionException - if a problem occurs

drillToProperty

protected java.lang.Object drillToProperty(java.lang.Object baseObject,
                                           java.util.List<java.lang.String> propertyPath)
                                    throws WekaException

Drill down to the last element in the supplied property path list on the given base object

Parameters:

baseObject - the base object to drill down

propertyPath - the property path to traverse

Returns:

the Object corresponding to the path

Throws:

WekaException - if a problem occurs