com.hof.mi.etl.step

Class AbstractETLInlineRowStep

java.lang.Object

com.hof.mi.etl.step.AbstractETLStep

com.hof.mi.etl.step.AbstractETLRowStep

com.hof.mi.etl.step.AbstractETLInlineRowStep

All Implemented Interfaces:

ETLInlineStep, ETLStep, java.io.Serializable

Direct Known Subclasses:

AbstractGroupedDataInlineStep

public abstract class AbstractETLInlineRowStep
extends AbstractETLRowStep
implements ETLInlineStep

This is a partial implementation AbstractETLRowStep. Inline Step implementations must extend this and should process data row by row.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPERATING_FIELD

Fields inherited from class com.hof.mi.etl.step.AbstractETLStep

commonDeps, dataPackets, dependencies

Constructor Summary

Constructors

Constructor and Description
AbstractETLInlineRowStep()
AbstractETLInlineRowStep(com.hof.mi.etl.ETLDependencies dependencies, com.hof.util.dependency.CommonDependencies commonDeps)

Method Summary

Methods

Modifier and Type	Method and Description
protected ETLStepConfigPanel	generateDefaultPanel(java.lang.String panelKey, java.lang.String panelName, java.lang.String panelDesc, java.lang.String panelClassName, java.util.List<ParameterSection> sectionList) This is a helper function to generate a basic panel with the parameters that are passed in.
protected ETLStepConfigSection	generateDefaultSection(java.lang.String sectionKey, java.lang.String sectionName, java.lang.String sectionClassName, java.util.List<Parameter> parameterList) This is a helper function to generate a basic section with the parameters that are passed in.
java.util.List<java.lang.String>	getInputDataTypes()
protected ETLStepMetadataFieldBean	getOperatingField() Return the operating field of this inline step, as specified by the OPERATING_FIELD option
protected java.lang.String	getOperatingFieldUUID() Return the UUID of this inline step's operating field.
ETLStepCategory	getStepCategory() Return the step's category, which should be one defined in ETLStepCategory
Parameter	getSubMenuParameter()
protected com.hof.mi.data.Wire<java.lang.Object,java.lang.String>	getWireForOperatingField() Returns the Wire for this inline step's operating field.
java.lang.Boolean	isParameterDisplayedAsSubMenu()
java.util.Map<java.lang.String,java.lang.Object>	parseInitData(java.util.Map<java.lang.String,java.lang.String> initData) Similar to #parseData(Map), except this only gets called on the initOptions data when the step is first created.
void	setupGeneratedFields() This implementation makes sure that the operating field is of the type that is acceptable by the inline if it has restrictions on the data types it accepts.
java.util.Collection<ETLException>	validate() This function validates that the step has everything it requires to run successfully.

Methods inherited from class com.hof.mi.etl.step.AbstractETLRowStep

cleanup, endRows, postRow, preEndRows, preRow, processDependentRow, processRow, processWireData, row

Methods inherited from class com.hof.mi.etl.step.AbstractETLStep

addDefaultMetadataField, addError, addGeneratedField, addInputStep, addNewGeneratedField, addOutputStep, addStepOption, beginInternalTransmission, checkErrorThreshold, clearAllWires, disable, emitData, emitData, endInternalTransmission, endInternalTransmission, excludeDefaultField, flowFinished, generatePanelCollection, getContext, getDefaultInternalOptions, getDefaultMetadataFields, getDefaultMetadataFieldsMap, getDefaultMetadataFieldUuids, getDefaultMetadataFieldUuidsList, getDefaultMetadataMap, getDefaultToInputFieldMap, getErrorFlowUuid, getErrorStep, getEtlDataTypeUtil, getETLException, getETLStepBean, getFile, getFile, getFileName, getFileName, getFirstInputFlow, getFirstOutputFlow, getFreshDataPacket, getInputFlowForDefaultMetadataGroup, getInputFlowUuids, getInputStep, getInputSteps, getInputToDefaultFieldMap, getInvalidConfigETLException, getMaxInputSteps, getMaxOutputSteps, getMetadataFields, getMinInputSteps, getMinOutputSteps, getOffImage, getOffImageMIMEType, getOffImagePath, getOnImage, getOnImageMIMEType, getOnImagePath, getOutputFlowUuids, getOutputFlowUuidsExceededRowLimit, getOutputStep, getOutputSteps, getPanelCollection, getRowLimit, getStatus, getStepBooleanValue, getStepClassification, getStepIntegerValue, getStepOption, getStepOptions, getStepOptionValueJSONArray, getStepOptionValueJSONObject, getStepSubCategory, getStringUtil, getText, getText, getUnhandledETLException, getUuid, getValidatedStepOptions, getWireForField, hasPendingDependency, includeDefaultField, isEnabled, isGeneratedField, isMainInputFlow, isReplacementField, onCopy, onDelete, parseData, removeDefaultMetadataField, replaceDefaultField, restoreReplacedField, setContext, setErrorStep, setETLStepBean, setMetadataFields, setRowLimit, setStatus, setStepOptions, setupDefaultFields, setupOptions, shouldOutputField, stepCanRun, throwInvalidConfigETLException, throwUnhandledETLException, updateFieldSortOrder, waitForDependencies

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hof.mi.etl.step.ETLStep

addDefaultMetadataField, addInputStep, addOutputStep, addStepOption, disable, endRows, getAPIVersion, getContext, getDefaultDescription, getDefaultMetadataFields, getDefaultName, getErrorFlowUuid, getErrorStep, getETLStepBean, getInputFlowUuids, getInputStep, getMaxInputSteps, getMaxOutputSteps, getMetadataFields, getMinInputSteps, getMinOutputSteps, getOffImage, getOffImageMIMEType, getOnImage, getOnImageMIMEType, getOutputFlowUuids, getOutputStep, getPanelCollection, getRowLimit, getStatus, getStepClassification, getStepOption, getStepOptions, getStepSubCategory, getUuid, isEnabled, onCopy, onDelete, parseData, removeDefaultMetadataField, row, setContext, setErrorStep, setETLStepBean, setMetadataFields, setRowLimit, setStatus, setStepOptions, setupDefaultFields, setupOptions

Field Detail

OPERATING_FIELD

public static final java.lang.String OPERATING_FIELD

See Also:

Constant Field Values

Constructor Detail

AbstractETLInlineRowStep

public AbstractETLInlineRowStep()

AbstractETLInlineRowStep

public AbstractETLInlineRowStep(com.hof.mi.etl.ETLDependencies dependencies,
                        com.hof.util.dependency.CommonDependencies commonDeps)

Method Detail

setupGeneratedFields

public void setupGeneratedFields()
                          throws ETLException

This implementation makes sure that the operating field is of the type that is acceptable by the inline if it has restrictions on the data types it accepts. If this is being overridden, call this implementation for acceptable data type validation.

Specified by:

setupGeneratedFields in class AbstractETLStep

Throws:

ETLException

validate

public java.util.Collection<ETLException> validate()

This function validates that the step has everything it requires to run successfully. This implementation does the default check that's common for all inlines. If this function is being overridden, make sure that this implementation is called as well so that default validations are done.

Specified by:

validate in interface ETLStep

getStepCategory

public ETLStepCategory getStepCategory()

Description copied from interface: ETLStep

Return the step's category, which should be one defined in ETLStepCategory

Specified by:

getStepCategory in interface ETLStep

isParameterDisplayedAsSubMenu

public java.lang.Boolean isParameterDisplayedAsSubMenu()

Specified by:

isParameterDisplayedAsSubMenu in interface ETLInlineStep

getSubMenuParameter

public Parameter getSubMenuParameter()

Specified by:

getSubMenuParameter in interface ETLInlineStep

getInputDataTypes

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

Specified by:

getInputDataTypes in interface ETLInlineStep

parseInitData

public java.util.Map<java.lang.String,java.lang.Object> parseInitData(java.util.Map<java.lang.String,java.lang.String> initData)

Similar to #parseData(Map), except this only gets called on the initOptions data when the step is first created. The difference lies in which data will be present, since some steps have different init UI and edit UI.

generateDefaultPanel

protected ETLStepConfigPanel generateDefaultPanel(java.lang.String panelKey,
                                      java.lang.String panelName,
                                      java.lang.String panelDesc,
                                      java.lang.String panelClassName,
                                      java.util.List<ParameterSection> sectionList)

This is a helper function to generate a basic panel with the parameters that are passed in.

Parameters:

panelKey - The key to use to identify the panel

panelName - The name given to the panel

panelDesc - A description

panelClassName - A css class that has to be applied

sectionList - the list of sections contained in this panel

Returns:

ETLStepConfigPanel with the passed in properties

generateDefaultSection

protected ETLStepConfigSection generateDefaultSection(java.lang.String sectionKey,
                                          java.lang.String sectionName,
                                          java.lang.String sectionClassName,
                                          java.util.List<Parameter> parameterList)

This is a helper function to generate a basic section with the parameters that are passed in.

Parameters:

sectionKey - The key to identify the section

sectionName - The name given to the section

sectionClassName - The css class to be applied to the section

parameterList - The list of parameters that the section must hold

Returns:

ETLStepConfigSection with the passed in properties

getOperatingFieldUUID

protected java.lang.String getOperatingFieldUUID()

Return the UUID of this inline step's operating field.

getOperatingField

protected ETLStepMetadataFieldBean getOperatingField()

Return the operating field of this inline step, as specified by the OPERATING_FIELD option

getWireForOperatingField

protected com.hof.mi.data.Wire<java.lang.Object,java.lang.String> getWireForOperatingField()

Returns the Wire for this inline step's operating field. This may return null if the step's wires have not been set up.