Class DMFieldInputBuilder
-
Nested Class Summary
Nested classes/interfaces inherited from class AbstractInputBuilder
AbstractInputBuilder.InputWidth
-
Field Summary
Fields inherited from class AbstractInputBuilder
builderContext, cp
-
Constructor Summary
ConstructorDescriptionDMFieldInputBuilder
(InputBuilderContext builderContext, InputType type, String paramName, String source) -
Method Summary
Modifier and TypeMethodDescriptionprotected Object
addFieldType
(FieldType type) setClearMissingInDM
(boolean value) Sets the property that clears an unavailable value from theDMField
user input (a drop-down menu).setDmSourceName
(String dmSourceName) Configure DataSource (DS) or Datamart (DM) name.Sets the kind of fields to be displayed in the drop-down list.setFieldKinds
(DMFieldInputBuilder.FieldKind... kinds) setFieldTypes
(Collection<FieldType> types) Sets the types of fields to be displayed in the drop-down list.setFieldTypes
(FieldType... types) 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, setShowInline, setSize, setSuccessMessage, setTheme, setTitle, setTrackedValue, setUserGroupEdit, setUserGroupEdit, setUserGroupView, setValue, setValueChangeTracking, setValueHint, setWarningMessage, setWidth
-
Constructor Details
-
DMFieldInputBuilder
public DMFieldInputBuilder(InputBuilderContext builderContext, InputType type, String paramName, String source)
-
-
Method Details
-
setDmSourceName
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, theInputBuilderExceptions.NullOrEmptyArgumentException
will be thrown).- Returns:
- the current instance of DMFieldInputBuilder.
-
addFieldKind
- Parameters:
kind
- AllowedDMFieldInputBuilder.FieldKind
- Returns:
- self
- See Also:
-
setFieldKinds
- Parameters:
kinds
- AllowedDMFieldInputBuilder.FieldKind
s- Returns:
- self
- See Also:
-
setFieldKinds
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
- AllowedDMFieldInputBuilder.FieldKind
s- Returns:
- self
- See Also:
-
addFieldType
- Parameters:
type
- AllowedFieldType
- Returns:
- self
- See Also:
-
setFieldTypes
- Parameters:
types
- AllowedFieldType
s- Returns:
- self
- See Also:
-
setFieldTypes
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
- AllowedFieldType
s- Returns:
- self
- See Also:
-
setClearMissingInDM
Sets the property that clears an unavailable value from theDMField
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 totrue
to clear the currently selectedInputType.DMFIELD
value when theInputType.DMSOURCE
value changes. Default ==false
.- Returns:
- self
- See Also:
-
_getInput
- Specified by:
_getInput
in classAbstractInputBuilder<DMFieldInputBuilder,
String>
-