Package org.frankframework.parameters

Class DateParameter

java.lang.Object

org.frankframework.parameters.AbstractParameter

org.frankframework.parameters.DateParameter

All Implemented Interfaces:

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

public class DateParameter
extends AbstractParameter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DateParameter.DateFormatType

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

AbstractParameter.DefaultValueMethods, AbstractParameter.ParameterMode, AbstractParameter.ParameterPatternSubstitution

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE_DATE_PATTERN
static final String	TYPE_DATETIME_PATTERN
static final String	TYPE_TIME_PATTERN
static final String	TYPE_TIMESTAMP_PATTERN

Fields inherited from class org.frankframework.parameters.AbstractParameter

CONTEXT_KEY_WILDCARD, FIXEDHOSTNAME, FIXEDUID, paramList

Constructor Summary

Constructors

Constructor	Description
DateParameter()

Method Summary

Modifier and Type	Method	Description
void	configure()	Configure this component.
protected String	getMessageFormat(AbstractParameter.ParameterPatternSubstitution substitution)
protected Date	getValueAsType(Message request, boolean namespaceAware)	Converts raw data to configured parameter type
void	setFormatString(String string)	Used in combination with types DATE, TIME, DATETIME and TIMESTAMP to parse the raw parameter string data into an object of the respective type
void	setFormatType(DateParameter.DateFormatType formatType)
void	setType(ParameterType type)	Deprecated.

Methods inherited from class org.frankframework.parameters.AbstractParameter

addParameter, consumesSessionVariable, getName, getParameterList, getValue, requiresInputValueForResolution, setAuthAlias, setContextKey, setDefaultValue, setDefaultValueMethods, setHidden, setIgnoreUnresolvablePatternElements, setJsonPathExpression, setMaxLength, setMinLength, setMode, setName, setNamespaceDefs, setPassword, setPattern, setRemoveNamespaces, setSessionKey, setSessionKeyJPath, setSessionKeyXPath, setStyleSheetName, 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

Field Details

TYPE_DATE_PATTERN

public static final String TYPE_DATE_PATTERN

See Also:

• Constant Field Values

TYPE_TIME_PATTERN

public static final String TYPE_TIME_PATTERN

See Also:

• Constant Field Values

TYPE_DATETIME_PATTERN

public static final String TYPE_DATETIME_PATTERN

See Also:

• Constant Field Values

TYPE_TIMESTAMP_PATTERN

public static final String TYPE_TIMESTAMP_PATTERN

See Also:

• Constant Field Values

Constructor Details

DateParameter

public DateParameter()

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.

getMessageFormat

protected String getMessageFormat(AbstractParameter.ParameterPatternSubstitution substitution)

Overrides:

getMessageFormat in class AbstractParameter

getValueAsType

protected Date 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

setType

@Deprecated
@ConfigurationWarning("use element DateParameter with attribute formatType instead")
public void setType(ParameterType type)

Deprecated.

Overrides:

setType in class AbstractParameter

setFormatString

public void setFormatString(String string)

Used in combination with types DATE, TIME, DATETIME and TIMESTAMP to parse the raw parameter string data into an object of the respective type

Default value

depends on type

setFormatType

public void setFormatType(DateParameter.DateFormatType formatType)