Package net.pricefx.formulaengine.scripting.inputbuilder

Class DmFilterBuilder

Object

AbstractInputBuilder

AbstractDmFilterBuilder

DmFilterBuilder

public class DmFilterBuilder
extends AbstractDmFilterBuilder

Builder class for input type DMFilterBuilder InputType.DMFILTERBUILDER.

Nested Class Summary

Nested classes/interfaces inherited from class AbstractInputBuilder

AbstractInputBuilder.InputWidth

Field Summary

Fields inherited from class AbstractInputBuilder

builderContext, cp

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DmFilterBuilder(InputBuilderContext builderContext, String paramName, String sourceName)

Method Summary

Modifier and Type	Method	Description
DmFilterBuilder	setDmSourceName(String dmSourceName)	Configure DataSource (DS) or Datamart (DM) name.
DmFilterBuilder	setFilters(Object... arguments)	Set DmFilterBuilder filters Example:

Methods inherited from class AbstractDmFilterBuilder

_getInput, setFilter, setShowInline, showInline

Methods inherited from class AbstractInputBuilder

addOrUpdateInput, addToConfiguratorEntry, addToConfiguratorEntry, buildContextParameter, buildMap, getInput, self, setAccessCode, setAlign, setAllValueTypesTracking, setAlwaysEditable, setAppearance, setAutoComplete, setAutoFocus, setCaption, setConfigValues, setCustomAttributeName, setCustomAttributeValue, setDefaultValueTracking, setDefaultWidth, setDisabled, setDisplayMode, setErrorMessage, setExportable, setFirstRunTracking, setFlex, setHelpLink, setHelpText, setIcon, setIconPosition, setImportable, setLabel, setLabelPlacement, setLabelStyle, setLabelTranslations, setLayoutGridName, setNoRefresh, setParameterGroup, setPlaceholderText, setPreviousValueTracking, setReadOnly, setRequired, setSize, setSuccessMessage, setTheme, setTitle, setTrackedValue, setUserGroupEdit, setUserGroupEdit, setUserGroupView, setValue, setValueChangeTracking, setValueHint, setWarningMessage, setWidth

Methods inherited from class Object

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

Constructor Details

DmFilterBuilder

protected DmFilterBuilder(InputBuilderContext builderContext,
 String paramName,
 String sourceName)

Method Details

setDmSourceName

public DmFilterBuilder setDmSourceName(String dmSourceName)

Configure DataSource (DS) or Datamart (DM) name.

Example:

 filterBuilder = api.inputBuilderFactory()
                .createDmFilterBuilder('filterBuilder', 'sourceName')
                .setDmSourceName('newSourceName')
                .buildMap()
 

Overrides:

setDmSourceName in class AbstractDmFilterBuilder

Parameters:

dmSourceName - name of DS or DM (if null or empty, the InputBuilderExceptions.NullOrEmptyArgumentException will be thrown).

Returns:

the current instance of DmFilterBuilder.

Since:

14.0 - Caribou Lou

setFilters

public DmFilterBuilder setFilters(Object... arguments)

Set DmFilterBuilder filters Example:

     String sourceName = 'dataSourceNameOrLabelOrUniqueName'
     List dimFilters = ['keyId', 'dimensionColumn']

     if(api.isInputGenerationExecution()) {
        return api.inputBuilderFactory()
          .createDmFilterBuilder('filterBuilder', sourceName)
          .setFilters(dimFilters)
          .getInput()
     }

     return input.filterBuilder
 

NOTE: arguments are accepted as the array for backward compatibility

Parameters:

arguments - filters as List, Map or Filter

Returns:

DmFilterBuilder with updated filters

Since:

14.0 - Caribou Lou