com.hof.mi.etl.step

Class AbstractGroupedDataInlineStep

java.lang.Object

com.hof.mi.etl.step.AbstractETLStep

com.hof.mi.etl.step.AbstractETLRowStep

com.hof.mi.etl.step.AbstractETLInlineRowStep

com.hof.mi.etl.step.AbstractGroupedDataInlineStep

All Implemented Interfaces:

ETLInlineStep, ETLStep, java.io.Serializable

public abstract class AbstractGroupedDataInlineStep
extends AbstractETLInlineRowStep

Base implementation which handles common functionality for all grouped data inline steps.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTO_GROUP_KEY
protected java.util.List<ETLStepMetadataFieldBean>	defaultFields
static java.lang.Integer	DUMMY_TEMPLATE_ID
protected com.hof.mi.data.Wire<java.lang.Object,java.lang.String>	fieldWire
protected java.util.List<com.hof.mi.etl.ETLFilterPredicate>	filterPredicates
static java.lang.String	FILTERS_KEY_PREFIX
protected com.hof.mi.data.Wire<java.lang.Object,java.lang.String>	operatingFieldWire
static java.lang.String	PANEL_KEY
static java.lang.String	PARAM_KEY
static java.lang.String	REPLACEFIELD_KEY
static java.lang.String	SECTION_KEY
protected boolean	stepHasSetupForRun

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

OPERATING_FIELD

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

commonDeps, dataPackets, dependencies

Constructor Summary

Constructors

Constructor and Description
AbstractGroupedDataInlineStep()
AbstractGroupedDataInlineStep(com.hof.mi.etl.ETLGroupedDataDependencies groupedDependencies)

Method Summary

Methods

Modifier and Type	Method and Description
protected ParameterPanelCollection	generatePanelCollection() Method to generate the ParameterPanelCollection object which represents the step's configuration UI elements.
ETLStepAPIVersion	getAPIVersion() Get the Version of the Yellowfin Step API.
java.lang.Integer	getColumnIndexForOperatingFieldInput(java.util.List<ETLStepMetadataFieldBean> inputFields) Return the column index in the inputFields list to the operating field's linked input field.
abstract ParameterImpl	getCustomParameter() Return the custom parameter which will setup the specific grouped data view with correct options.
java.lang.String	getDefaultDescription() Get the step's Default Description.
java.util.Map<java.lang.String,java.lang.String>	getDefaultInternalOptions() Return step optionKeys and optionValues for options internal to the step.
java.lang.String	getDefaultName() Get the step's Default Name.
java.util.Map<java.lang.String,?>	getParamData() This step's parameter needs it's data to be an GroupedDataModel for the view to use.
ETLStepClassification	getStepClassification() Returns a specific classification for an ETLStep
java.util.Map<java.lang.String,java.lang.String>	getValidatedStepOptions() Validate options returned by AbstractETLStep.getStepOptions() and return a map of optionKeys and optionValues.
java.util.List<com.hof.mi.data.ReportFilterBean>	loadFilters(com.hof.util.DBAction db) Load this step's grouped data filters, as specified in the step options map.
java.util.Map<java.lang.Integer,com.hof.mi.data.ReportFilterBean>	loadFiltersMap(com.hof.util.DBAction db) Returns this step's grouped data filters mappedby filter id.
void	parseData(java.util.Map<java.lang.String,java.lang.Object> data) Parse the data of panel collection from the front end to the correct format that should be saved into the database and return the updated step options
java.util.Map<java.lang.String,java.lang.Object>	parseGroupedDataModel(com.hof.mi.models.report.GroupedDataModel model) Return the step options and their keys which should be saved for this group model
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.
protected boolean	processWireData(java.util.List<ETLStepMetadataFieldBean> fields) Process data on Wires.
protected void	setupForRun(java.util.List<ETLStepMetadataFieldBean> inputFields) Setup all the required dependencies of this step before it processes row data.
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.

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

generateDefaultPanel, generateDefaultSection, getInputDataTypes, getOperatingField, getOperatingFieldUUID, getStepCategory, getSubMenuParameter, getWireForOperatingField, isParameterDisplayedAsSubMenu, validate

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

cleanup, endRows, postRow, preEndRows, preRow, processDependentRow, processRow, 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, getContext, 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, getStepIntegerValue, getStepOption, getStepOptions, getStepOptionValueJSONArray, getStepOptionValueJSONObject, getStepSubCategory, getStringUtil, getText, getText, getUnhandledETLException, getUuid, getWireForField, hasPendingDependency, includeDefaultField, isEnabled, isGeneratedField, isMainInputFlow, isReplacementField, onCopy, onDelete, 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, getContext, getDefaultMetadataFields, getErrorFlowUuid, getErrorStep, getETLStepBean, getInputFlowUuids, getInputStep, getMaxInputSteps, getMaxOutputSteps, getMetadataFields, getMinInputSteps, getMinOutputSteps, getOffImage, getOffImageMIMEType, getOnImage, getOnImageMIMEType, getOutputFlowUuids, getOutputStep, getPanelCollection, getRowLimit, getStatus, getStepOption, getStepOptions, getStepSubCategory, getUuid, isEnabled, onCopy, onDelete, removeDefaultMetadataField, row, setContext, setErrorStep, setETLStepBean, setMetadataFields, setRowLimit, setStatus, setStepOptions, setupDefaultFields, setupOptions

Field Detail

PARAM_KEY

public static final java.lang.String PARAM_KEY

See Also:

Constant Field Values

SECTION_KEY

public static final java.lang.String SECTION_KEY

See Also:

Constant Field Values

PANEL_KEY

public static final java.lang.String PANEL_KEY

See Also:

Constant Field Values

FILTERS_KEY_PREFIX

public static final java.lang.String FILTERS_KEY_PREFIX

See Also:

Constant Field Values

AUTO_GROUP_KEY

public static final java.lang.String AUTO_GROUP_KEY

See Also:

Constant Field Values

REPLACEFIELD_KEY

public static final java.lang.String REPLACEFIELD_KEY

See Also:

Constant Field Values

DUMMY_TEMPLATE_ID

public static final java.lang.Integer DUMMY_TEMPLATE_ID

stepHasSetupForRun

protected boolean stepHasSetupForRun

fieldWire

protected com.hof.mi.data.Wire<java.lang.Object,java.lang.String> fieldWire

operatingFieldWire

protected com.hof.mi.data.Wire<java.lang.Object,java.lang.String> operatingFieldWire

filterPredicates

protected java.util.List<com.hof.mi.etl.ETLFilterPredicate> filterPredicates

defaultFields

protected java.util.List<ETLStepMetadataFieldBean> defaultFields

Constructor Detail

AbstractGroupedDataInlineStep

public AbstractGroupedDataInlineStep()

AbstractGroupedDataInlineStep

public AbstractGroupedDataInlineStep(com.hof.mi.etl.ETLGroupedDataDependencies groupedDependencies)

Method Detail

getDefaultName

public java.lang.String getDefaultName()

Description copied from interface: ETLStep

Get the step's Default Name. Use ETLStep.getETLStepBean() and use its getStepName() method to get user-defined name

getDefaultDescription

public java.lang.String getDefaultDescription()

Description copied from interface: ETLStep

Get the step's Default Description. Use ETLStep.getETLStepBean() and use its getDescription() method to get user-defined name

getAPIVersion

public ETLStepAPIVersion getAPIVersion()

Description copied from interface: ETLStep

Get the Version of the Yellowfin Step API. This is used to determine if the Step is compatible with the current API. Step writers must return a value from enum ETLStepAPIVersion. This is usually the highest version, unless the writer is coding to a different API version for compatibility.

getDefaultInternalOptions

public java.util.Map<java.lang.String,java.lang.String> getDefaultInternalOptions()

Description copied from class: AbstractETLStep

Return step optionKeys and optionValues for options internal to the step. These options are not visible to the user. The step uses them internally for its processing. The default implementation returns null.

Overrides:

getDefaultInternalOptions in class AbstractETLStep

getValidatedStepOptions

public java.util.Map<java.lang.String,java.lang.String> getValidatedStepOptions()

Description copied from class: AbstractETLStep

Validate options returned by AbstractETLStep.getStepOptions() and return a map of optionKeys and optionValues. This map represents the current validated configuration of the step.

Specified by:

getValidatedStepOptions in class AbstractETLStep

setupGeneratedFields

public void setupGeneratedFields()
                          throws ETLException

Description copied from class: AbstractETLInlineRowStep

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.

Overrides:

setupGeneratedFields in class AbstractETLInlineRowStep

Throws:

ETLException

getStepClassification

public ETLStepClassification getStepClassification()

Description copied from interface: ETLStep

Returns a specific classification for an ETLStep

Specified by:

getStepClassification in interface ETLStep

Overrides:

getStepClassification in class AbstractETLStep

getColumnIndexForOperatingFieldInput

public java.lang.Integer getColumnIndexForOperatingFieldInput(java.util.List<ETLStepMetadataFieldBean> inputFields)

Return the column index in the inputFields list to the operating field's linked input field.

setupForRun

protected void setupForRun(java.util.List<ETLStepMetadataFieldBean> inputFields)

Setup all the required dependencies of this step before it processes row data. This is only done once at the start of row processing so that it doesn't have to be setup for every row.

processWireData

protected boolean processWireData(java.util.List<ETLStepMetadataFieldBean> fields)
                           throws ETLException,
                                  java.lang.InterruptedException

Description copied from class: AbstractETLRowStep

Process data on Wires. When the framework calls this method, data from each column of the current row is on its own Wire. Each Wire is mapped to a metadata field and may be accessed using AbstractETLStep.getWireForField(String). Data may be retrieved from the Wire, processed, and put back on the same Wire or a different one.

Errors must be wrapped in a ETLExceptions and thrown so that the framework can show them to the user. Do not catch and swallow exceptions.

Specified by:

processWireData in class AbstractETLRowStep

Parameters:

fields - - Metadata Fields for a row of data to be processed.

Returns:

boolean - if the row should be processed, return true, otherwise return false

Throws:

ETLException

java.lang.InterruptedException

loadFilters

public java.util.List<com.hof.mi.data.ReportFilterBean> loadFilters(com.hof.util.DBAction db)
                                                             throws java.lang.Exception

Load this step's grouped data filters, as specified in the step options map.

Throws:

java.lang.Exception

loadFiltersMap

public java.util.Map<java.lang.Integer,com.hof.mi.data.ReportFilterBean> loadFiltersMap(com.hof.util.DBAction db)
                                                                                 throws java.lang.Exception

Returns this step's grouped data filters mappedby filter id.

Throws:

java.lang.Exception

See Also:

loadFilters(DBAction)

getCustomParameter

public abstract ParameterImpl getCustomParameter()

Return the custom parameter which will setup the specific grouped data view with correct options. The parameter's 'property' field will be set to PARAM_KEY.

generatePanelCollection

protected ParameterPanelCollection generatePanelCollection()

Description copied from class: AbstractETLStep

Method to generate the ParameterPanelCollection object which represents the step's configuration UI elements.

Specified by:

generatePanelCollection in class AbstractETLStep

getParamData

public java.util.Map<java.lang.String,?> getParamData()

This step's parameter needs it's data to be an GroupedDataModel for the view to use. This method will return the entire section data map with the parameter's model in it.

parseData

public void parseData(java.util.Map<java.lang.String,java.lang.Object> data)

Description copied from interface: ETLStep

Parse the data of panel collection from the front end to the correct format that should be saved into the database and return the updated step options

Specified by:

parseData in interface ETLStep

Overrides:

parseData in class AbstractETLStep

parseInitData

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

Description copied from class: AbstractETLInlineRowStep

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.

Overrides:

parseInitData in class AbstractETLInlineRowStep

parseGroupedDataModel

public java.util.Map<java.lang.String,java.lang.Object> parseGroupedDataModel(com.hof.mi.models.report.GroupedDataModel model)

Return the step options and their keys which should be saved for this group model