@KFStep(name="StorePropertiesInEnvironment", category="Flow", toolTipText="Store property settings for a particular algorithm-based step (eg Classifier, Clusterer etc) in the flow environment. When connected to a downstream Job step, the sub-flow executed by the Job can use a SetPropertiesFromEnvironment step to access the stored properties and set them on the underlying scheme in an algorithm-based step. Each property is configured by specifying the attribute in the incoming instance to obtain its value from, the target scheme-based step (in the sub-flow) that will receive it, the property name/path to set on the target step and a default property value (optional) to use if the value is missing in the incoming instance. If the property/path field is left blank, then it is assumed that the value is actually a scheme + options spec in command-line form; otherwise, the value is set by processing the property path - e.g. if our target step to receive property settings was Bagging (itself with default settings), and the property path to set was \'classifier.maxDepth\', then the classifier property of Bagging would yield a REPTree base classifier and the maxDepth property of REPTree would be set. Note that the SetPropertiesFromEnvironment step will process property settings in the order that they are defined by this step. This means that it is possible to set the entire base learner for a Classifier stepwith one property setting and then drill down to a particular option in the base learner using a second property setting.", iconPath="weka/gui/knowledgeflow/icons/StorePropertiesInEnvironment.gif") public class StorePropertiesInEnvironment extends BaseStep
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
SEP1
Separators for internal variable specification
|
static java.lang.String |
SEP2 |
Constructor and Description |
---|
StorePropertiesInEnvironment() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getCustomEditorForStep()
Return the fully qualified name of a custom editor component (JComponent)
to use for editing the properties of the step.
|
java.util.List<java.lang.String> |
getIncomingConnectionTypes()
Get a list of incoming connection types that this step can accept.
|
java.util.List<java.lang.String> |
getOutgoingConnectionTypes()
Get a list of outgoing connection types that this step can produce.
|
java.lang.String |
getPropsInternalRep() |
static java.util.Map<java.lang.String,java.util.List<java.lang.String>> |
internalDynamicToMap(java.lang.String internalRep) |
void |
processIncoming(Data data)
Process an incoming data payload (if the step accepts incoming connections)
|
void |
setPropsInternalRep(java.lang.String rep) |
void |
stepInit()
Initialize the step.
|
environmentSubstitute, getDefaultSettings, getInteractiveViewers, getInteractiveViewersImpls, getName, getStepManager, globalInfo, isResourceIntensive, isStopRequested, outputStructureForConnectionType, outputStructureForConnectionType, setName, setStepIsResourceIntensive, setStepManager, setStepMustRunSingleThreaded, start, stepMustRunSingleThreaded, stop
public static final java.lang.String SEP1
public static final java.lang.String SEP2
@ProgrammaticProperty public void setPropsInternalRep(java.lang.String rep)
public java.lang.String getPropsInternalRep()
public void stepInit() throws WekaException
Step
WekaException
- if a problem occurs during initializationpublic void processIncoming(Data data) throws WekaException
BaseStep
processIncoming
in interface BaseStepExtender
processIncoming
in interface Step
processIncoming
in class BaseStep
data
- the payload to processWekaException
- if a problem occurspublic java.util.List<java.lang.String> getIncomingConnectionTypes()
Step
public java.util.List<java.lang.String> getOutgoingConnectionTypes()
Step
public java.lang.String getCustomEditorForStep()
getCustomEditorForStep
in interface Step
getCustomEditorForStep
in class BaseStep
public static java.util.Map<java.lang.String,java.util.List<java.lang.String>> internalDynamicToMap(java.lang.String internalRep)