Hemi JavaScript Framework

Hemi.util.logger

• Hemi JavaScript Framework
• API Index

Description

The Logger class may be used to instrument an object with logging functionality. Application logging is handled by the Hemi.message.service.sendMessage function, which supports multiple levels of message levels and message scoping.

static Hemi.util.logger

version 3.1.0

Utility for instrumenting a logging API into an object. Logging facilities use the Message Service message block format of: ###.#.###.### where the first set identifies the global scope, the second is the level, the third is the inner scope, and the fourth is the fine scope.

See Example Log for an example of implementating the script on a page.

Index

Example Index

• Example Log: Demonstrate how to use the Logger with an existing object.

Method Index

• public addLogger: Instruments the specified logger with a context sensitive logging facility.
• virtual log: Sends a message in the ###.3 message block.
• virtual logAdvisory: Sends a message in the ###.2 message block.
• virtual logDebug: Sends a message in the ###.1 message block.
• virtual logError: Sends a message in the #100.5 message block.
• virtual logFatal: Sends a message in the ###.7 message block.
• virtual logWarning: Sends a message in the ###.4 message block.

Examples

Example Log

• Top
• logger
• Examples

Demonstrate how to use the Logger with an existing object.

Example Code

// Some JavaScript Object
var oMyObject = ...;
// The '900' block is an arbitrary value of 1 - 999
Hemi.util.logger.addLogger(oMyObject, "MyLog","Actions for my object", 900);
// Define a function to receive all log messages
oMyObject.HandleMessages = function(sType, oMessage){
   var iLevel = oMessage.level; // iLevel == 900
   var sMessage = oMessage.message;
}
// Listen for log messages on the same object
Hemi.message.service.subscribe("onsendmessage", oMyObject.HandleMessages);
// Test it out, optionally supply a numeric code pair (###.###) to identify message origination.
// The entire code for the message would be: 900.4.100.1
oMyObject.logWarning("Something happened!","100.1");

Methods

addLogger

• Top
• logger
• Methods

Instruments the specified logger with a context sensitive logging facility.

Syntax

void addLogger( oObject, sLogName, sLogDescription, iContextId )

Parameters

• oObject as FrameworkObject : Object onto which the logger will be instrumented.
• sLogName as String : Short name of the log.
• sLogDescription as String : Short description of the log.
• iContextId as int : The logging context. The context must be between 1 and 999. If the context already exists, then the first context to define the name and description will be used.

log

• Top
• logger
• Methods

Sends a message in the ###.3 message block. Method is virtual and can be overridden.

Syntax

void log( sMessage )

Parameters

• sMessage as String : Message to send to the logger.

logAdvisory

• Top
• logger
• Methods

Sends a message in the ###.2 message block. Method is virtual and can be overridden.

Syntax

void logAdvisory( sMessage )

Parameters

• sMessage as String : Message to send to the logger.

logDebug

• Top
• logger
• Methods

Sends a message in the ###.1 message block. Method is virtual and can be overridden.

Syntax

void logDebug( sMessage )

Parameters

• sMessage as String : Message to send to the logger.

logError

• Top
• logger
• Methods

Sends a message in the #100.5 message block. Method is virtual and can be overridden.

Syntax

void logError( sMessage )

Parameters

• sMessage as String : Message to send to the logger.

logFatal

• Top
• logger
• Methods

Sends a message in the ###.7 message block. Method is virtual and can be overridden.

Syntax

void logFatal( sMessage )

Parameters

• sMessage as String : Message to send to the logger.

logWarning

• Top
• logger
• Methods

Sends a message in the ###.4 message block. Method is virtual and can be overridden.

Syntax

void logWarning( sMessage )

Parameters

• sMessage as String : Message to send to the logger.

[ Hemi JavaScript Framework - Stephen W. Cote, 2002 - 2009. ]