com.nt.udc.io.xml

Class CXML_OSAROutput

java.lang.Object

com.nt.udc.io.xml.CXML_OSAROutput

All Implemented Interfaces:

IOSAROutput

public class CXML_OSAROutput
extends java.lang.Object
implements IOSAROutput

This class is used to output OSAR records in XML format.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	m_debugLevel
protected java.lang.String	m_groups This member stores the current group path.
protected IDataSink	m_iDataSink This member is used as the output medium.
protected ILogger	m_iLogger This member is used for reporting errors and warnings.
protected java.lang.StringBuffer	m_indentation This member stores the current indentation.
protected java.lang.StringBuffer	m_osarXML This member is stores the currently processed OSAR in XML format.
protected java.lang.String	m_recordType This member stores the type of the current processed OSAR.
protected char	m_separator This constant member is the group separator in OSAR attribute IDs

Constructor Summary

Constructors

Constructor and Description
CXML_OSAROutput(ILogger iLogger)

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	addAttr(COSARAttr osarAttr) This function is called when a new OSAR attribute is added to the currently processed OSAR.
protected void	closeGroups(java.lang.String groupPath)
protected void	debug(java.lang.String fName, java.lang.String msg)
protected void	decreaseIndentation()
protected void	error(java.lang.String fName, java.lang.String msg)
IDataSink	getDataSink()
static int	getDebugLevel()
protected int	getDiffStartIndex(java.lang.String groups1, java.lang.String groups2)
protected void	increaseIndentation()
boolean	isHealthy() This function is used to check if the object is fully functional.
protected void	openGroups(java.lang.String groupPath)
void	setDataSink(IDataSink iDataSink) This function is used to initialize the data sink
static void	setDebugLevel(int debugLevel)
boolean	storeOSAR(COSAR osar) This function is called when a new OSAR is to be processed.

Methods inherited from class java.lang.Object

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

Field Detail

m_separator

protected final char m_separator

This constant member is the group separator in OSAR attribute IDs

See Also:

Constant Field Values

m_debugLevel

protected static int m_debugLevel

m_iLogger

protected ILogger m_iLogger

This member is used for reporting errors and warnings.

m_osarXML

protected java.lang.StringBuffer m_osarXML

This member is stores the currently processed OSAR in XML format.

m_recordType

protected java.lang.String m_recordType

This member stores the type of the current processed OSAR.

m_groups

protected java.lang.String m_groups

This member stores the current group path.

m_indentation

protected java.lang.StringBuffer m_indentation

This member stores the current indentation.

m_iDataSink

protected IDataSink m_iDataSink

This member is used as the output medium.

Constructor Detail

CXML_OSAROutput

public CXML_OSAROutput(ILogger iLogger)

Method Detail

getDebugLevel

public static int getDebugLevel()

getDataSink

public final IDataSink getDataSink()

setDebugLevel

public static void setDebugLevel(int debugLevel)

setDataSink

public void setDataSink(IDataSink iDataSink)

Description copied from interface: IOSAROutput

This function is used to initialize the data sink

Specified by:

setDataSink in interface IOSAROutput

storeOSAR

public boolean storeOSAR(COSAR osar)

This function is called when a new OSAR is to be processed.

Specified by:

storeOSAR in interface IOSAROutput

Returns:

true if successul, false otherwise

isHealthy

public boolean isHealthy()

This function is used to check if the object is fully functional.

Specified by:

isHealthy in interface IOSAROutput

addAttr

protected boolean addAttr(COSARAttr osarAttr)

This function is called when a new OSAR attribute is added to the currently processed OSAR.

Attribute grouping must be handled. An attribute may be part of a list of nested groups. In that case, its ID will contain the names of those groups, separated by colons, as well as the attribute's name.

Example: ID = "group1:group2:name"

The function compares the groups of consecutive attributes and generates XML code appropriately for closing old groups and opening new ones, if necessary.

Example: attr1_id = "group1:group2:name1", attr2_id = "group1:group3:name2"

The generated XML code is:

val1 val2

Returns:

true if successful, false otherwise

openGroups

protected void openGroups(java.lang.String groupPath)

closeGroups

protected void closeGroups(java.lang.String groupPath)

increaseIndentation

protected void increaseIndentation()

decreaseIndentation

protected void decreaseIndentation()

getDiffStartIndex

protected int getDiffStartIndex(java.lang.String groups1,
                    java.lang.String groups2)

error

protected void error(java.lang.String fName,
         java.lang.String msg)

debug

protected void debug(java.lang.String fName,
         java.lang.String msg)