gov.nasa.arc.brahms.common.data.format.xml
Class BrahmsObjectFormatter

java.lang.Object
  gov.nasa.arc.brahms.common.data.format.xml.BrahmsObjectFormatter

All Implemented Interfaces:

IFormatter, gov.nasa.arc.brahms.common.IConstants

Direct Known Subclasses:

ArrayCreationFormatter, ArrayInitializerFormatter, ComparisonFormatter, ExpressionFormatter, ModelElementFormatter, OperandFormatter, ParameterValueFormatter

public class BrahmsObjectFormatter
extends java.lang.Object
implements gov.nasa.arc.brahms.common.IConstants, IFormatter

This class provides the XML formatting logic for the BrahmsObject

Version:

1.0

Author:

Ron van Hoof

Field Summary

protected static java.lang.String	BELIEF_PROPERTY
protected static java.lang.String	DEBUG_PROPERTY
protected static java.lang.String	DTDPATH_PROPERTY
protected static java.lang.String	LOG_PROPERTY
protected static java.lang.String	TABS_PROPERTY

Fields inherited from interface gov.nasa.arc.brahms.common.IConstants

ABORT, ACTIVECLASS, ACTIVECONCEPT, ACTIVEINSTANCE, AGENT, ANONYMOUS, ANYAGENT, AREA, AREADEF, ASSIGNED, ATTRIBUTE, BASEAREADEF, BASECLASS, BASECONCEPTUALCLASS, BASEGROUP, BASELIBRARY, BOOLEAN, BROADCAST, BUILDING, BYTE, CCLOCK, CDATE, CHAR, CITY, CLASS, CLOCK, COLLECTALL, COMMUNICATE, COMPLETE, COMPOSITE, COMPUTER, CONCEPT, CONCEPTUALCLASS, CONCEPTUALCONCEPT, CONCEPTUALOBJECT, CONTINUE, COPY, CREATEAGENT, CREATEAREA, CREATEOBJECT, current, CURRENT, DATAFRAME, DATE, DB, DETECTABLE, DIV, DOUBLE, EMAIL, EMPTY_STRING, END, ENDACTIVITY, ENTAGENT, EQ, EXCEPTION, EXPR, FACE2FACE, FACTFRAME, FALSE, FAX, FLOAT, FOREACH, FORONE, G2, GE, GEOGRAPHYCONCEPT, GESTURE, GET, GROUP, GT, IMPASSE, INT, INVALID, JAVA, JAVA_TYPE, KNOWN_MODIFIER, KNOWNVAL_MODIFIER, LE, LOCAL, LONG, LT, MAP, MINUS, MOD, MOVE, MULT, NE, NEW, NONE, NOT_MODIFIER, NOWORK, O, OA, OBJECT, ONTOLOGY, PAGER, PARAMETER, PATH, PHONE, PLUS, PRIMITIVE, PRIVATE, PROAGENT, PROTECTED, PRSAGENT, PUBLIC, PUT, RECEIVE, RELATION, sACTIVECLASS, sACTIVECONCEPT, sACTIVEINSTANCE, sAGENT, sARCHIVE, sAREA, sAREADEF, sBOOLEAN, sBYTE, sBYTECODEEXT, sCHAR, sCLASS, sCOMPUTER, sCONCEPT, sCONCEPTUALCLASS, sCONCEPTUALCONCEPT, sCONCEPTUALOBJECT, sCOPY, sCURRENT, sDETECTABLE, sDOUBLE, sEMAIL, sEND, SEND, sFACE2FACE, sFAX, sFILEEXT, sFLOAT, sGEOGRAPHYCONCEPT, sGROUP, SHORT, SIMAGENT, sINT, sJAVA_TYPE, sLONG, sMAP, sNEW, sNONE, sNOWORK, sOBJECT, SOURCECODE, sPAGER, sPARAMETER, sPATH, sPHONE, sPRIVATE, sPROJECTEXT, sPROTECTED, sPUBLIC, sSHORT, sSTART, sSTRING, sSYMBOL, START, STRING, sUNKNOWN, sVOID, SYMBOL, TRUE, UDT, UML, UNASSIGNED, UNDEFINED, unknown, UNKNOWN, UNKNOWN_MODIFIER, V, VARIABLE, VOID, WHENEVER, WORKFRAME, WORLD, XML

Constructor Summary

BrahmsObjectFormatter(IFormat format)
Constructor, creates a new BrahmsObjectFormatter

Method Summary

IFormat	getFormat() Returns the format this formatter is part of
void	setFormat(IFormat format) Sets the format this formatter is part of
void	writeFormat(BrahmsObject o, java.util.Properties p, java.io.DataOutputStream out) Writes the given object out in the format defined for that object.
protected void	writeFormatDebug(BrahmsObject obj, java.util.Properties p, java.io.DataOutputStream out) Writes the debug element information out for the given object.

Methods inherited from class java.lang.Object

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

Field Detail

DTDPATH_PROPERTY

protected static final java.lang.String DTDPATH_PROPERTY

See Also:

Constant Field Values

TABS_PROPERTY

protected static final java.lang.String TABS_PROPERTY

See Also:

Constant Field Values

LOG_PROPERTY

protected static final java.lang.String LOG_PROPERTY

See Also:

Constant Field Values

DEBUG_PROPERTY

protected static final java.lang.String DEBUG_PROPERTY

See Also:

Constant Field Values

BELIEF_PROPERTY

protected static final java.lang.String BELIEF_PROPERTY

See Also:

Constant Field Values

Constructor Detail

BrahmsObjectFormatter

public BrahmsObjectFormatter(IFormat format)

Constructor, creates a new BrahmsObjectFormatter

Parameters:

format - the format this class belongs to

Method Detail

setFormat

public void setFormat(IFormat format)

Sets the format this formatter is part of

Parameters:

format - the IFormat

getFormat

public IFormat getFormat()

Returns the format this formatter is part of

Returns:

IFormat the format

writeFormat

public void writeFormat(BrahmsObject o,
                        java.util.Properties p,
                        java.io.DataOutputStream out)

Writes the given object out in the format defined for that object.

Specified by:

writeFormat in interface IFormatter

Parameters:

o - the BrahmsObject to be written out in this format

p - the Properties relevant for the formatting of the output

out - the DataOutputStream to write the format output to

writeFormatDebug

protected void writeFormatDebug(BrahmsObject obj,
                                java.util.Properties p,
                                java.io.DataOutputStream out)
                         throws java.io.IOException

Writes the debug element information out for the given object.

Parameters:

obj - the BrahmsObject to be written out in this format

p - the Properties relevant for the formatting of the output

out - the DataOutputStream to write the format output to

Throws:

java.io.IOexception - if an error occurs writing to the output stream

java.io.IOException