com.highqsoft.xsd

Interface XSDContextIF

All Superinterfaces:

java.util.Map<java.lang.Object,java.lang.Object>

All Known Implementing Classes:

DefaultXSDContext

public interface XSDContextIF
extends java.util.Map<java.lang.Object,java.lang.Object>

The interface describes the context of an XML file.

Since:

$Date: 2017/04/06 13:30:31 $

Version:

$Revision: 1.32 $

Author:

Andreas Hofmann

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Method Summary

Methods

Modifier and Type	Method and Description
XSDContextIF	clone() Clone the context.
javax.mail.Message	createMailMessage(java.lang.String subject, java.lang.String message) Create a mail message
void	destroy() Destroy the context.
AsamOdsFactoryIF	getAsamOdsFactory() Retrieve the ASAM ODS factory.
java.lang.ClassLoader	getClassLoader() Get the class loader that should be used for class loading.
java.lang.Object	getDescriptor() Get the xml tree descriptor.
ImplementationFactoryIF	getImplementationFactory() Retrieve the implementation factory.
java.util.logging.Logger	getLogger() Get the logger for the context oprations.
java.util.logging.Logger	getLogger(java.lang.String name) Get a logger from the context named like the given parameter and parented by the internal logger.
LoggerFactoryIF	getLoggerFactory() Retrieve the logger factory.
MailFactoryIF	getMailFactory() Retrieve the mail factory.
java.util.logging.Logger	getMessenger() Get the messenger for the context oprations.
java.util.logging.Logger	getMessenger(java.lang.String name) Get a messenger from the context named like the given parameter and parented by the internal messenger.
java.lang.String	getProperty(java.lang.String key) Get a property from context.
java.lang.String	getProperty(java.lang.String key, java.util.Properties alt) Get a property.
java.lang.String	getProperty(java.lang.String key, java.lang.String def) Get a property from context.
java.lang.String	getPropertyDefinition(java.lang.String key) Get a property as it is defined.
java.lang.String	getPropertyDefinition(java.lang.String key, java.util.Properties alt) Get a property as it is defined.
java.lang.String	getPropertyDefinition(java.lang.String key, java.lang.String def) Get a property as it is defined.
PropertyFactoryIF	getPropertyFactory() Retrieve the property factory.
long	getStartupTime() Get the time of the startup.
Status	getStatus() Get the runtime status.
java.lang.String	getStatusMessage() Get the status message
java.util.logging.Logger	getTracer() Get the tracer for the context oprations.
java.util.logging.Logger	getTracer(java.lang.String name) Get a tracer from the context named like the given parameter and parented by the internal tracer.
boolean	isInitialized() Get a boolean to decides that the context is initialized.
boolean	isNotStatus(java.lang.String status) Compare the runtime status and check against the reverse condition.
boolean	isNullTest() Indicates that the current run is null.
boolean	isPedantic() Return a boolean whether the gathermode is pedantic.
boolean	isStatus(Status status) Inquire the runtime status.
boolean	isStatus(java.lang.String status) Compare the runtime status.
java.lang.String[]	listReferenceKeys() Retrieve a keyset of the references.
void	nullTest(boolean flag) Switch the null test.
void	putAll(java.util.Properties properties) Put all the given properties to the internal list of properties.
void	putAll(java.util.ResourceBundle bundle) Put all the given bundle properties to the internal list of properties.
void	putAll(java.lang.String bundle) Put all the given bundle properties to the internal list of properties.
void	putAllAsDefaults(java.util.Properties properties) Put all the given properties to the internal list of default properties.
void	putAllAsDefaults(java.util.ResourceBundle bundle) Put all the given bundle properties to the internal list of default properties.
void	putAllAsDefaults(java.lang.String bundle) Put all the given bundle properties to the internal list of default properties.
java.lang.String	removeDecorator(java.lang.String value) Remove the property decorators from a string value.
java.lang.String	removeDecorator(java.lang.String value, java.util.Map<java.lang.String,java.lang.String> alt) Remove the property decorators from a string value.
java.lang.String	removeDecorator(java.lang.String value, java.util.Properties alt) Remove the property decorators from a string value.
void	removeReference(java.lang.String key) Remove a reference object.
void	resetStartupTime() Reset the runtime startup time.
java.lang.Object	restoreReference(java.lang.String key) Restore a reference object.
void	saveReference(java.lang.String key, AoSession session) Save a session reference object.
void	saveReference(java.lang.String key, java.lang.Object obj) Save a reference object.
void	sendMail(javax.mail.Message message) Send a mail message
void	setAsamOdsFactory(AsamOdsFactoryIF factory) Set the ASAM ODS factory.
void	setBaseDir(java.lang.String basedir) Set the build in varibale basedir.
void	setClassLoader(java.lang.ClassLoader cl) Set the class loader that should be used for class loading.
void	setDescriptor(java.lang.Object descriptor) Set the xml root tree descriptor.
void	setEnvironment(Environment env) Read the environment prefix from an xml tree node.
void	setEnvironmentPrefix(java.lang.String prefix) Set the environment prefix.
void	setGathermode(java.lang.String mode) The the gathermode.
void	setImplementationFactory(ImplementationFactoryIF factory) Set the implementation factory.
void	setInitialized(boolean flag) Indicate that the context is initialized.
void	setLogger(java.util.logging.Logger logger) Set the logger for the context oprations.
void	setLoggerFactory(LoggerFactoryIF factory) Set the logger factory.
void	setLogLevel(java.lang.String logLevel, java.lang.String traceLEvel, java.lang.String messageLevel) Set the level of the loggers.
void	setMailFactory(MailFactoryIF factory) Set the mail factory.
void	setMessage(javax.mail.Message message) Set a predefined message.
void	setMessenger(java.util.logging.Logger messenger) Set the messenger for the context oprations.
void	setOutputStream(java.io.OutputStream out, java.io.OutputStream err) Set the output streams for standard out and error.
void	setProperties(Properties props) Read the properties from an xml tree node.
void	setProperty(Property prop) Read the properties from an HQLX xml tree node.
java.lang.Object	setProperty(java.lang.String key, java.lang.String value) Set a property.
void	setPropertyFactory(PropertyFactoryIF factory) Set the property factory.
void	setStatus(Status status) Set the runtime status.
void	setStatus(Status status, java.lang.String message) Set the runtime status.
void	setTracer(java.util.logging.Logger tracer) Set the tracer for the context oprations.
void	tearDown() Tear down the context.

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Method Detail

clone

XSDContextIF clone()

Clone the context.

tearDown

void tearDown()

Tear down the context. All sessions should be close after this operation.

destroy

void destroy()

Destroy the context. All session should be closed and all settings should be reset.

getProperty

java.lang.String getProperty(java.lang.String key,
                           java.util.Properties alt)

Get a property.

Parameters:

key - the property key.

alt - an alternative properties object.

Returns:

the string value of the property or null if nor found.

getProperty

java.lang.String getProperty(java.lang.String key)

Get a property from context.

Parameters:

key - the property key

Returns:

the value of the property as it was defined by the xml file.

getProperty

java.lang.String getProperty(java.lang.String key,
                           java.lang.String def)

Get a property from context.

Parameters:

key - the property key

def - the default value, if the key was not declaired.

Returns:

the value of the property as it was defined by the xml file or the default value.

getPropertyDefinition

java.lang.String getPropertyDefinition(java.lang.String key,
                                     java.util.Properties alt)

Get a property as it is defined. All decorators are not removed.

Parameters:

key - the property key.

alt - an alternative properties object.

Returns:

the string value of the property or null if nor found.

getPropertyDefinition

java.lang.String getPropertyDefinition(java.lang.String key)

Get a property as it is defined. All decorators are not removed.

Parameters:

key - the property key

Returns:

the value of the property as it was defined by the xml file.

getPropertyDefinition

java.lang.String getPropertyDefinition(java.lang.String key,
                                     java.lang.String def)

Get a property as it is defined. All decorators are not removed.

Parameters:

key - the property key

def - the default value, if the key was not declaired.

Returns:

the value of the property as it was defined by the xml file or the default value.

putAll

void putAll(java.util.Properties properties)

Put all the given properties to the internal list of properties.

Parameters:

properties -

putAll

void putAll(java.util.ResourceBundle bundle)

Put all the given bundle properties to the internal list of properties.

Parameters:

bundle - the propery bundle

putAll

void putAll(java.lang.String bundle)

Put all the given bundle properties to the internal list of properties.

Parameters:

bundle - the propery bundle name

putAllAsDefaults

void putAllAsDefaults(java.util.Properties properties)

Put all the given properties to the internal list of default properties. This list is used to resolve property request and the requested key is not found and no other alternatives are given.

Parameters:

properties -

putAllAsDefaults

void putAllAsDefaults(java.util.ResourceBundle bundle)

Put all the given bundle properties to the internal list of default properties. This list is used to resolve property request and the requested key is not found and no other alternatives are given.

Parameters:

bundle - the propery bundle

putAllAsDefaults

void putAllAsDefaults(java.lang.String bundle)

Put all the given bundle properties to the internal list of default properties. This list is used to resolve property request and the requested key is not found and no other alternatives are given.

Parameters:

bundle - the propery bundle name

removeDecorator

java.lang.String removeDecorator(java.lang.String value)

Remove the property decorators from a string value.

Parameters:

value - The string value.

Returns:

the purged string value.

removeDecorator

java.lang.String removeDecorator(java.lang.String value,
                               java.util.Properties alt)

Remove the property decorators from a string value.

Parameters:

value - The string value.

alt - an alternative set of properties.

Returns:

the purged string value.

removeDecorator

java.lang.String removeDecorator(java.lang.String value,
                               java.util.Map<java.lang.String,java.lang.String> alt)

Remove the property decorators from a string value.

Parameters:

value - The string value.

alt - an alternative map of properties.

Returns:

the purged string value.

setEnvironmentPrefix

void setEnvironmentPrefix(java.lang.String prefix)

Set the environment prefix.

Parameters:

prefix - the prefix used for environment variables.

setProperties

void setProperties(Properties props)
                   throws java.io.FileNotFoundException,
                          ExecutableException,
                          java.io.IOException

Read the properties from an xml tree node.

Parameters:

props - the properties tree node of an XML structure.

Throws:

java.io.FileNotFoundException

ExecutableException

java.io.IOException

setProperty

void setProperty(Property prop)
                 throws java.io.FileNotFoundException,
                        ExecutableException,
                        java.io.IOException

Read the properties from an HQLX xml tree node.

Parameters:

prop - the property tree node of an XML structure.

Throws:

java.io.FileNotFoundException

ExecutableException

java.io.IOException

setProperty

java.lang.Object setProperty(java.lang.String key,
                           java.lang.String value)

Set a property.

Parameters:

key - the property key.

value - the property value.

setEnvironment

void setEnvironment(Environment env)

Read the environment prefix from an xml tree node.

Parameters:

env - the environment tree node of an XML structure.

setLogger

void setLogger(java.util.logging.Logger logger)

Set the logger for the context oprations.

Parameters:

logger - the logger

setTracer

void setTracer(java.util.logging.Logger tracer)

Set the tracer for the context oprations.

Parameters:

tracer - the tracer

setMessenger

void setMessenger(java.util.logging.Logger messenger)

Set the messenger for the context oprations.

Parameters:

messenger - the messenger

getLogger

java.util.logging.Logger getLogger()

Get the logger for the context oprations.

Returns:

the logger

getLogger

java.util.logging.Logger getLogger(java.lang.String name)

Get a logger from the context named like the given parameter and parented by the internal logger.

Parameters:

name - the name of the logger.

Returns:

the logger

getTracer

java.util.logging.Logger getTracer()

Get the tracer for the context oprations.

Returns:

the tracer

getTracer

java.util.logging.Logger getTracer(java.lang.String name)

Get a tracer from the context named like the given parameter and parented by the internal tracer.

Parameters:

name - the name of the tracer.

Returns:

the tracer

getMessenger

java.util.logging.Logger getMessenger()

Get the messenger for the context oprations.

Returns:

the messenger

getMessenger

java.util.logging.Logger getMessenger(java.lang.String name)

Get a messenger from the context named like the given parameter and parented by the internal messenger.

Parameters:

name - the name of the messenger.

Returns:

the messenger

setStatus

void setStatus(Status status)

Set the runtime status.

Parameters:

status - the new status.

setStatus

void setStatus(Status status,
             java.lang.String message)

Set the runtime status.

Parameters:

status - the new status.

message - the status message.

getStatus

Status getStatus()

Get the runtime status.

Returns:

the status.

getStatusMessage

java.lang.String getStatusMessage()

Get the status message

Returns:

the message.

isStatus

boolean isStatus(Status status)

Inquire the runtime status.

Parameters:

status - the status to against.

Returns:

true if the runtime status is equal to the given status.

isStatus

boolean isStatus(java.lang.String status)

Compare the runtime status.

Parameters:

status - the status string to check against.

Returns:

true if the case insensitive runtime status string value of the status is equals the given one. If the given string is null or empty the method return true

isNotStatus

boolean isNotStatus(java.lang.String status)

Compare the runtime status and check against the reverse condition.

Parameters:

status - the status string to check against.

Returns:

true if the case insensitive runtime status string value of the status is not equals the given one. If the given string is null or empty the method return true

isPedantic

boolean isPedantic()

Return a boolean whether the gathermode is pedantic.

Returns:

true if the gathermode is pedantic.

setGathermode

void setGathermode(java.lang.String mode)

The the gathermode.

Parameters:

mode - the mode string.

getStartupTime

long getStartupTime()

Get the time of the startup.

Returns:

the startup stamp.

resetStartupTime

void resetStartupTime()

Reset the runtime startup time.

setDescriptor

void setDescriptor(java.lang.Object descriptor)
                   throws InvalidDescriptorException

Set the xml root tree descriptor.

Parameters:

descriptor - the tree node.

Throws:

InvalidDescriptorException

getDescriptor

java.lang.Object getDescriptor()

Get the xml tree descriptor.

Returns:

the root tree node.

setLogLevel

void setLogLevel(java.lang.String logLevel,
               java.lang.String traceLEvel,
               java.lang.String messageLevel)
                 throws java.text.ParseException

Set the level of the loggers.

Parameters:

logLevel - The level string of the logger

traceLEvel - The level string of the tracer

messageLevel - The level string of the messenger

Throws:

java.text.ParseException

setOutputStream

void setOutputStream(java.io.OutputStream out,
                   java.io.OutputStream err)

Set the output streams for standard out and error.

Parameters:

out - the output stream for standard out.

err - the output stream for standard error.

saveReference

void saveReference(java.lang.String key,
                 java.lang.Object obj)

Save a reference object.

Parameters:

key - the reference keyword.

obj - the reference object.

saveReference

void saveReference(java.lang.String key,
                 AoSession session)

Save a session reference object.

Parameters:

key - the reference keyword.

session - the reference to session.

restoreReference

java.lang.Object restoreReference(java.lang.String key)

Restore a reference object.

Parameters:

key - the reference keyword.

Returns:

the reference object.

removeReference

void removeReference(java.lang.String key)

Remove a reference object.

Parameters:

key - the reference keyword.

listReferenceKeys

java.lang.String[] listReferenceKeys()

Retrieve a keyset of the references.

Returns:

the key of the references.

createMailMessage

javax.mail.Message createMailMessage(java.lang.String subject,
                                   java.lang.String message)
                                     throws javax.mail.MessagingException

Create a mail message

Throws:

javax.mail.MessagingException

setMessage

void setMessage(javax.mail.Message message)

Set a predefined message.

sendMail

void sendMail(javax.mail.Message message)
              throws javax.mail.SendFailedException,
                     javax.mail.MessagingException

Send a mail message

Parameters:

message - the message to be sent.

Throws:

javax.mail.SendFailedException

javax.mail.MessagingException

setImplementationFactory

void setImplementationFactory(ImplementationFactoryIF factory)

Set the implementation factory.

Parameters:

factory - the implementation factory.

getImplementationFactory

ImplementationFactoryIF getImplementationFactory()

Retrieve the implementation factory.

Returns:

the factory.

setAsamOdsFactory

void setAsamOdsFactory(AsamOdsFactoryIF factory)

Set the ASAM ODS factory.

Parameters:

factory - the ASAM ODS factory.

getAsamOdsFactory

AsamOdsFactoryIF getAsamOdsFactory()

Retrieve the ASAM ODS factory.

Returns:

the factory.

setLoggerFactory

void setLoggerFactory(LoggerFactoryIF factory)

Set the logger factory.

Parameters:

factory - the logger factory.

getLoggerFactory

LoggerFactoryIF getLoggerFactory()

Retrieve the logger factory.

Returns:

the factory.

setMailFactory

void setMailFactory(MailFactoryIF factory)

Set the mail factory.

Parameters:

factory - the mail factory.

getMailFactory

MailFactoryIF getMailFactory()

Retrieve the mail factory.

Returns:

the factory.

setPropertyFactory

void setPropertyFactory(PropertyFactoryIF factory)

Set the property factory.

Parameters:

factory - the property factory.

getPropertyFactory

PropertyFactoryIF getPropertyFactory()

Retrieve the property factory.

Returns:

the factory.

isInitialized

boolean isInitialized()

Get a boolean to decides that the context is initialized.

Returns:

true if the context is initialized.

See Also:

setInitialized(boolean)

setInitialized

void setInitialized(boolean flag)

Indicate that the context is initialized.
Call this method to avoid that subsystems reconfigure the context.
e.g.: MoMa uses a subcall to HQLX. The settings of the HQLX XML configuration should not overwrite the settings of the previous system.

Parameters:

flag - true to indicate that the context is initialized.

See Also:

isInitialized()

setBaseDir

void setBaseDir(java.lang.String basedir)
                throws java.io.IOException

Set the build in varibale basedir.

Parameters:

basedir - the new value.

Throws:

java.io.IOException - when the directory doesn't exist.

isNullTest

boolean isNullTest()

Indicates that the current run is null. Implementations must check this value by itself.

Returns:

true if current run is a null test.

nullTest

void nullTest(boolean flag)

Switch the null test.

Parameters:

flag - if true null test is turned on.

setClassLoader

void setClassLoader(java.lang.ClassLoader cl)

Set the class loader that should be used for class loading.

Parameters:

cl - the class loader that should be used for loading

getClassLoader

java.lang.ClassLoader getClassLoader()

Get the class loader that should be used for class loading.

Returns:

a classloader or null if not available.