org.eclipse.hyades.logging.adapter.impl
Class Context

java.lang.Object
  org.eclipse.hyades.logging.adapter.impl.Component
      org.eclipse.hyades.logging.adapter.impl.Context

All Implemented Interfaces:

IComponent, IContext, java.lang.Runnable

Direct Known Subclasses:

BasicContext

public abstract class Context

extends Component

implements IContext

Context is a component. A Context instance corresponds to one thread of processing - sensor, event extractor, parser, outputters etc.

Field Summary

protected IContextListener

listener Listener for this context

Fields inherited from class org.eclipse.hyades.logging.adapter.impl.Component

logger, status, stopping

Constructor Summary

Context()

Method Summary

java.lang.String	getCharset() Retrieve the name of the character set that this context is working with
IContextListener	getContextListener() Get the IContextListener that is invoked as the context manages its sub-components.
Status	getContextStatus() Get the status of the context
boolean	getContinuousOperation() Get whether the context is running in continuous monitoring mode.
int	getDay() Get the day of the month the log file was generated.
java.util.Locale	getLocale() Retrieve the locale that this context is operating within
long	getMaximumIdleTime() Get the maximum idle time used for determining when to stop the context that is running in continuous mode.
int	getMonth() Get the month the log file was generated in.
protected long	getPauseCount() Get the pause counter.
long	getPauseInterval() Get the pause interval time used for determining when to stop the context that is running in continuous mode.
java.lang.String	getTimezone() Get the timezone the log file was generated in.
com.ibm.icu.util.ULocale	getULocale()
int	getYear() Get the year the log file was generated in.
void	handleControledStop() Determine if the context should be stopped based whether it is running in continuous monitoring mode and the maximum idle time has been reached.
protected void	incrementPauseCount() Increment the pause counter.
boolean	isEnableICU()
protected boolean	isHardStop() Is the context stopping without notifying its listeners.
boolean	isValidating() Is the context in validating mode?
void	resetControledStop() Reset the counters used to determine if the context should be stopped when running in continuous monitoring mode.
protected void	resetPauseCount() Reset the pause counter back to zero.
void	setCharset(java.lang.String charset) Set the character set to be used by this context
void	setContextListener(IContextListener listener) Set the IContextListener that will be invoked as the context manages its sub-components.
void	setContinuousOperation(boolean newContinuousOperation) Set whether the context should run in continuous monitoring mode or not.
void	setDay(int day) Set the day of the month the log file was generated.
void	setEnableICU(boolean enableICU) Set the enableICU flag
void	setHardStop() Set the hardStop flag so the context will stop without notifying its listeners.
void	setLocale(java.util.Locale locale) Set the locale to be used by this context
void	setMaximumIdleTime(long newMaximumIdleTime) Set the maximum idle time used for determining when to stop the context that is running in continuous mode.
void	setMonth(int month) Set the month the log file was generated in.
protected void	setPauseCount(long newPauseCount) Set the pause counter.
void	setPauseInterval(long newPauseInterval) Set the pause interval time used for determining when to stop the context that is running in continuous mode.
void	setTimezone(java.lang.String timezone) Set the timezone the log file was generated in.
void	setValidating(boolean validating) Set the context validating state.
void	setYear(int year) Set the year the log file was generated in.
void	stop() Stop the context.
void	update() Method update.

Methods inherited from class org.eclipse.hyades.logging.adapter.impl.Component

clean, getComponents, getComponentStatus, getConfiguration, getContextConfiguration, getDescription, getEventFactory, getExecutableClassName, getImplementationCreationDate, getImplementationVersion, getImplementationVersionDescription, getItemsProcessedCount, getLogger, getLoggingLevel, getName, getParent, getRole, getRoleCreationDate, getRoleVersion, getRoleVersionDescription, getUniqueID, incrementItemsProcessedCount, incrementItemsProcessedCount, init, isDisabled, isStopping, log, log, setComponents, setConfiguration, setContextConfiguration, setDescription, setDisabled, setExecutableClassName, setImplemenationCreationDate, setImplementationVersion, setImplementationVersionDescription, setLogger, setLoggingLevel, setName, setParent, setRole, setRoleCreationDate, setRoleVersion, setRoleVersionDescription, setStopping, setUniqueID, start, stop, trace, trace, trace, update, updateConfigurationAttribute, updateContextConfigurationAttribute

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.hyades.logging.adapter.IComponent

getComponents, getConfiguration, getContextConfiguration, getDescription, getExecutableClassName, getImplementationCreationDate, getImplementationVersion, getImplementationVersionDescription, getLogger, getLoggingLevel, getName, getParent, getRole, getRoleCreationDate, getRoleVersion, getRoleVersionDescription, getUniqueID, init, log, log, setComponents, setConfiguration, setContextConfiguration, setDescription, setExecutableClassName, setImplemenationCreationDate, setImplementationVersion, setImplementationVersionDescription, setLogger, setLoggingLevel, setName, setParent, setRole, setRoleCreationDate, setRoleVersion, setRoleVersionDescription, setUniqueID, start, update

Methods inherited from interface java.lang.Runnable

run

Field Detail

listener

protected IContextListener listener

Listener for this context

Constructor Detail

Context

public Context()

Method Detail

stop

public void stop()

Stop the context.

Specified by:

stop in interface IComponent

Overrides:

stop in class Component

See Also:

IComponent.stop()

resetControledStop

public void resetControledStop()

Reset the counters used to determine if the context should be stopped when running in continuous monitoring mode.

resetPauseCount

protected void resetPauseCount()

Reset the pause counter back to zero.

incrementPauseCount

protected void incrementPauseCount()

Increment the pause counter.

getPauseCount

protected long getPauseCount()

Get the pause counter.

Returns:

the pause counter as a long.

setPauseCount

protected void setPauseCount(long newPauseCount)

Set the pause counter.

Parameters:

newPauseCount - - the new value of the pause counter.

setContinuousOperation

public void setContinuousOperation(boolean newContinuousOperation)

Set whether the context should run in continuous monitoring mode or not.

Parameters:

newContinuousOperation - - boolean for whether context is to run in continuous mode.

getContinuousOperation

public boolean getContinuousOperation()

Get whether the context is running in continuous monitoring mode.

Returns:

true if context is running in continuous mode, false otherwise.

setMaximumIdleTime

public void setMaximumIdleTime(long newMaximumIdleTime)

Set the maximum idle time used for determining when to stop the context that is running in continuous mode. This is the maximum time the context will wait for new data to be returned by the sensor.

Parameters:

newMaximumIdleTime - - the new maximum idle time in microseconds

getMaximumIdleTime

public long getMaximumIdleTime()

Get the maximum idle time used for determining when to stop the context that is running in continuous mode. This is the maximum time the context will wait for new data to be returned by the sensor.

Returns:

maximum idle time as a long

setPauseInterval

public void setPauseInterval(long newPauseInterval)

Set the pause interval time used for determining when to stop the context that is running in continuous mode. This is the wait time before checking if the sensor has read some new data.

Parameters:

newPauseInterval - - the new pause interval in microseconds

getPauseInterval

public long getPauseInterval()

Get the pause interval time used for determining when to stop the context that is running in continuous mode. This is the wait time before checking if the sensor has read some new data.

Returns:

pause interval in microseconds as a long

update

public void update()
            throws AdapterInvalidConfig

Description copied from interface: IComponent

Method update. By reading the current component configuration, sets the properties of the component. Subclasses should invoke parent update() to ensure proper behaviour.

Specified by:

update in interface IComponent

Overrides:

update in class Component

Throws:

AdapterInvalidConfig

See Also:

IComponent.update()

handleControledStop

public void handleControledStop()

Determine if the context should be stopped based whether it is running in continuous monitoring mode and the maximum idle time has been reached.

setContextListener

public void setContextListener(IContextListener listener)

Description copied from interface: IContext

Set the IContextListener that will be invoked as the context manages its sub-components.

Specified by:

setContextListener in interface IContext

Parameters:

listener -

See Also:

IContext.setContextListener(IContextListener)

getContextListener

public IContextListener getContextListener()

Description copied from interface: IContext

Get the IContextListener that is invoked as the context manages its sub-components.

Specified by:

getContextListener in interface IContext

Returns:

IContextListener - the context listener instance

See Also:

IContext.getContextListener()

isHardStop

protected boolean isHardStop()

Is the context stopping without notifying its listeners.

Returns:

true if context is stopping without notifying its listeners., otherwise false

setHardStop

public void setHardStop()

Set the hardStop flag so the context will stop without notifying its listeners.

getLocale

public java.util.Locale getLocale()

Description copied from interface: IContext

Retrieve the locale that this context is operating within

Specified by:

getLocale in interface IContext

Returns:

Locale - locale of context

See Also:

IContext.getLocale()

setLocale

public void setLocale(java.util.Locale locale)

Description copied from interface: IContext

Set the locale to be used by this context

Specified by:

setLocale in interface IContext

Parameters:

locale - to be used by the context

See Also:

IContext.setLocale(java.util.Locale)

getCharset

public java.lang.String getCharset()

Description copied from interface: IContext

Retrieve the name of the character set that this context is working with

Specified by:

getCharset in interface IContext

Returns:

String - character set

See Also:

IContext.getCharset()

setCharset

public void setCharset(java.lang.String charset)

Description copied from interface: IContext

Set the character set to be used by this context

Specified by:

setCharset in interface IContext

Parameters:

charset - the name of the character set to use for this context

See Also:

org.eclipse.hyades.logging.adapter.IContext#setCharset(java.nio.charset.Charset)

getContextStatus

public Status getContextStatus()

Get the status of the context

Returns:

Status object representing the status of the context.

getDay

public int getDay()

Get the day of the month the log file was generated. It can be used when parsing timestamps in the log file.

Returns:

Returns the day of the month as an integer.

getMonth

public int getMonth()

Get the month the log file was generated in. It can be used when parsing timestamps in the log file.

Returns:

Returns the month as an integer.

getTimezone

public java.lang.String getTimezone()

Get the timezone the log file was generated in. It can be used when parsing timestamps in the log file.

Returns:

Returns the timezone in RFC 822 format. For example -0500.

getYear

public int getYear()

Get the year the log file was generated in. It can be used when parsing timestamps in the log file.

Returns:

Returns the year.

setDay

public void setDay(int day)

Set the day of the month the log file was generated. It can be used when parsing timestamps in the log file.

Parameters:

day - The day to set as an integer.

setMonth

public void setMonth(int month)

Set the month the log file was generated in. It can be used when parsing timestamps in the log file.

Parameters:

month - The month to set as an integer.

setTimezone

public void setTimezone(java.lang.String timezone)

Set the timezone the log file was generated in. It can be used when parsing timestamps in the log file.

Parameters:

timezone - The timezone to set. It must be in RFC 822 format. For example, -0500

setYear

public void setYear(int year)

Set the year the log file was generated in. It can be used when parsing timestamps in the log file.

Parameters:

year - The year to set.

isValidating

public boolean isValidating()

Is the context in validating mode?

Returns:

boolean flag whether context is in validation mode

setValidating

public void setValidating(boolean validating)

Set the context validating state.

Parameters:

validating - boolean to indicate whether context is in validating mode

getULocale

public com.ibm.icu.util.ULocale getULocale()

isEnableICU

public boolean isEnableICU()

setEnableICU

public void setEnableICU(boolean enableICU)

Set the enableICU flag

Parameters:

enableICU - the boolean value to set