com.highqsoft.moma.rules.utils

Class FormatDatePropertyRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.moma.rules.utils.FormatDatePropertyRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class FormatDatePropertyRule
extends AbstractRule

\page UtilsRules \section rules_com_highqsoft_moma_rules_utils_FormatDatePropertyRule FormatDatePropertyRule \addindex date format This rule changes the format of one or more properties containing a date. If the date property cannot be parsed with \e informat, the rule will either leave the property as it is or throw an error. This depends on the setting of \e AbortOnError. Type: SequencerRule \par Properties \li \b PropertyNameList (required, no default, DT_STRING)
The list of property names to convert. \li \b SplitChar (optional, default " ")
The character used to split \e PropertyList \li \b inFormat (required, no default, DT_STRING)
The format of the attribute value of the input, the format specification is according java \c java.text.SimpleDateFormat \li \b outFormat (required, no default, DT_STRING)
The format of the attribute value of the output, the format specification is according java \c java.text.SimpleDateFormat \li \b Locale (optional, default is system locale, DT_STRING)
The date formats locale. Important if the format string contains day names. \li \b AbortOnError (optional, default "true")
If true, the rule will throw an exception if a timestamp in a property cannot be parsed. Otherwise it leaves the property as it is and writes a warning to the messenger log. \li \b AbortIfEmpty (optional, default "false")
If true, the rule will throw an exception if a property is empty or does not exist. Otherwise it leaves the property as it is and writes an information to the messenger log. \li Configuration \code \endcode

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	inFormat
protected java.lang.String	outFormat

Fields inherited from class com.highqsoft.xsd.AbstractRule

loggerName, postMethods, preMethods, sessionRef

Fields inherited from class com.highqsoft.xsd.AbstractImplementation

arguments, ctx, descriptor, NEW_LINE

Constructor Summary

Constructors

Constructor and Description
FormatDatePropertyRule()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() Execute the program.
NameValueUnit[][]	getValue() Get the named value from rule.
void	init() Get the required arguments.
void	setValue(NameValueUnit[][] nvu) Format the values from a date attribute from the inFormat in the outFormat.

Methods inherited from class com.highqsoft.xsd.AbstractRule

execute, executePostMethods, executePreMethods, getAoSessionFromContextWithSessionRef, getId, getOdsCache, getPointTo, getSessionRef, getType, isPedantic, setGathermode, setId, setPointTo, setPostMethods, setPreMethods, setSessionRef, setType, terminate, toString, toString, toString

Methods inherited from class com.highqsoft.xsd.AbstractImplementation

addAttributesToNameValueUnitArray, addAttributeToNameValueUnitArray, addStringValueToNameValueUnitArray, checkDirectoy, checkDirectoy, checkDirectoy, checkFile, checkFile, checkFile, checkIntValue, checkStringValue, compressNvuArray, createMessageFromPropertyFile, createMessageFromPropertyFile, createMessageFromPropertyFile, createTsUnionFromObject, deleteRowWithAttributes, getArguments, getContext, getDescriptor, getListFromProperty, getMandatoryProperty, getMandatoryProperty, getMandatoryPropertyAsInt, getMandatoryPropertyAsList, getMandatoryPropertyWithRuleException, getNvuArrayFromMap, getNvuArrayFromMap, getNvuObjectWithName, getNvuObjectWithName, getNvuObjectWithName, getOdsCacheFromProperty, getOptioanlPropertyAsInt, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsList, makeUpperCaseKeyword, removeAttributeFromNameValueUnitArray, removeAttributeFromNameValueUnitArray, setArguments, setContext, setDescriptor

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.highqsoft.xsd.ImplementationIF

getContext, getDescriptor, setArguments, setContext, setDescriptor

Field Detail

inFormat

protected java.lang.String inFormat

outFormat

protected java.lang.String outFormat

Constructor Detail

FormatDatePropertyRule

public FormatDatePropertyRule()

Method Detail

execute

public void execute()
             throws ExecutableException

Description copied from class: AbstractRule

Execute the program. This implementation does nothing by default. Can be overridden.

Specified by:

execute in interface ExecutableIF

Overrides:

execute in class AbstractRule

Throws:

ExecutableException - if execution fails.

setValue

public void setValue(NameValueUnit[][] nvu)
              throws RuleException

Format the values from a date attribute from the inFormat in the outFormat.

Parameters:

nvu - The NameValueUnit[][] containing the instances

Throws:

RuleException

See Also:

RuleIF.setValue(org.asam.ods.NameValueUnit[][])

init

public void init()
          throws InitializationFailedException

Get the required arguments.

Specified by:

init in interface ImplementationIF

Specified by:

init in class AbstractImplementation

Throws:

InitializationFailedException - if the initialization fails.

See Also:

AbstractImplementation.init()

getValue

public NameValueUnit[][] getValue()
                           throws RuleException

Description copied from interface: RuleIF

Get the named value from rule.

Returns:

The name value of the rule.

Throws:

RuleException

See Also:

RuleIF.setValue(NameValueUnit[][] nvu)