raccoon.tibco.tibrv.badhnati.xml
Class XmlToTibrv

java.lang.Object
  raccoon.tibco.tibrv.badhnati.xml.XmlToTibrv

public class XmlToTibrv
extends java.lang.Object

TODO Document this class.

Since:

Raccoon v1.0

Version:

$Id:$

Author:

Cedric ROUVRAIS

Constructor Summary

XmlToTibrv()

Method Summary

boolean	isFastMode() Determines if the fast mode is active.
com.tibco.tibrv.TibrvMsg	marshal(org.xml.sax.InputSource pInputSource) Converts the content of an XML input source into a TibrvMsg instance.
com.tibco.tibrv.TibrvMsg	marshal(java.io.Reader pXmlReader) Converts the contents of an XML Reader into a TibrvMsg instance.
com.tibco.tibrv.TibrvMsg	marshal(java.lang.String pXmlMsg) Converts a given XML compliant string into a TibrvMsg instance.
void	setFastMode(boolean pFastMode) Defines whether or not the fast mode is to be used.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlToTibrv

public XmlToTibrv()
           throws LoadableException

Throws:

LoadableException

Method Detail

isFastMode

public boolean isFastMode()

Determines if the fast mode is active.

The fast mode is to be used if the input XML document comes from a sure source. The fast mode doesn't do any particular checking and logging.

For example, if the XML document is generated by the Raccoon Framework service, for example MessageToXml, then it is acceptable to use the fast mode.

Returns:

true if the fast mode is active.

setFastMode

public void setFastMode(boolean pFastMode)

Defines whether or not the fast mode is to be used.

The fast mode is to be used if the input XML document comes from a sure source. The fast mode doesn't do any particular checking and logging.

For example, if the XML document is generated by the Raccoon Framework service, for example MessageToXml, then it is acceptable to use the fast mode.

Parameters:

pFastMode - the mode of the analysis to use for the XML Document.

marshal

public com.tibco.tibrv.TibrvMsg marshal(java.lang.String pXmlMsg)
                                 throws RaccoonException

Converts a given XML compliant string into a TibrvMsg instance.

Parameters:

pXmlMsg - the XML string

Returns:

the TibrvMsg instance.

Throws:

RaccoonException - if the XML string is invalid.

marshal

public com.tibco.tibrv.TibrvMsg marshal(java.io.Reader pXmlReader)
                                 throws RaccoonException

Converts the contents of an XML Reader into a TibrvMsg instance.

Parameters:

pXmlReader - the XML string

Returns:

the TibrvMsg instance.

Throws:

RaccoonException - if the XML string is invalid.

marshal

public com.tibco.tibrv.TibrvMsg marshal(org.xml.sax.InputSource pInputSource)
                                 throws RaccoonException

Converts the content of an XML input source into a TibrvMsg instance.

Parameters:

pInputSource - the XML input source

Returns:

the TibrvMsg instance.

Throws:

RaccoonException - if the XML string is invalid.