Package org.frankframework.parameters

Class NumberParameter

java.lang.Object

org.frankframework.parameters.AbstractParameter

org.frankframework.parameters.NumberParameter

All Implemented Interfaces:

FrankElement, HasApplicationContext, HasName, IConfigurable, IScopeProvider, IWithParameters, NameAware, IParameter, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class NumberParameter
extends AbstractParameter

Nested Class Summary

Nested classes/interfaces inherited from class org.frankframework.parameters.AbstractParameter

AbstractParameter.DefaultValueMethods, AbstractParameter.ParameterMode, AbstractParameter.ParameterPatternSubstitution

Field Summary

Fields inherited from class org.frankframework.parameters.AbstractParameter

CONTEXT_KEY_WILDCARD, FIXEDHOSTNAME, FIXEDUID, paramList

Constructor Summary

Constructors

Constructor	Description
NumberParameter()

Method Summary

Modifier and Type	Method	Description
void	configure()	Configure this component.
Object	getValue(ParameterValueList alreadyResolvedParameters, Message message, PipeLineSession session, boolean namespaceAware)	determines the raw value
protected Number	getValueAsType(Message request, boolean namespaceAware)	Converts raw data to configured parameter type
void	setDecimalSeparator(String string)	Separate the integer part from the fractional part of a number.
void	setGroupingSeparator(String string)	In the United States, the comma is typically used for the grouping separator; however, several publication standards follow international standards in using either a space or a thin space character.
void	setMaxInclusive(String string)	Used in combination with type number; if set and the value of the parameter exceeds this maximum value, this maximum value is taken
void	setMinInclusive(String string)	Used in combination with type number; if set and the value of the parameter falls short of this minimum value, this minimum value is taken

Methods inherited from class org.frankframework.parameters.AbstractParameter

addParameter, consumesSessionVariable, getMessageFormat, getName, getParameterList, requiresInputValueForResolution, setAuthAlias, setContextKey, setDefaultValue, setDefaultValueMethods, setHidden, setIgnoreUnresolvablePatternElements, setJsonPathExpression, setMaxLength, setMinLength, setMode, setName, setNamespaceDefs, setPassword, setPattern, setRemoveNamespaces, setSessionKey, setSessionKeyJPath, setSessionKeyXPath, setStyleSheetName, setType, setUsername, setValue, setXpathExpression, setXsltVersion, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface org.frankframework.core.FrankElement

addConfigWarning

Methods inherited from interface org.frankframework.core.HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface org.frankframework.parameters.IParameter

getMode, getSessionKey, getType, getValue, isHidden

Constructor Details

NumberParameter

public NumberParameter()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from interface: IConfigurable

Configure this component.

configure() is called once at startup of the framework in the configure method of the owner of this IConfigurable. Purpose of this method is to check whether the static configuration of the object is correct. As much as possible class-instantiating should take place in the configure(), to improve performance.

In the case of a container, this will propagate the configure signal to all components that apply.

Specified by:

configure in interface IConfigurable

Overrides:

configure in class AbstractParameter

Throws:

ConfigurationException - in case it was not able to configure the component.

getValue

public Object getValue(ParameterValueList alreadyResolvedParameters,
 Message message,
 PipeLineSession session,
 boolean namespaceAware)
                throws ParameterException

Description copied from class: AbstractParameter

determines the raw value

Specified by:

getValue in interface IParameter

Overrides:

getValue in class AbstractParameter

Throws:

ParameterException

getValueAsType

protected Number getValueAsType(@Nonnull
 Message request,
 boolean namespaceAware)
                         throws ParameterException,
IOException

Description copied from class: AbstractParameter

Converts raw data to configured parameter type

Overrides:

getValueAsType in class AbstractParameter

Throws:

ParameterException

IOException

setDecimalSeparator

public void setDecimalSeparator(String string)

Separate the integer part from the fractional part of a number.

Default value

system default

setGroupingSeparator

public void setGroupingSeparator(String string)

In the United States, the comma is typically used for the grouping separator; however, several publication standards follow international standards in using either a space or a thin space character.

Default value

system default

setMaxInclusive

public void setMaxInclusive(String string)

Used in combination with type number; if set and the value of the parameter exceeds this maximum value, this maximum value is taken

setMinInclusive

public void setMinInclusive(String string)

Used in combination with type number; if set and the value of the parameter falls short of this minimum value, this minimum value is taken