org.LexGrid.LexBIG.Impl.exporters
Class ExporterMessageDirector

java.lang.Object
  extended by org.LexGrid.LexBIG.Impl.exporters.ExporterMessageDirector
All Implemented Interfaces:
LgMessageDirectorIF

public class ExporterMessageDirector
extends java.lang.Object
implements LgMessageDirectorIF

A message director to redirect messages as necessary for LexBig.

Version:
subversion $Revision: $ checked in on $Date: $
Author:
Dan Armbrust, Jesse Erdmann

Field Summary
protected  int count_
           
protected  java.util.List<LogEntry> messages_
           
protected  java.lang.String programName_
           
protected  ProcessStatus status_
           
 
Constructor Summary
ExporterMessageDirector(java.lang.String programName, ProcessStatus status)
           
 
Method Summary
 void busy()
          Output to indicate system is busy - spin a cursor, print a dot, etc.
 void clearMessages()
           
 java.lang.String debug(java.lang.String message)
          Take a debug message.
 java.lang.String error(java.lang.String message)
          Display a non-fatal error to the user.
 java.lang.String error(java.lang.String message, java.lang.Throwable sourceException)
          Display a non-fatal error to the user
 java.lang.String fatal(java.lang.String message)
          Display a fatal error to the user.
 java.lang.String fatal(java.lang.String message, java.lang.Throwable sourceException)
          Display a fatal error to the user.
 void fatalAndThrowException(java.lang.String message)
          Display a fatal error to the user - and then throw an exception.
 void fatalAndThrowException(java.lang.String message, java.lang.Throwable sourceException)
          Display a fatal error to the user - and then throw an exception.
 LogEntry[] getLogEntries(LogLevel level)
           
protected  LgLoggerIF getLogger()
           
 java.lang.String info(java.lang.String message)
          Displays a status type of message (not an error or a warning)
 java.lang.String warn(java.lang.String message)
          Display a warning to the user.
 java.lang.String warn(java.lang.String message, java.lang.Throwable sourceException)
          Display a warning to the user
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

messages_

protected java.util.List<LogEntry> messages_

count_

protected int count_

programName_

protected java.lang.String programName_

status_

protected ProcessStatus status_
Constructor Detail

ExporterMessageDirector

public ExporterMessageDirector(java.lang.String programName,
                               ProcessStatus status)
Method Detail

getLogger

protected LgLoggerIF getLogger()

busy

public void busy()
Description copied from interface: LgMessageDirectorIF
Output to indicate system is busy - spin a cursor, print a dot, etc.

Specified by:
busy in interface LgMessageDirectorIF

clearMessages

public void clearMessages()

getLogEntries

public LogEntry[] getLogEntries(LogLevel level)

error

public java.lang.String error(java.lang.String message)
Description copied from interface: LgMessageDirectorIF
Display a non-fatal error to the user.

Specified by:
error in interface LgMessageDirectorIF
Returns:
Implementations may return a string, such as a log id.

error

public java.lang.String error(java.lang.String message,
                              java.lang.Throwable sourceException)
Description copied from interface: LgMessageDirectorIF
Display a non-fatal error to the user

Specified by:
error in interface LgMessageDirectorIF
sourceException - The source exception that caused the error.

fatal

public java.lang.String fatal(java.lang.String message)
Description copied from interface: LgMessageDirectorIF
Display a fatal error to the user.

Specified by:
fatal in interface LgMessageDirectorIF
Returns:
Implementations may return a string, such as a log id.

fatal

public java.lang.String fatal(java.lang.String message,
                              java.lang.Throwable sourceException)
Description copied from interface: LgMessageDirectorIF
Display a fatal error to the user.

Specified by:
fatal in interface LgMessageDirectorIF
sourceException - The source exception that caused the error.
Returns:
Implementations may return a string, such as a log id.

fatalAndThrowException

public void fatalAndThrowException(java.lang.String message)
                            throws java.lang.Exception
Description copied from interface: LgMessageDirectorIF
Display a fatal error to the user - and then throw an exception.

Specified by:
fatalAndThrowException in interface LgMessageDirectorIF
Throws:
java.lang.Exception

fatalAndThrowException

public void fatalAndThrowException(java.lang.String message,
                                   java.lang.Throwable sourceException)
                            throws java.lang.Exception
Description copied from interface: LgMessageDirectorIF
Display a fatal error to the user - and then throw an exception.

Specified by:
fatalAndThrowException in interface LgMessageDirectorIF
sourceException - The source exception that caused the error.
Throws:
java.lang.Exception

info

public java.lang.String info(java.lang.String message)
Description copied from interface: LgMessageDirectorIF
Displays a status type of message (not an error or a warning)

Specified by:
info in interface LgMessageDirectorIF
Returns:
Implementations may return a string, such as a log id.

warn

public java.lang.String warn(java.lang.String message)
Description copied from interface: LgMessageDirectorIF
Display a warning to the user.

Specified by:
warn in interface LgMessageDirectorIF
Returns:
Implementations may return a string, such as a log id.

warn

public java.lang.String warn(java.lang.String message,
                             java.lang.Throwable sourceException)
Description copied from interface: LgMessageDirectorIF
Display a warning to the user

Specified by:
warn in interface LgMessageDirectorIF
sourceException - The source exception that caused the warning
Returns:
Implementations may return a string, such as a log id.

debug

public java.lang.String debug(java.lang.String message)
Description copied from interface: LgMessageDirectorIF
Take a debug message.

Specified by:
debug in interface LgMessageDirectorIF
Returns:
Implementations may return a string, such as a log id.

Copyright: (c) 2004-2006 Mayo Foundation for Medical Education and Research (MFMER). All rights reserved. MAYO, MAYO CLINIC, and the triple-shield Mayo logo are trademarks and service marks of MFMER.