IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.base
Class TracesWindow

java.lang.Object
  extended by com.ibm.btt.base.TracesWindow

 class TracesWindow
extends java.lang.Object

This class controls where the trace lines will be written to trace targets: file,display,WAS, Common-logging.


Field Summary
(package private)  TraceCommLogging traceCommLogging
           
(package private)  TraceFile traceFile
          The trace file object
(package private)  TraceFrame traceFrame
          The display window
(package private)  TraceWAS traceWAS
          The trace WAS object
 int WR_ALL
          All elements in trace line mask *
 int WR_COMPONENT
          The component in trace line mask *
 int WR_DATE
          The date in trace line mask *
 int WR_LEVEL
          The level in trace line mask *
 int WR_NUMBER
          The line number in trace line mask *
 int WR_ThID
          The thread ID in trace line mask *
 int WR_TID
          The terminal ID in trace line mask *
 int WR_TIME
          The time in trace line mask *
 int WR_TYPE
          The type in trace line mask *
 
Constructor Summary
TracesWindow()
          The constructor of the class.
 
Method Summary
 void closeFrame()
          Close the frame.
 void deleteTraceFrame()
          Deletes the trace frame.
static void freezeList()
          To stop the list.
 java.util.HashMap<java.lang.String,TraceRequester> getComponents()
          This method was created in VisualAge.
 boolean getEnableLockScrolling()
          Returns the state of the lock scrolling option if traces to display is activated.
 int getShowTraceLevels()
          Gets the trace levels to trace.
 int getThreadColumnLength()
           
 int getTIDColumnLength()
           
 int getType()
          This method was created in VisualAge.
 int getWrite()
          Insert the method's description here.
protected  void initTraceTarget()
           
 boolean isTypeEnabled(int aType)
          This method was created in VisualAge.
 boolean readSettings()
          Initializes all the attributes of the class, reading the parameters from Settings.
 void reset()
          Frees all the resources used by the class.
 void resetCount()
          Sets the number of the next line to write to 1.
 void setCharLevel(int ndx, char newchar)
          Sets the value of the position ndx of the array levels with the value newchar.
 void setCharType(int ndx, char newchar)
          This method was created in VisualAge.
 void setEnableClearList()
          Clears the list of traces, if traces to display option is activated.
 void setEnableLockScrolling(boolean state)
          Enables or disables vertical scrolling, if traces to display option is activated.
 void setEnableOriginator(boolean state)
          Refreshs the originator option menu, if traces to display option is activated.
 void setEnableToDisplay(boolean ena)
          Enable/Disable the trace to display.
 void setEnableToFile(boolean ena)
          Enable/Disable the trace to file.
 void setFieldsToWrite(int w)
          Sets the value of the attribute write.
 void setFieldToWrite(int field, boolean state)
          Enables or disables, depending on state , or the field field in the trace record.
static void setLine(long l)
           
 void setLineLength(int w)
          Sets the value of the attribute lineLength.
 void setNumberOfLines(long l)
          Sets the value of the attribute numberOfLines .
 void setType(int aType)
          This method was created in VisualAge.
 void setWrite(int fields)
          Insert the method's description here.
static void unfreezeList()
           
protected  void writeTrace(java.lang.String component, int level, int inf, java.lang.String str, java.lang.String th, java.lang.String stack, java.lang.String id, java.util.Calendar moment)
          Writes the string "str" to the trace file, writing first the number of the line, the component,the level indicate by "inf", the type, the date and the time, the thread ID and the terminal ID if they are necessary.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

WR_DATE

public final int WR_DATE
The date in trace line mask *

See Also:
Constant Field Values

WR_TIME

public final int WR_TIME
The time in trace line mask *

See Also:
Constant Field Values

WR_LEVEL

public final int WR_LEVEL
The level in trace line mask *

See Also:
Constant Field Values

WR_NUMBER

public final int WR_NUMBER
The line number in trace line mask *

See Also:
Constant Field Values

WR_ThID

public final int WR_ThID
The thread ID in trace line mask *

See Also:
Constant Field Values

WR_TYPE

public final int WR_TYPE
The type in trace line mask *

See Also:
Constant Field Values

WR_TID

public final int WR_TID
The terminal ID in trace line mask *

See Also:
Constant Field Values

WR_COMPONENT

public final int WR_COMPONENT
The component in trace line mask *

See Also:
Constant Field Values

WR_ALL

public final int WR_ALL
All elements in trace line mask *

See Also:
Constant Field Values

traceFrame

TraceFrame traceFrame
The display window. *


traceFile

TraceFile traceFile
The trace file object. *


traceWAS

TraceWAS traceWAS
The trace WAS object. *


traceCommLogging

TraceCommLogging traceCommLogging
Constructor Detail

TracesWindow

public TracesWindow()
             throws java.lang.Exception
The constructor of the class. Initialize the attributes of the class with the appropiate values. Gets the values from the initialization file (.INI) throw the Setting class.

Throws:
java.lang.Exception
Method Detail

initTraceTarget

protected void initTraceTarget()

closeFrame

public void closeFrame()
Close the frame.


deleteTraceFrame

public void deleteTraceFrame()
Deletes the trace frame.


freezeList

public static void freezeList()
To stop the list.


getComponents

public final java.util.HashMap<java.lang.String,TraceRequester> getComponents()
This method was created in VisualAge.

Returns:
com.ibm.btt.base.Hashtable

getEnableLockScrolling

public boolean getEnableLockScrolling()
Returns the state of the lock scrolling option if traces to display is activated.

Returns:
boolean - If its value is true then vertical scrolling is enabled, and if the value is false then vertical scrolling is disabled.

getShowTraceLevels

public int getShowTraceLevels()
Gets the trace levels to trace.

Returns:
int

getType

public final int getType()
This method was created in VisualAge.

Returns:
int

getWrite

public int getWrite()
Insert the method's description here. Creation date: (5/24/00 5:15:01 PM)

Returns:
int

isTypeEnabled

public boolean isTypeEnabled(int aType)
This method was created in VisualAge.

Parameters:
aType - int
Returns:
boolean

readSettings

public boolean readSettings()
Initializes all the attributes of the class, reading the parameters from Settings.


reset

public void reset()
Frees all the resources used by the class.


resetCount

public void resetCount()
Sets the number of the next line to write to 1.


setCharLevel

public final void setCharLevel(int ndx,
                               char newchar)
Sets the value of the position ndx of the array levels with the value newchar.


setCharType

public final void setCharType(int ndx,
                              char newchar)
This method was created in VisualAge.

Parameters:
ndx - int
newchar - char

setEnableClearList

public void setEnableClearList()
Clears the list of traces, if traces to display option is activated.


setEnableLockScrolling

public void setEnableLockScrolling(boolean state)
Enables or disables vertical scrolling, if traces to display option is activated.

Parameters:
state - boolean - If its value is true then vertical scrolling is enabled, and if the value is false then vertical scrolling is disabled.

setEnableOriginator

public void setEnableOriginator(boolean state)
Refreshs the originator option menu, if traces to display option is activated.

Parameters:
state - boolean - The state for the originator option menu

setEnableToDisplay

public void setEnableToDisplay(boolean ena)
Enable/Disable the trace to display.

Parameters:
ena - boolean

setEnableToFile

public void setEnableToFile(boolean ena)
Enable/Disable the trace to file.

Parameters:
ena - boolean

setFieldsToWrite

public final void setFieldsToWrite(int w)
Sets the value of the attribute write.


setFieldToWrite

public void setFieldToWrite(int field,
                            boolean state)
Enables or disables, depending on state , or the field field in the trace record.

Parameters:
field - int - The field
state - boolean - The new state for the field

setLine

public static void setLine(long l)
Parameters:
l - long

setLineLength

public final void setLineLength(int w)
Sets the value of the attribute lineLength.


setNumberOfLines

public final void setNumberOfLines(long l)
Sets the value of the attribute numberOfLines .


setType

public final void setType(int aType)
This method was created in VisualAge.

Parameters:
aType - int

setWrite

public void setWrite(int fields)
Insert the method's description here. Creation date: (5/24/00 5:15:57 PM)

Parameters:
fields - int

unfreezeList

public static void unfreezeList()

writeTrace

protected final void writeTrace(java.lang.String component,
                                int level,
                                int inf,
                                java.lang.String str,
                                java.lang.String th,
                                java.lang.String stack,
                                java.lang.String id,
                                java.util.Calendar moment)
Writes the string "str" to the trace file, writing first the number of the line, the component,the level indicate by "inf", the type, the date and the time, the thread ID and the terminal ID if they are necessary.


getThreadColumnLength

public int getThreadColumnLength()
Returns:
Returns the threadColumnLength.

getTIDColumnLength

public int getTIDColumnLength()
Returns:
Returns the tIDColumnLength.

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2011