Package org.frankframework.parameters

Class Parameter

java.lang.Object

org.frankframework.parameters.AbstractParameter<Message>

org.frankframework.parameters.Parameter

All Implemented Interfaces:

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

public class Parameter
extends AbstractParameter<Message>

Placeholder class to allow legacy configuration notations <param type='number' /> in the new Frank!Config XSD.

The attribute type has been removed in favor of explicit ParameterTypes such as: NumberParameter, DateParameter and BooleanParameter. Using the new elements enables the use of auto-completion for the specified type.

Author:

Niels Meijer

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
Parameter()
Parameter(String name, String value)	utility constructor, useful for unit testing

Method Summary

Modifier and Type	Method	Description
protected Message	getValueAsType(Message request, boolean namespaceAware)	Converts raw data to configured parameter type
void	setMinLength(int i)	If set (>=0) and the length of the value of the parameter falls short of this minimum length, the value is padded.
void	setType(ParameterType type)
void	setXpathResult(TransformerPool.OutputType outputType)	Only valid for xPathExpression.
String	toString()

Methods inherited from class org.frankframework.parameters.AbstractParameter

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

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

Parameter

public Parameter()

Parameter

public Parameter(String name,
 String value)

utility constructor, useful for unit testing

Method Details

toString

public String toString()

Overrides:

toString in class AbstractParameter<Message>

setType

@Default("STRING")
public void setType(ParameterType type)

Overrides:

setType in class AbstractParameter<Message>

getValueAsType

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

Description copied from class: AbstractParameter

Converts raw data to configured parameter type

Specified by:

getValueAsType in class AbstractParameter<Message>

Throws:

ParameterException

IOException

setXpathResult

public void setXpathResult(TransformerPool.OutputType outputType)

Only valid for xPathExpression. If xpathResult is TransformerPool.OutputType.XML then the resulting stylesheet will use the copy-of method instead of value-of. This results in an xml-string including the XML tags, if you want the contents of the element (as scalar value), use TEXT.

This field controls how to read the input and does not determine the output.

Overrides:

setXpathResult in class AbstractParameter<Message>

Default value

TEXT

setMinLength

public void setMinLength(int i)

If set (>=0) and the length of the value of the parameter falls short of this minimum length, the value is padded. This only works for character (input) data.

Default value

-1