org.sbml.jsbml.xml.parsers

Interface WritingParser

All Known Implementing Classes:

AbstractReaderWriter, ArraysParser, CompParser, FBCParser, GroupsParser, L3LayoutParser, LayoutParser, MathMLParser, MultiParser, QualParser, RenderParser, ReqParser, SBMLCoreParser, SpatialParser

public interface WritingParser

The interface to implement for a parser which writes a SBML file.

Since:

0.8

Version:

$Rev: 1639 $

Author:

Marine Dumousseau

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<java.lang.Object>	getListOfSBMLElementsToWrite(java.lang.Object objectToWrite) Returns the list of children of the objectToWrite.
java.util.List<java.lang.String>	getNamespaces() Returns a List of all the namespaces that this parser is handling
void	writeAttributes(SBMLObjectForXML xmlObject, java.lang.Object sbmlElementToWrite) Adds the XML attributes of the sbmlElementToWrite to the attributes HashMap of the xmlObject.
void	writeCharacters(SBMLObjectForXML xmlObject, java.lang.Object sbmlElementToWrite) Sets the characters of xmlObject depending on the sbml element to write.
void	writeElement(SBMLObjectForXML xmlObject, java.lang.Object sbmlElementToWrite) Sets the name of xmlObject (if it is not set) to the element name of sbmlElementToWrite.
void	writeNamespaces(SBMLObjectForXML xmlObject, java.lang.Object sbmlElementToWrite) Sets the namespace of xmlObject (if it is not set) to the namespace of sbmlElementToWrite.

Method Detail

getListOfSBMLElementsToWrite

java.util.List<java.lang.Object> getListOfSBMLElementsToWrite(java.lang.Object objectToWrite)

Returns the list of children of the objectToWrite.

Parameters:

objectToWrite - the SBase component to write.

Returns:

the list of components that 'SBase' contains. Represents the list of subNodes of this SBase component.

writeAttributes

void writeAttributes(SBMLObjectForXML xmlObject,
                   java.lang.Object sbmlElementToWrite)

Adds the XML attributes of the sbmlElementToWrite to the attributes HashMap of the xmlObject.

Parameters:

xmlObject - contains the XML information about sbmlElement.

sbmlElementToWrite - the SBase component to write

writeCharacters

void writeCharacters(SBMLObjectForXML xmlObject,
                   java.lang.Object sbmlElementToWrite)

Sets the characters of xmlObject depending on the sbml element to write.

Parameters:

xmlObject - contains the XML information about sbmlElement.

sbmlElementToWrite - the SBase component to write

writeElement

void writeElement(SBMLObjectForXML xmlObject,
                java.lang.Object sbmlElementToWrite)

Sets the name of xmlObject (if it is not set) to the element name of sbmlElementToWrite.

Parameters:

xmlObject - contains the XML information about sbmlElement.

sbmlElementToWrite - the SBase component to write

writeNamespaces

void writeNamespaces(SBMLObjectForXML xmlObject,
                   java.lang.Object sbmlElementToWrite)

Sets the namespace of xmlObject (if it is not set) to the namespace of sbmlElementToWrite.

Parameters:

xmlObject - contains the XML information about sbmlElement.

sbmlElementToWrite - the SBase component to write

getNamespaces

java.util.List<java.lang.String> getNamespaces()

Returns a List of all the namespaces that this parser is handling

Returns:

a List of all the namespaces that this parser is handling