pl.aislib.fm
Class MessagesHandler

java.lang.Object
  org.xml.sax.helpers.DefaultHandler
      pl.aislib.fm.forms.config.Handler
          pl.aislib.fm.MessagesHandler

All Implemented Interfaces:

org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler, IXMLHandler

public class MessagesHandler

extends Handler

XML handler for handling framework's messages.

Version:

$Revision: 1.3 $

Author:

Wojciech Swiatek, AIS.PL

Field Summary

protected java.lang.String	defaultLanguage Default language for messages.
protected java.util.Map	messageGroups Map of groups of messages.
protected java.util.Map	messages Map of messages.

Fields inherited from class pl.aislib.fm.forms.config.Handler

currentBuffer, currentObject, currentPartialHandler, log, partialHandlers

Constructor Summary

MessagesHandler(org.apache.commons.logging.Log log)

Method Summary

void	addMessage(int messageType, int messageCode, java.lang.String key, IMessageContent content, java.lang.String defaultLanguage)
void	addMessageGroup(int messageGroupCode, java.util.List messageGroup)
java.util.Map	cloneMessageGroups()
java.util.Map	cloneMessages()
protected void	createPartialHandlers() Creates partial handlers, if any.
java.lang.String	getDefaultLanguage()
IMessage	getFullMessage(int messageCode)
Message	getMessage(int messageCode)
Message	getMessage(int messageCode, java.lang.String language)
java.util.List	getMessageGroup(int messageGroupCode)
void	processEndElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName)
java.lang.Object	processStartElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts)

Methods inherited from class pl.aislib.fm.forms.config.Handler

addPartialHandler, attributesToMap, characters, endElement, startElement

Methods inherited from class org.xml.sax.helpers.DefaultHandler

endDocument, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

messages

protected java.util.Map messages

Map of messages.

messageGroups

protected java.util.Map messageGroups

Map of groups of messages.

defaultLanguage

protected java.lang.String defaultLanguage

Default language for messages.

Constructor Detail

MessagesHandler

public MessagesHandler(org.apache.commons.logging.Log log)

Parameters:

log - logging object.

Method Detail

processEndElement

public void processEndElement(java.lang.String namespaceURI,
                              java.lang.String localName,
                              java.lang.String qName)
                       throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException

See Also:

IXMLHandler.processEndElement(java.lang.String, java.lang.String, java.lang.String)

processStartElement

public java.lang.Object processStartElement(java.lang.String namespaceURI,
                                            java.lang.String localName,
                                            java.lang.String qName,
                                            org.xml.sax.Attributes atts)
                                     throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException

See Also:

IXMLHandler.processStartElement(String, String, String, Attributes)

addMessage

public void addMessage(int messageType,
                       int messageCode,
                       java.lang.String key,
                       IMessageContent content,
                       java.lang.String defaultLanguage)

Parameters:

messageType - type of a message.

messageCode - identification code for the message.

key - key for the message.

content - message content object.

defaultLanguage - default language for the message.

addMessageGroup

public void addMessageGroup(int messageGroupCode,
                            java.util.List messageGroup)

Parameters:

messageGroupCode - identification code for a group of messages.

messageGroup - group of messages.

cloneMessages

public java.util.Map cloneMessages()

Returns:

a copy of map of messages.

cloneMessageGroups

public java.util.Map cloneMessageGroups()

Returns:

a copy of map of group of messages.

getDefaultLanguage

public java.lang.String getDefaultLanguage()

Returns:

default language for messages.

getFullMessage

public IMessage getFullMessage(int messageCode)

Parameters:

messageCode - identification code for a message.

Returns:

the message with all of its contents.

getMessage

public Message getMessage(int messageCode)

Parameters:

messageCode - identification code for a message.

Returns:

the message with content in default language.

getMessage

public Message getMessage(int messageCode,
                          java.lang.String language)

Parameters:

messageCode - identification code for a message.

language - language in which the message should be given.

Returns:

the message with content in given language.

getMessageGroup

public java.util.List getMessageGroup(int messageGroupCode)

Parameters:

messageGroupCode - group code for messages.

Returns:

group of messages.

createPartialHandlers

protected void createPartialHandlers()

Description copied from class: Handler

Creates partial handlers, if any.

Overrides:

createPartialHandlers in class Handler

See Also:

Handler.createPartialHandlers()