ie.nuigalway.ecrg.jade.jmsmtp.util
Class XMLCodec

java.lang.Object
  |
  +--org.xml.sax.helpers.DefaultHandler
        |
        +--ie.nuigalway.ecrg.jade.jmsmtp.util.XMLCodec
All Implemented Interfaces:
org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

public class XMLCodec
extends org.xml.sax.helpers.DefaultHandler


Field Summary
private  java.lang.StringBuffer accumulator
           
private  jade.core.AID aid
           
static java.lang.String AID_ADDRESS
           
static java.lang.String AID_ADDRESSES
           
static java.lang.String AID_NAME
           
static java.lang.String AID_TAG
           
static java.lang.String COMMENTS_TAG
           
static java.lang.String CT
           
static java.lang.String DATE_TAG
           
static java.lang.String ENCODING_TAG
           
private  jade.domain.FIPAAgentManagement.Envelope env
           
static java.lang.String ENVELOPE_TAG
           
static java.lang.String ET
           
static java.lang.String FROM_TAG
           
static java.lang.String INDEX
           
static java.lang.String INDEX_ATTR
           
static java.lang.String INTENDED_TAG
           
static java.lang.String LENGTH_TAG
           
static java.lang.String NULL
           
static java.lang.String OT
           
static java.lang.String PARAMS_TAG
           
private  org.xml.sax.XMLReader parser
           
static java.lang.String PREAMBUL
           
private  jade.domain.FIPAAgentManagement.Property prop
           
static java.lang.String PROP_ATTR
           
static java.lang.String PROP_TAG
           
static java.lang.String RECEIVED_ATTR
           
static java.lang.String RECEIVED_BY
           
static java.lang.String RECEIVED_DATE
           
static java.lang.String RECEIVED_FROM
           
static java.lang.String RECEIVED_ID
           
static java.lang.String RECEIVED_TAG
           
static java.lang.String RECEIVED_VIA
           
static java.lang.String REPRESENTATION_TAG
           
private  jade.domain.FIPAAgentManagement.ReceivedObject ro
           
static java.lang.String TO_TAG
           
 
Constructor Summary
XMLCodec(java.lang.String parserClass)
          Constructor:
 
Method Summary
 void characters(char[] buffer, int start, int length)
          This method is called when exist characters in the elements
private static void encodeAid(java.lang.StringBuffer sb, jade.core.AID aid)
          Encode the information of Agent, Tags To and From
private static void encodeOneLineTag(java.lang.StringBuffer sb, java.lang.String tag1, java.lang.String tag2, java.lang.String value)
           
private static void encodeProp(java.lang.StringBuffer sb, jade.domain.FIPAAgentManagement.Property p)
          A user-defined property (String name, Object value) is encoded the following way: value FIXME: How should we encode the object?
private static void encodeTag(java.lang.StringBuffer sb, java.lang.String tag, java.lang.String content)
          This does the following: < tag > content
static java.lang.String encodeXML(jade.domain.FIPAAgentManagement.Envelope env)
          General Encoding of the envelope
 void endDocument()
          This method is called at the end of parsing
 void endElement(java.lang.String namespaceURL, java.lang.String localName, java.lang.String qname)
          This method is called the end of element
 void error(org.xml.sax.SAXParseException exception)
          This method is called when errors occur
 void fatalError(org.xml.sax.SAXParseException exception)
          This method is called when non-recoverable errors occur.
 jade.domain.FIPAAgentManagement.Envelope parse(java.io.Reader in)
          Main method
 void startDocument()
          This method is called when start the document XML
 void startElement(java.lang.String uri, java.lang.String localName, java.lang.String rawName, org.xml.sax.Attributes attributes)
          This method is called when jmp event of begin element.
 void warning(org.xml.sax.SAXParseException exception)
          This method is called when warning occur
 
Methods inherited from class org.xml.sax.helpers.DefaultHandler
endPrefixMapping, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startPrefixMapping, unparsedEntityDecl
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PREAMBUL

public static final java.lang.String PREAMBUL
See Also:
Constant Field Values

ENVELOPE_TAG

public static final java.lang.String ENVELOPE_TAG
See Also:
Constant Field Values

PARAMS_TAG

public static final java.lang.String PARAMS_TAG
See Also:
Constant Field Values

INDEX

public static final java.lang.String INDEX
See Also:
Constant Field Values

INDEX_ATTR

public static final java.lang.String INDEX_ATTR
See Also:
Constant Field Values

TO_TAG

public static final java.lang.String TO_TAG
See Also:
Constant Field Values

AID_TAG

public static final java.lang.String AID_TAG
See Also:
Constant Field Values

AID_NAME

public static final java.lang.String AID_NAME
See Also:
Constant Field Values

AID_ADDRESSES

public static final java.lang.String AID_ADDRESSES
See Also:
Constant Field Values

AID_ADDRESS

public static final java.lang.String AID_ADDRESS
See Also:
Constant Field Values

FROM_TAG

public static final java.lang.String FROM_TAG
See Also:
Constant Field Values

COMMENTS_TAG

public static final java.lang.String COMMENTS_TAG
See Also:
Constant Field Values

REPRESENTATION_TAG

public static final java.lang.String REPRESENTATION_TAG
See Also:
Constant Field Values

LENGTH_TAG

public static final java.lang.String LENGTH_TAG
See Also:
Constant Field Values

ENCODING_TAG

public static final java.lang.String ENCODING_TAG
See Also:
Constant Field Values

DATE_TAG

public static final java.lang.String DATE_TAG
See Also:
Constant Field Values

INTENDED_TAG

public static final java.lang.String INTENDED_TAG
See Also:
Constant Field Values

RECEIVED_TAG

public static final java.lang.String RECEIVED_TAG
See Also:
Constant Field Values

RECEIVED_DATE

public static final java.lang.String RECEIVED_DATE
See Also:
Constant Field Values

RECEIVED_BY

public static final java.lang.String RECEIVED_BY
See Also:
Constant Field Values

RECEIVED_FROM

public static final java.lang.String RECEIVED_FROM
See Also:
Constant Field Values

RECEIVED_ID

public static final java.lang.String RECEIVED_ID
See Also:
Constant Field Values

RECEIVED_VIA

public static final java.lang.String RECEIVED_VIA
See Also:
Constant Field Values

RECEIVED_ATTR

public static final java.lang.String RECEIVED_ATTR
See Also:
Constant Field Values

PROP_TAG

public static final java.lang.String PROP_TAG
See Also:
Constant Field Values

PROP_ATTR

public static final java.lang.String PROP_ATTR
See Also:
Constant Field Values

OT

public static final java.lang.String OT
See Also:
Constant Field Values

ET

public static final java.lang.String ET
See Also:
Constant Field Values

CT

public static final java.lang.String CT
See Also:
Constant Field Values

NULL

public static final java.lang.String NULL
See Also:
Constant Field Values

parser

private org.xml.sax.XMLReader parser

env

private jade.domain.FIPAAgentManagement.Envelope env

ro

private jade.domain.FIPAAgentManagement.ReceivedObject ro

aid

private jade.core.AID aid

prop

private jade.domain.FIPAAgentManagement.Property prop

accumulator

private java.lang.StringBuffer accumulator
Constructor Detail

XMLCodec

public XMLCodec(java.lang.String parserClass)
         throws jade.mtp.MTPException
Constructor:

Parameters:
parserClass - the SAX parser class to use
Method Detail

encodeAid

private static void encodeAid(java.lang.StringBuffer sb,
                              jade.core.AID aid)
Encode the information of Agent, Tags To and From


encodeTag

private static void encodeTag(java.lang.StringBuffer sb,
                              java.lang.String tag,
                              java.lang.String content)
This does the following: < tag > content


encodeProp

private static void encodeProp(java.lang.StringBuffer sb,
                               jade.domain.FIPAAgentManagement.Property p)
A user-defined property (String name, Object value) is encoded the following way: value FIXME: How should we encode the object?


encodeOneLineTag

private static void encodeOneLineTag(java.lang.StringBuffer sb,
                                     java.lang.String tag1,
                                     java.lang.String tag2,
                                     java.lang.String value)

encodeXML

public static java.lang.String encodeXML(jade.domain.FIPAAgentManagement.Envelope env)
General Encoding of the envelope


startDocument

public void startDocument()
This method is called when start the document XML

Specified by:
startDocument in interface org.xml.sax.ContentHandler
Overrides:
startDocument in class org.xml.sax.helpers.DefaultHandler

endDocument

public void endDocument()
This method is called at the end of parsing

Specified by:
endDocument in interface org.xml.sax.ContentHandler
Overrides:
endDocument in class org.xml.sax.helpers.DefaultHandler

startElement

public void startElement(java.lang.String uri,
                         java.lang.String localName,
                         java.lang.String rawName,
                         org.xml.sax.Attributes attributes)
This method is called when jmp event of begin element.

Specified by:
startElement in interface org.xml.sax.ContentHandler
Overrides:
startElement in class org.xml.sax.helpers.DefaultHandler

endElement

public void endElement(java.lang.String namespaceURL,
                       java.lang.String localName,
                       java.lang.String qname)
This method is called the end of element

Specified by:
endElement in interface org.xml.sax.ContentHandler
Overrides:
endElement in class org.xml.sax.helpers.DefaultHandler

characters

public void characters(char[] buffer,
                       int start,
                       int length)
This method is called when exist characters in the elements

Specified by:
characters in interface org.xml.sax.ContentHandler
Overrides:
characters in class org.xml.sax.helpers.DefaultHandler

warning

public void warning(org.xml.sax.SAXParseException exception)
This method is called when warning occur

Specified by:
warning in interface org.xml.sax.ErrorHandler
Overrides:
warning in class org.xml.sax.helpers.DefaultHandler

error

public void error(org.xml.sax.SAXParseException exception)
This method is called when errors occur

Specified by:
error in interface org.xml.sax.ErrorHandler
Overrides:
error in class org.xml.sax.helpers.DefaultHandler

fatalError

public void fatalError(org.xml.sax.SAXParseException exception)
                throws org.xml.sax.SAXException
This method is called when non-recoverable errors occur.

Specified by:
fatalError in interface org.xml.sax.ErrorHandler
Overrides:
fatalError in class org.xml.sax.helpers.DefaultHandler
org.xml.sax.SAXException

parse

public jade.domain.FIPAAgentManagement.Envelope parse(java.io.Reader in)
                                               throws jade.mtp.MTPException
Main method

jade.mtp.MTPException