org.eclipse.smila.processing.pipelets
Class SubAttributeExtractorPipelet

java.lang.Object
  org.eclipse.smila.processing.pipelets.SubAttributeExtractorPipelet

All Implemented Interfaces:

IPipelet, SimplePipelet

public class SubAttributeExtractorPipelet
extends java.lang.Object
implements SimplePipelet

Extracts Literal values from an attribute that has a nested MObject. The attributes in the nested MObject can have nested MOBjects themselves. To address a attribute in the nested structure a path needs to be specified. The pipelet supports different execution modes:

FIRST: selects only the first Literal of the specified attribute

LAST: selects only the last Literal of the specified attribute

ALL_AS_LIST: selects all Literal values of the specified attribute and returns a list

ALL_AS_ONE: selects all Literal values of the specified attribute and concatenates them to a single string, using a seperator (default is blank)

Field Summary

static java.lang.String	DEFAULT_SEPARATOR The default separator.
static java.lang.String	PROPPERTY_INPUT_PATH Name of the property: "inputPath".
static java.lang.String	PROPPERTY_MODE Name of the property: "mode".
static java.lang.String	PROPPERTY_OUTPUT_PATH Name of the property: "outputPath".
static java.lang.String	PROPPERTY_SEPARATOR Name of the property: "separator".

Constructor Summary

SubAttributeExtractorPipelet()

Method Summary

void	configure(PipeletConfiguration configuration) set configuration of pipelet. called once after instantiation before the pipelet is actually used in a workflow.
Path	getInputPath() Returns the input path.
java.lang.String	getMode() Returns the name of the mode.
Path	getOutputPath() Returns the output path.
java.lang.String	getSeparator() Gets the separator.
Id[]	process(Blackboard blackboard, Id[] recordIds) process records on Blackboard service.

Methods inherited from class java.lang.Object

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

Field Detail

PROPPERTY_INPUT_PATH

public static final java.lang.String PROPPERTY_INPUT_PATH

Name of the property: "inputPath".

See Also:

Constant Field Values

PROPPERTY_OUTPUT_PATH

public static final java.lang.String PROPPERTY_OUTPUT_PATH

Name of the property: "outputPath".

See Also:

Constant Field Values

PROPPERTY_MODE

public static final java.lang.String PROPPERTY_MODE

Name of the property: "mode".

See Also:

Constant Field Values

PROPPERTY_SEPARATOR

public static final java.lang.String PROPPERTY_SEPARATOR

Name of the property: "separator".

See Also:

Constant Field Values

DEFAULT_SEPARATOR

public static final java.lang.String DEFAULT_SEPARATOR

The default separator.

See Also:

Constant Field Values

Constructor Detail

SubAttributeExtractorPipelet

public SubAttributeExtractorPipelet()

Method Detail

configure

public void configure(PipeletConfiguration configuration)
               throws ProcessingException

set configuration of pipelet. called once after instantiation before the pipelet is actually used in a workflow.

Specified by:

configure in interface IPipelet

Parameters:

configuration - configuration of pipelet.

Throws:

ProcessingException - configuration is not applicable for pipelet (missing properties, wrong datatypes)

See Also:

#configure(org.eclipse.smila.processing.configuration.PipeletConfiguration)

process

public Id[] process(Blackboard blackboard,
                    Id[] recordIds)
             throws ProcessingException

process records on Blackboard service.

Specified by:

process in interface SimplePipelet

Parameters:

blackboard - Blackboard service managing the records.

recordIds - Ids of records to process.

Returns:

Ids of result records.

Throws:

ProcessingException - error during processing.

See Also:

SimplePipelet.process(org.eclipse.smila.blackboard.Blackboard, org.eclipse.smila.datamodel.id.Id[])

getInputPath

public Path getInputPath()

Returns the input path.

Returns:

the input path

getOutputPath

public Path getOutputPath()

Returns the output path.

Returns:

the output path

getMode

public java.lang.String getMode()

Returns the name of the mode.

Returns:

the name of the mode

getSeparator

public java.lang.String getSeparator()

Gets the separator.

Returns:

the separator.