com.putable.xmlhandler

Class XMLHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

com.putable.xmlhandler.XMLHandler

All Implemented Interfaces:

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

Direct Known Subclasses:

ClientXMLHandler, ServerXMLHandler

public abstract class XMLHandler
extends org.xml.sax.helpers.DefaultHandler

XMLHandler is the master abstract class for handling communication language (XML) between client and a server inside NetPuzl. All grammar is based on "NetPuzl1.1.dtd" (required for proper functionality) and, of course, the specs for NetPuzl. Very important not to extend class directly since all handling is done in subclasses ServerXMLParser and ClientXMLParser due to extreme difference in their expected functionality.

Version:

1.0

Author:

heineken

See Also:

DefaultHandler, ServerXMLHandler, ClientXMLHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.HashMap<java.lang.String,java.lang.String>	attr
private java.lang.StringBuffer	data
private Tag.TType	type
private static java.lang.String	version

Constructor Summary

Constructors

Constructor and Description
XMLHandler()

Method Summary

Modifier and Type	Method and Description
void	characters(char[] arg0, int arg1, int arg2)
java.awt.Color	convertToColor(java.lang.String strC) Converts 8 character string representation of a 32-bit Integer in hex into a color with RGBA content
void	endDocument()
protected abstract void	endOfXMLDocument() Method is called when root tag is closed
protected java.lang.String	getData() Supplemental tag to get the content of non empty element
private java.lang.String	getFromXMLStr(java.lang.String inStr) Inside function used for converting "&amp;" to '&', "&lt;" to '<' and &quot;" to '"' inside the string for converting XML ready text to user eye friendly.
protected Tag.TType	getType() Supplemental method to get the type of parsing tag
java.lang.String	getVersion() Returns the version of the communication language between client and server in NetPuzl world.
protected java.awt.image.BufferedImage	parseHexImage(java.lang.String imStr) Method for converting hex string into image
protected abstract Tag	parseTag() Parses and creates the Tag appropriate type ( can get type by calling getType() method )
void	startElement(java.lang.String nsURI, java.lang.String lName, java.lang.String qName, org.xml.sax.Attributes attributes)

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

endElement, 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

type

private Tag.TType type

version

private static final java.lang.String version

See Also:

Constant Field Values

data

private java.lang.StringBuffer data

attr

protected java.util.HashMap<java.lang.String,java.lang.String> attr

Constructor Detail

XMLHandler

public XMLHandler()

Method Detail

parseTag

protected abstract Tag parseTag()
                         throws org.xml.sax.SAXException

Parses and creates the Tag appropriate type ( can get type by calling getType() method )

Returns:

Tag object

Throws:

org.xml.sax.SAXException - if illegal attribute formating

endOfXMLDocument

protected abstract void endOfXMLDocument()

Method is called when root tag is closed

startElement

public void startElement(java.lang.String nsURI,
                         java.lang.String lName,
                         java.lang.String qName,
                         org.xml.sax.Attributes attributes)
                  throws org.xml.sax.SAXException

Specified by:

startElement in interface org.xml.sax.ContentHandler

Overrides:

startElement in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

parseHexImage

protected java.awt.image.BufferedImage parseHexImage(java.lang.String imStr)
                                              throws java.io.IOException,
                                                     org.xml.sax.SAXException

Method for converting hex string into image

Parameters:

imStr - string representation of the image in hex format

Returns:

BufferedImage reference to an actual displayable image, null if input string was empty or null

Throws:

java.io.IOException

org.xml.sax.SAXException - if length is not even

convertToColor

public java.awt.Color convertToColor(java.lang.String strC)

Converts 8 character string representation of a 32-bit Integer in hex into a color with RGBA content

Parameters:

strC - hex representation of the color

Returns:

an actual Color

getFromXMLStr

private java.lang.String getFromXMLStr(java.lang.String inStr)

Inside function used for converting "&amp;" to '&', "&lt;" to '<' and &quot;" to '"' inside the string for converting XML ready text to user eye friendly.

Parameters:

inStr - String that will be prepared

Returns:

String that has special characters converted

characters

public void characters(char[] arg0,
                       int arg1,
                       int arg2)
                throws org.xml.sax.SAXException

Specified by:

characters in interface org.xml.sax.ContentHandler

Overrides:

characters in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

getType

protected Tag.TType getType()

Supplemental method to get the type of parsing tag

getData

protected java.lang.String getData()

Supplemental tag to get the content of non empty element

Returns:

null if tag is closed, String representation if the tag is opened, like XRESPONSE and XREQUEST

getVersion

public java.lang.String getVersion()

Returns the version of the communication language between client and server in NetPuzl world. If it not equal to "1.1", there is a problem.

Returns:

version of the communication

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Overrides:

endDocument in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException