weka.knowledgeflow.steps

Class SubstringLabeler

java.lang.Object

weka.knowledgeflow.steps.BaseStep

weka.knowledgeflow.steps.SubstringLabeler

All Implemented Interfaces:

java.io.Serializable, BaseStepExtender, Step

@KFStep(name="SubstringLabeler",
        category="Tools",
        toolTipText="Label instances according to substring matches in String attributes The user can specify the attributes to match against and associated label to create by defining \'match\' rules. A new attribute is appended to the data to contain the label. Rules are applied in order when processing instances, and the label associated with the first matching rule is applied. Non-matching instances can either receive a missing value for the label attribute or be \'consumed\' (i.e. they are not output).",
        iconPath="weka/gui/knowledgeflow/icons/DefaultFilter.gif")
public class SubstringLabeler
extends BaseStep

Step that appends a label to incoming instances according to substring matches in string attributes. Multiple match "rules" can be specified - these get applied in the order that they are defined. Each rule can be applied to one or more user-specified input String attributes. Attributes can be specified using either a range list (e.g 1,2-10,last) or by a comma separated list of attribute names (where "/first" and "/last" are special strings indicating the first and last attribute respectively).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Add	m_addFilter Add filter for adding the new attribute
protected java.lang.String	m_attName Name of the new attribute
protected boolean	m_consumeNonMatchingInstances For multi-valued labeled rules, whether or not to consume non-matching instances or output them with missing value for the match attribute.
protected boolean	m_isReset Step has been reset - i.e. start of processing?
protected java.lang.String	m_matchDetails Internally encoded list of match rules
protected SubstringLabelerRules	m_matches Encapsulates our match rules
protected boolean	m_nominalBinary Whether to make the binary match/non-match attribute a nominal (rather than numeric) binary attribute.
protected boolean	m_streaming Streaming instances?
protected Data	m_streamingData Reusable data object for output

Fields inherited from class weka.knowledgeflow.steps.BaseStep

m_stepIsResourceIntensive, m_stepManager, m_stepName

Constructor Summary

Constructors

Constructor and Description
SubstringLabeler()

Method Summary

Modifier and Type	Method and Description
boolean	getConsumeNonMatching() Get whether instances that do not match any of the rules should be "consumed" rather than output with a missing value set for the new attribute.
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.lang.String	getMatchAttributeName() Get the name of the new attribute that is created to indicate the match
java.lang.String	getMatchDetails() Get the internally encoded list of match rules
boolean	getNominalBinary() Get whether the new attribute created should be a nominal binary attribute rather than a numeric binary attribute.
java.util.List<java.lang.String>	getOutgoingConnectionTypes() Get a list of outgoing connection types that this step can produce.
Instances	outputStructureForConnectionType(java.lang.String connectionName) If possible, get the output structure for the named connection type as a header-only set of instances.
protected void	processBatch(Data data) Process a batch data object
void	processIncoming(Data data) Process an incoming data payload (if the step accepts incoming connections)
protected void	processStreaming(Data data) Processes a streaming data object
void	setConsumeNonMatching(boolean consume) Set whether instances that do not match any of the rules should be "consumed" rather than output with a missing value set for the new attribute.
void	setMatchAttributeName(java.lang.String name) Set the name of the new attribute that is created to indicate the match
void	setMatchDetails(java.lang.String details) Set internally encoded list of match rules
void	setNominalBinary(boolean nom) Set whether the new attribute created should be a nominal binary attribute rather than a numeric binary attribute.
void	stepInit() Initialize the step

Methods inherited from class weka.knowledgeflow.steps.BaseStep

environmentSubstitute, getDefaultSettings, getInteractiveViewers, getInteractiveViewersImpls, getName, getStepManager, globalInfo, isResourceIntensive, isStopRequested, 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

Field Detail

m_matchDetails

protected java.lang.String m_matchDetails

Internally encoded list of match rules

m_matches

protected transient SubstringLabelerRules m_matches

Encapsulates our match rules

m_nominalBinary

protected boolean m_nominalBinary

Whether to make the binary match/non-match attribute a nominal (rather than numeric) binary attribute.

m_consumeNonMatchingInstances

protected boolean m_consumeNonMatchingInstances

For multi-valued labeled rules, whether or not to consume non-matching instances or output them with missing value for the match attribute.

m_addFilter

protected Add m_addFilter

Add filter for adding the new attribute

m_attName

protected java.lang.String m_attName

Name of the new attribute

m_isReset

protected boolean m_isReset

Step has been reset - i.e. start of processing?

m_streamingData

protected Data m_streamingData

Reusable data object for output

m_streaming

protected boolean m_streaming

Streaming instances?

Constructor Detail

SubstringLabeler

public SubstringLabeler()

Method Detail

setMatchDetails

@ProgrammaticProperty
public void setMatchDetails(java.lang.String details)

Set internally encoded list of match rules

Parameters:

details - the list of match rules

getMatchDetails

public java.lang.String getMatchDetails()

Get the internally encoded list of match rules

Returns:

the match rules

setNominalBinary

@OptionMetadata(displayName="Make a nominal binary attribute",
                description="Whether to encode the new attribute as nominal when it is binary (as opposed to numeric)",
                displayOrder=1)
public void setNominalBinary(boolean nom)

Set whether the new attribute created should be a nominal binary attribute rather than a numeric binary attribute.

Parameters:

nom - true if the attribute should be a nominal binary one

getNominalBinary

public boolean getNominalBinary()

Get whether the new attribute created should be a nominal binary attribute rather than a numeric binary attribute.

Returns:

true if the attribute should be a nominal binary one

setConsumeNonMatching

@OptionMetadata(displayName="Consume non matching instances",
                description="Instances that do not match any rules will be consumed, rather than being output with a missing value for the new attribute",
                displayOrder=2)
public void setConsumeNonMatching(boolean consume)

Set whether instances that do not match any of the rules should be "consumed" rather than output with a missing value set for the new attribute.

Parameters:

consume - true if non matching instances should be consumed by the component.

getConsumeNonMatching

public boolean getConsumeNonMatching()

Get whether instances that do not match any of the rules should be "consumed" rather than output with a missing value set for the new attribute.

Returns:

true if non matching instances should be consumed by the component.

setMatchAttributeName

@OptionMetadata(displayName="Name of the new attribute",
                description="Name to give the new attribute",
                displayOrder=0)
public void setMatchAttributeName(java.lang.String name)

Set the name of the new attribute that is created to indicate the match

Parameters:

name - the name of the new attribute

getMatchAttributeName

public java.lang.String getMatchAttributeName()

Get the name of the new attribute that is created to indicate the match

Returns:

the name of the new attribute

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 incoming connection types that this step can accept. Ideally (and if appropriate), this should take into account the state of the step and any existing incoming connections. E.g. a step might be able to accept one (and only one) incoming batch data connection.

Returns:

a list of incoming connections that this step can accept given its current state

getOutgoingConnectionTypes

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

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

processIncoming

public void processIncoming(Data data)
                     throws WekaException

Process an incoming data payload (if the step accepts incoming connections)

Specified by:

processIncoming in interface BaseStepExtender

Specified by:

processIncoming in interface Step

Overrides:

processIncoming in class BaseStep

Parameters:

data - the data to process

Throws:

WekaException - if a problem occurs

processStreaming

protected void processStreaming(Data data)
                         throws WekaException

Processes a streaming data object

Parameters:

data - the data to process

Throws:

WekaException - if a problem occurs

processBatch

protected void processBatch(Data data)
                     throws WekaException

Process a batch data object

Parameters:

data - the data to process

Throws:

WekaException - if a problem occurs

outputStructureForConnectionType

public Instances outputStructureForConnectionType(java.lang.String connectionName)
                                           throws WekaException

If possible, get the output structure for the named connection type as a header-only set of instances. Can return null if the specified connection type is not representable as Instances or cannot be determined at present.

Specified by:

outputStructureForConnectionType in interface Step

Overrides:

outputStructureForConnectionType in class BaseStep

Parameters:

connectionName - the name of the connection type to get the output structure for

Returns:

the output structure as a header-only Instances object

Throws:

WekaException - if a problem occurs

getCustomEditorForStep

public java.lang.String getCustomEditorForStep()

Return the fully qualified name of a custom editor component (JComponent) to use for editing the properties of the step. This method can return null, in which case the system will dynamically generate an editor using the GenericObjectEditor

Specified by:

getCustomEditorForStep in interface Step

Overrides:

getCustomEditorForStep in class BaseStep

Returns:

the fully qualified name of a step editor component