gov.nasa.arc.brahms.common.data.format.uml
Class ModelFormatter

java.lang.Object
  gov.nasa.arc.brahms.common.data.format.uml.BrahmsObjectFormatter
      gov.nasa.arc.brahms.common.data.format.uml.ModelElementFormatter
          gov.nasa.arc.brahms.common.data.format.uml.NamedModelElementFormatter
              gov.nasa.arc.brahms.common.data.format.uml.ModelFormatter

All Implemented Interfaces:

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

public class ModelFormatter
extends NamedModelElementFormatter

This class provides the UML formatting logic for the Model

Version:

25 June 2004

Author:

Ron van Hoof

Field Summary

Fields inherited from class gov.nasa.arc.brahms.common.data.format.uml.BrahmsObjectFormatter

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

ModelFormatter(UMLFormat format)
Constructor, creates a new UML formatter for Model

Method Summary

protected static java.io.DataOutputStream	openUMLModelFile(Model model, java.util.Properties p) Determines the file name for the UML model file for the given model, creates the file, opens it and returns the stream to that file.
void	writeFormat(BrahmsObject o, java.util.Properties p, java.io.DataOutputStream out) Writes the given object out in the format defined for that object.

Methods inherited from class gov.nasa.arc.brahms.common.data.format.uml.NamedModelElementFormatter

getSortedSet

Methods inherited from class gov.nasa.arc.brahms.common.data.format.uml.BrahmsObjectFormatter

getFormat, setFormat

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelFormatter

public ModelFormatter(UMLFormat format)

Constructor, creates a new UML formatter for Model

Parameters:

format - the parent UMLFormat

Method Detail

openUMLModelFile

protected static java.io.DataOutputStream openUMLModelFile(Model model,
                                                           java.util.Properties p)

Determines the file name for the UML model file for the given model, creates the file, opens it and returns the stream to that file.

Parameters:

model - the Model for which to generate UML

p - Properties containing the logger

Returns:

DataOutputStream the stream to write to the file

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

Overrides:

writeFormat in class BrahmsObjectFormatter

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