gugga.tracking.TrackManager Class Reference

Inheritance diagram for gugga.tracking.TrackManager:

Inheritance graph
[legend]
Collaboration diagram for gugga.tracking.TrackManager:

Collaboration graph
[legend]
List of all members.

Detailed Description

Definition at line 16 of file TrackManager.as.

Public Member Functions

function enableLogging ()
function disableLogging ()
function getDefaultPublisher ()
function loadCofig (configFile:String)
function applyConfigFromXml (aXml:XML)

Static Public Member Functions

static function getInstance ()

Package Functions

function onCofigLoaded (xmlObject:XML, isLoaded:Boolean)

Private Member Functions

function TrackManager ()
function handleTrackerProperties (name:String, actions:String, filter:String)
function handlePublisherProperties (name:String, publisher:String, formatter:String, actions:String)

Static Private Member Functions

static function createFilterByName (className:String)
static function createFormatterByName (className:String)
static function createPublisherByName (className:String)
static function getClassByName (className:String)

Private Attributes

var defaultPublisher:IPublisher

Static Private Attributes

static var instance:TrackManager = new TrackManager()
static var logger:Logger = Logger.getLogger("tracking.PropertyLoader")
static var ROOT_NODE:String = "tracking"
static var TRACKER_NODE:String = "tracker"
static var PUBLISHER_NODE:String = "publisher"


Constructor & Destructor Documentation

function gugga.tracking.TrackManager.TrackManager (  )  [private]

Private constructor.

Definition at line 24 of file TrackManager.as.


Member Function Documentation

static function gugga.tracking.TrackManager.getInstance (  )  [static]

Get the singleton instance.

Returns:
The LogManager instance

Definition at line 39 of file TrackManager.as.

static function gugga.tracking.TrackManager.createFilterByName ( className:String   )  [static, private]

Returns the Filter object associated with the class with the given string name

Parameters:
className the filter's class name
Returns:
the Filter object

Definition at line 53 of file TrackManager.as.

static function gugga.tracking.TrackManager.createFormatterByName ( className:String   )  [static, private]

Returns the Formatter object associated with the class with the given string name

Parameters:
className the formatters's class name
Returns:
the Formatter object

Definition at line 68 of file TrackManager.as.

static function gugga.tracking.TrackManager.createPublisherByName ( className:String   )  [static, private]

Returns the Publisher object associated with the class with the given string name

Parameters:
className the publishers's class name
Returns:
the Publisher object

Definition at line 83 of file TrackManager.as.

function gugga.tracking.TrackManager.enableLogging (  ) 

Enables logging (logging is enabled by default) for all loggers.

Definition at line 96 of file TrackManager.as.

function gugga.tracking.TrackManager.disableLogging (  ) 

Disables logging (logging is enabled by default) for all loggers.

Definition at line 107 of file TrackManager.as.

function gugga.tracking.TrackManager.getDefaultPublisher (  ) 

Gets the default publisher, which usually will be the trace output.

Returns:
the default publisher instance

Definition at line 120 of file TrackManager.as.

function gugga.tracking.TrackManager.loadCofig ( configFile:String   ) 

Convenience method to start reading the external logging properties. The method is supposed to be invoked by an application's main class on startup as part of the hook mechanism. Make sure you have registered a listener before in order to proceed.

Parameters:
configFile A file location which contains logging properties

Definition at line 140 of file TrackManager.as.

function gugga.tracking.TrackManager.applyConfigFromXml ( aXml:XML   ) 

Definition at line 156 of file TrackManager.as.

References if().

Here is the call graph for this function:

function gugga.tracking.TrackManager.onCofigLoaded ( xmlObject:XML  ,
isLoaded:Boolean   
) [package]

Definition at line 200 of file TrackManager.as.

function gugga.tracking.TrackManager.handleTrackerProperties ( name:String  ,
actions:String  ,
filter:String   
) [private]

Handles appliable properties for loggers.

Important: If a filter is specified, make sure to import and reference the given class so it can be accessed by the Tracker framework

Parameters:
name the Tracker's name string, e.g. "a.b.c"
level the logging level, e.g. "WARNING"
filter the filter class name, e.g. "com.domain.CustomFilter"

Definition at line 221 of file TrackManager.as.

function gugga.tracking.TrackManager.handlePublisherProperties ( name:String  ,
publisher:String  ,
formatter:String  ,
actions:String   
) [private]

Handles appliable properties for publishers.

Important: If a publisher or formatter is specified, make sure to import and reference the given class so it can be accessed by the Logging Framework

Parameters:
name the Tracker's name string, e.g. "a.b.c"
publisher the publisher class name, e.g. "com.domain.CustomPublisher"
filter the formatter class name, e.g. "com.domain.CustomFormatter"

Definition at line 273 of file TrackManager.as.

static function gugga.tracking.TrackManager.getClassByName ( className:String   )  [static, private]

Returns the Function object associated with the class with the given string name.

Returns:
the Function object

Definition at line 351 of file TrackManager.as.


Member Data Documentation

var gugga.tracking.TrackManager.instance [static, private]

Definition at line 18 of file TrackManager.as.

var gugga.tracking.TrackManager.defaultPublisher [private]

Definition at line 19 of file TrackManager.as.

var gugga.tracking.TrackManager.logger [static, private]

Definition at line 128 of file TrackManager.as.

var gugga.tracking.TrackManager.ROOT_NODE [static, private]

Definition at line 129 of file TrackManager.as.

var gugga.tracking.TrackManager.TRACKER_NODE [static, private]

Definition at line 130 of file TrackManager.as.

var gugga.tracking.TrackManager.PUBLISHER_NODE [static, private]

Definition at line 131 of file TrackManager.as.


Generated on Fri May 11 17:14:50 2007 for GuggaFramework by  doxygen 1.5.2