|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.etools.systems.core.messages.SystemMessageFile
Use this class to open, and parse, a RSE-style message file.
Field Summary | |
---|---|
static String |
copyright
|
Constructor Summary | |
---|---|
SystemMessageFile(String messageFileName,
InputStream messageFile,
InputStream dtdStream)
Constructor |
|
SystemMessageFile(String messageFileName,
String defaultMessageFileLocation)
Constructor |
Method Summary | |
---|---|
void |
error(SAXParseException ex)
XML Parser-required method: XML-parser Error. |
void |
fatalError(SAXParseException ex)
XML Parser-required method: XML-parser Fatal error. |
protected com.ibm.etools.systems.core.messages.SystemMessageFile.MessageFileInfo |
getFromCache(String messageFileName)
If the named message file has already been loaded return its MessageFileInfo |
SystemMessage |
getMessage(String msgId)
Use this method to retrieve a message from the message file. |
protected SystemMessage |
loadSystemMessage(String componentAbbr,
String subComponentAbbr,
String msgNumber,
char msgIndicator,
String msgL1,
String msgL2)
Override this to provide different extended SystemMessage implementation |
boolean |
printHTML(String fullFileName)
Use this method to generate html documentation for the messages in the message file. |
boolean |
scanForDuplicates()
Use this method to scan message file for duplicate messages. |
void |
warning(SAXParseException ex)
XML Parser-required method: XML-parser warning. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String copyright
Constructor Detail |
public SystemMessageFile(String messageFileName, String defaultMessageFileLocation)
messageFileName
- - name of xml file which will contain the messagespublic SystemMessageFile(String messageFileName, InputStream messageFile, InputStream dtdStream)
messageFileName
- - name of xml file which will contain the messagesMethod Detail |
protected com.ibm.etools.systems.core.messages.SystemMessageFile.MessageFileInfo getFromCache(String messageFileName)
messageFileName
-
public SystemMessage getMessage(String msgId)
msgId
- - the ID of the message to retrieve. This is the concatenation of the
message's component abbreviation, subcomponent abbreviation, and message ID as declared
in the message xml file.
protected SystemMessage loadSystemMessage(String componentAbbr, String subComponentAbbr, String msgNumber, char msgIndicator, String msgL1, String msgL2) throws IndicatorException
componentAbbr
- subComponentAbbr
- msgNumber
- msgIndicator
- msgL1
- msgL2
-
IndicatorException
public boolean scanForDuplicates()
public boolean printHTML(String fullFileName)
public void warning(SAXParseException ex)
warning
in interface ErrorHandler
public void error(SAXParseException ex)
error
in interface ErrorHandler
public void fatalError(SAXParseException ex) throws SAXException
fatalError
in interface ErrorHandler
SAXException
|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |