gov.nasa.arc.brahms.common.data.format
Interface IFormat

All Known Implementing Classes:

OntologyFormat, SourceCodeFormat, UMLFormat, XMLFormat

public interface IFormat

The IFormat interface defines a generic interface to retrieve the appropriate formatter for a Brahms object and to write write the object out in the specified format. A Format determines based on the actual class of the Brahms object which formatter to use.

Version:

1.0

Author:

Ron van Hoof

Method Summary

IFormatter	getFormatter(BrahmsObject obj) Returns the formatter for the given object.
void	writeFormat(BrahmsObject obj, java.util.Properties p, java.io.DataOutputStream out) Writes the given object out in the format defined for that object.

Method Detail

getFormatter

IFormatter getFormatter(BrahmsObject obj)

Returns the formatter for the given object.

Parameters:

obj - the BrahmsObject to be formatted

Returns:

IFormatter the object containing the formatting logic for the object

writeFormat

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

Writes the given object out in the format defined for that 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