com.highqsoft.moma.rules.utils

Class WriteLogfile

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.moma.rules.utils.WriteLogfile

All Implemented Interfaces:

ExecutableIF, ImplementationIF

public class WriteLogfile
extends AbstractImplementation
implements ExecutableIF

Creates a new or augments an existing logfile.

Writes information, depending on the previous processing status. Logged messagees are automatically prefixed with timestamp and status. According each status, an individual message can be defined, also a generic message for the missing messages.
The logfile may be replaced or appended. Additionally it may be deleted anyway and is recreated only if the appropriate message is written. So the existence of the file may indicate the occurance of the status.

Version:

$Revision: 1.16 $

Author:

Karl Hildebrand

See Also:

#init()} for argument description.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WriteLogfile.Option An enumenation for the implemented append, replace and clear options.

Field Summary

Fields inherited from class com.highqsoft.xsd.AbstractImplementation

arguments, ctx, descriptor, NEW_LINE

Constructor Summary

Constructors

Constructor and Description
WriteLogfile() Default constructor, used by MoMa in addition with #init().
WriteLogfile(java.lang.String f) Initializes with minimum reqirements (Exposed for use within other rules).
WriteLogfile(java.lang.String f, WriteLogfile.Option o) Initializes with an additional reqirement to handle the file (Exposed for use within other rules).

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() Writes either the success or the fail message.
void	init() Reads and verifies all arguments and sets values for: logfile, generalMessage, successMessage, stoppedMessage, rejectedMessage, failedMessage and isAppend.
void	terminate() Clears class variables.
boolean	write() Writes a default timestamp and status, no message.
boolean	write(java.lang.String message) Writes a default timestamp and status, plus message.

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, toString, wait, wait, wait

Methods inherited from interface com.highqsoft.xsd.ImplementationIF

getContext, getDescriptor, setArguments, setContext, setDescriptor

Constructor Detail

WriteLogfile

public WriteLogfile()

Default constructor, used by MoMa in addition with #init().

WriteLogfile

public WriteLogfile(java.lang.String f)

Initializes with minimum reqirements (Exposed for use within other rules).

No speciic message defined, so only an entry with timestamp and status will be appended later.

Parameters:

f - - fully qualified filename

WriteLogfile

public WriteLogfile(java.lang.String f,
            WriteLogfile.Option o)

Initializes with an additional reqirement to handle the file (Exposed for use within other rules).

No speciic message defined, so only an entry with timestamp and status will be appended later.

Parameters:

f - - String, fully qualified filename

o - - Option, handles an existing logfile

Method Detail

write

public boolean write()

Writes a default timestamp and status, no message.

Returns:

boolean, false if error occurred.

write

public boolean write(java.lang.String message)

Writes a default timestamp and status, plus message.

Parameters:

message - - String, message to be written.

Returns:

boolean, false if error occurred.

init

public void init()
          throws InitializationFailedException

Reads and verifies all arguments and sets values for: logfile, generalMessage, successMessage, stoppedMessage, rejectedMessage, failedMessage and isAppend.

Specified by:

init in interface ImplementationIF

Specified by:

init in class AbstractImplementation

Throws:

InitializationFailedException - When one of the requiError.ArgumentMissingred arguments does not exist.

See Also:

com.highqsoft.xsd.ImplentationIF#init()

execute

public void execute()
             throws ExecutableException

Writes either the success or the fail message.

Specified by:

execute in interface ExecutableIF

Throws:

ExecutableException - In case of execution error.

See Also:

ExecutableIF.execute()

terminate

public void terminate()
               throws TerminationException

Clears class variables.

Specified by:

terminate in interface ExecutableIF

Throws:

TerminationException - In case of termination error.