Package net.pricefx.formulaengine.scripting.inputbuilder

Class DMFieldInputBuilder

Object

AbstractInputBuilder<DMFieldInputBuilder,String>

DMFieldInputBuilder

public class DMFieldInputBuilder
extends AbstractInputBuilder<DMFieldInputBuilder,String>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DMFieldInputBuilder.FieldKind

Nested classes/interfaces inherited from class AbstractInputBuilder

AbstractInputBuilder.InputWidth

Field Summary

Fields inherited from class AbstractInputBuilder

builderContext, cp

Constructor Summary

Constructors

Constructor	Description
DMFieldInputBuilder(InputBuilderContext builderContext, InputType type, String paramName, String source)

Method Summary

Modifier and Type	Method	Description
protected Object	_getInput()
DMFieldInputBuilder	addFieldKind(DMFieldInputBuilder.FieldKind kind)
DMFieldInputBuilder	addFieldType(FieldType type)
DMFieldInputBuilder	setClearMissingInDM(boolean value)	Sets the property that clears an unavailable value from the DMField user input (a drop-down menu).
DMFieldInputBuilder	setDmSourceName(String dmSourceName)	Configure DataSource (DS) or Datamart (DM) name.
DMFieldInputBuilder	setFieldKinds(Collection<DMFieldInputBuilder.FieldKind> kinds)	Sets the kind of fields to be displayed in the drop-down list.
DMFieldInputBuilder	setFieldKinds(DMFieldInputBuilder.FieldKind... kinds)
DMFieldInputBuilder	setFieldTypes(Collection<FieldType> types)	Sets the types of fields to be displayed in the drop-down list.
DMFieldInputBuilder	setFieldTypes(FieldType... types)

Methods inherited from class AbstractInputBuilder

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

Methods inherited from class Object

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

Constructor Details

DMFieldInputBuilder

public DMFieldInputBuilder(InputBuilderContext builderContext,
 InputType type,
 String paramName,
 String source)

Method Details

setDmSourceName

public DMFieldInputBuilder setDmSourceName(String dmSourceName)

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

Example:

 filterBuilder = api.inputBuilderFactory()
                .createDMField("MyInput","DM.datamart_transaction")
                .setDmSourceName('datamart_enriched_trx')
                .buildMap()
 

Parameters:

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

Returns:

the current instance of DMFieldInputBuilder.

addFieldKind

public DMFieldInputBuilder addFieldKind(DMFieldInputBuilder.FieldKind kind)

Parameters:

kind - Allowed DMFieldInputBuilder.FieldKind

Returns:

self

See Also:

• setFieldKinds(Collection)

setFieldKinds

public DMFieldInputBuilder setFieldKinds(DMFieldInputBuilder.FieldKind... kinds)

Parameters:

kinds - Allowed DMFieldInputBuilder.FieldKinds

Returns:

self

See Also:

• setFieldKinds(Collection)

setFieldKinds

public DMFieldInputBuilder setFieldKinds(Collection<DMFieldInputBuilder.FieldKind> kinds)

Sets the kind of fields to be displayed in the drop-down list.

Example:

 def builder = api.inputBuilderFactory().createDMFields("MyInput","DM.datamart_transaction")
                   .setFieldKinds(FieldKind.DIMENSION, FieldKind.KEY)  // to select fields that are dimension or key
 return libs.InputLib.Input.inputParamBuilder(out, builder)
 

Parameters:

kinds - Allowed DMFieldInputBuilder.FieldKinds

Returns:

self

See Also:

• DMFieldInputBuilder.FieldKind

addFieldType

public DMFieldInputBuilder addFieldType(FieldType type)

Parameters:

type - Allowed FieldType

Returns:

self

See Also:

• setFieldTypes(Collection)

setFieldTypes

public DMFieldInputBuilder setFieldTypes(FieldType... types)

Parameters:

types - Allowed FieldTypes

Returns:

self

See Also:

• setFieldTypes(Collection)

setFieldTypes

public DMFieldInputBuilder setFieldTypes(Collection<FieldType> types)

Sets the types of fields to be displayed in the drop-down list.

Example:

 def builder = api.inputBuilderFactory().createDMFields("MyInput","DM.datamart_transaction")
                   .setFieldTypes(FieldType.NUMBER, FieldType.MONEY) // to select either number or money fields
 return libs.InputLib.Input.inputParamBuilder(out, builder)
 

Parameters:

types - Allowed FieldTypes

Returns:

self

See Also:

• FieldType

setClearMissingInDM

public DMFieldInputBuilder setClearMissingInDM(boolean value)

Sets the property that clears an unavailable value from the DMField user input (a drop-down menu). A value becomes unavailable, when the corresponding DMSource is changed and the newly selected DMSource does not contain the original DMField value.

Parameters:

value - Set to true to clear the currently selected InputType.DMFIELD value when the InputType.DMSOURCE value changes. Default == false.

Returns:

self

See Also:

• InputBuilderFactory.createDMField(String, String)

_getInput

protected Object _getInput()

Specified by:

_getInput in class AbstractInputBuilder<DMFieldInputBuilder,String>