Package org.sbml.jsbml.xml.parsers

Class MultiParser

java.lang.Object

org.sbml.jsbml.xml.parsers.AbstractReaderWriter

org.sbml.jsbml.xml.parsers.MultiParser

All Implemented Interfaces:

PackageParser, ReadingParser, WritingParser

@ProviderFor(ReadingParser.class)
public class MultiParser
extends AbstractReaderWriter
implements PackageParser

A MultiParser is used to parse the multi extension package elements and attributes. The namespaceURI URI of this parser is "http://www.sbml.org/sbml/level3/version1/multi/version1". This parser is able to read and write elements of the multi package (implements ReadingParser and WritingParser).

Since:

1.0

Author:

Nicolas Rodriguez

Constructor Summary

Constructors

Constructor	Description
MultiParser()

Method Summary

Modifier and Type	Method	Description
ASTNodePlugin	createPluginFor(ASTNode astNode)	Creates a new ASTNodePlugin for the given ASTNode and add it to the ASTNodePlugin map of the ASTNode.
SBasePlugin	createPluginFor(SBase sbase)	Creates a new SBasePlugin for the given SBase and add it to the SBasePlugin map of the SBase.
java.util.List<java.lang.Object>	getListOfSBMLElementsToWrite(java.lang.Object treeNode)	Returns the list of children of the objectToWrite.
java.lang.String	getNamespaceFor(int level, int version, int packageVersion)	Gets the namespace for this package that correspond to the given SBML level, version and the package version.
java.util.List<java.lang.String>	getNamespaces()	Returns a List of all the namespaces that this parser is handling.
java.lang.String	getNamespaceURI()	Return the namespace URI of the namespace parsed by this class.
java.lang.String	getPackageName()	Returns the short name of this package.
java.util.List<java.lang.String>	getPackageNamespaces()	Returns a List of all the valid namespaces for the package.
java.lang.String	getShortLabel()	Returns the shortLabel of the namespace parsed by this class.
boolean	isRequired()	Returns the value of the required attribute for this package.
boolean	processAttribute(java.lang.String elementName, java.lang.String attributeName, java.lang.String value, java.lang.String uri, java.lang.String prefix, boolean isLastAttribute, java.lang.Object contextObject)	Process the XML attribute and modify 'contextObject' in consequence.
java.lang.Object	processStartElement(java.lang.String elementName, java.lang.String uri, java.lang.String prefix, boolean hasAttributes, boolean hasNamespaces, java.lang.Object contextObject)	Process the XML element and modify 'contextObject' in consequence.
void	writeElement(SBMLObjectForXML xmlObject, java.lang.Object sbmlElementToWrite)	Sets the name of xmlObject (if it is not set) to the element name of sbmlElementToWrite.

Methods inherited from class org.sbml.jsbml.xml.parsers.AbstractReaderWriter

processCharactersOf, processEndDocument, processEndElement, processInvalidAttribute, processNamespace, processUnknownAttribute, processUnknownElement, storeElementsOrder, writeAttributes, writeCharacters, writeNamespaces

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiParser

public MultiParser()

Method Detail

getNamespaceURI

public java.lang.String getNamespaceURI()

Description copied from class: AbstractReaderWriter

Return the namespace URI of the namespace parsed by this class.

Specified by:

getNamespaceURI in class AbstractReaderWriter

Returns:

the namespaceURI of this parser.

getShortLabel

public java.lang.String getShortLabel()

Description copied from class: AbstractReaderWriter

Returns the shortLabel of the namespace parsed by this class.

Specified by:

getShortLabel in class AbstractReaderWriter

Returns:

the shortLabel of the namespace parsed by this class.

getListOfSBMLElementsToWrite

public java.util.List<java.lang.Object> getListOfSBMLElementsToWrite(java.lang.Object treeNode)

Description copied from interface: WritingParser

Returns the list of children of the objectToWrite.

Specified by:

getListOfSBMLElementsToWrite in interface WritingParser

Overrides:

getListOfSBMLElementsToWrite in class AbstractReaderWriter

Parameters:

treeNode - the SBase component to write.

Returns:

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

processAttribute

public boolean processAttribute(java.lang.String elementName,
                                java.lang.String attributeName,
                                java.lang.String value,
                                java.lang.String uri,
                                java.lang.String prefix,
                                boolean isLastAttribute,
                                java.lang.Object contextObject)

Description copied from interface: ReadingParser

Process the XML attribute and modify 'contextObject' in consequence.

For example, if the contextObject is an instance of Reaction and the attributeName is 'fast', this method will set the 'fast' variable of the 'contextObject' to 'value'. Then it will return the modified Reaction instance.

Specified by:

processAttribute in interface ReadingParser

Overrides:

processAttribute in class AbstractReaderWriter

Parameters:

elementName - the localName of the XML element.

attributeName - the attribute localName of the XML element.

value - the value of the XML attribute.

prefix - the attribute prefix

isLastAttribute - boolean value to know if this attribute is the last attribute of the XML element.

contextObject - the object to set or modify depending on the identity of the current attribute. This object represents the context of the XML attribute in the SBMLDocument.

Returns:

true if the attribute was recognized and stored in the contextObject, false otherwise.

processStartElement

public java.lang.Object processStartElement(java.lang.String elementName,
                                            java.lang.String uri,
                                            java.lang.String prefix,
                                            boolean hasAttributes,
                                            boolean hasNamespaces,
                                            java.lang.Object contextObject)

Description copied from interface: ReadingParser

Process the XML element and modify 'contextObject' in consequence.

For example, if the contextObject is an instance of Event and the elementName is 'trigger', this method will create a new Trigger instance and will set the trigger instance of the 'contextObject' to the new Trigger. Then the method will return the new Trigger instance which is the new environment.

Specified by:

processStartElement in interface ReadingParser

Specified by:

processStartElement in class AbstractReaderWriter

Parameters:

elementName - the localName of the XML element to process

prefix - the prefix of the XML element to process

hasAttributes - boolean value to know if this XML element has attributes.

hasNamespaces - boolean value to know if this XML element contains namespace declarations.

contextObject - the object to set or modify depending on the identity of the current XML element. This object represents the context of the XML element in the SBMLDocument.

Returns:

a new contextObject which represents the environment of the next node/subnode in the SBMLDocument. If null is returned, the contextObject will not change.

writeElement

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

Description copied from interface: WritingParser

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

Specified by:

writeElement in interface WritingParser

Overrides:

writeElement in class AbstractReaderWriter

Parameters:

xmlObject - contains the XML information about sbmlElement.

sbmlElementToWrite - the SBase component to write

getNamespaceFor

public java.lang.String getNamespaceFor(int level,
                                        int version,
                                        int packageVersion)

Description copied from interface: PackageParser

Gets the namespace for this package that correspond to the given SBML level, version and the package version.

Returns null if the combined level, version and packageVersion is invalid or not known from the package parser implementation.

Specified by:

getNamespaceFor in interface PackageParser

Parameters:

level - - the SBML level

version - - the SBML version

packageVersion - - the package version

Returns:

the namespace for this package that correspond to the given SBML level and version and the package version or null if nothing valid is found.

getNamespaces

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

Description copied from interface: ReadingParser

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

Specified by:

getNamespaces in interface ReadingParser

Specified by:

getNamespaces in interface WritingParser

Returns:

a List of all the namespaces that this parser is handling

getPackageNamespaces

public java.util.List<java.lang.String> getPackageNamespaces()

Description copied from interface: PackageParser

Returns a List of all the valid namespaces for the package.

Specified by:

getPackageNamespaces in interface PackageParser

Returns:

a List of all the valid namespaces for the package.

getPackageName

public java.lang.String getPackageName()

Description copied from interface: PackageParser

Returns the short name of this package.

Specified by:

getPackageName in interface PackageParser

Returns:

the short name of this package.

isRequired

public boolean isRequired()

Description copied from interface: PackageParser

Returns the value of the required attribute for this package.

Specified by:

isRequired in interface PackageParser

Returns:

the value of the required attribute for this package.

createPluginFor

public SBasePlugin createPluginFor(SBase sbase)

Description copied from interface: PackageParser

Creates a new SBasePlugin for the given SBase and add it to the SBasePlugin map of the SBase.

Specified by:

createPluginFor in interface PackageParser

Parameters:

sbase - - the sbase for which you want to create an SBasePlugin

Returns:

a new SBasePlugin corresponding to the given SBase.

createPluginFor

public ASTNodePlugin createPluginFor(ASTNode astNode)

Description copied from interface: PackageParser

Creates a new ASTNodePlugin for the given ASTNode and add it to the ASTNodePlugin map of the ASTNode.

Specified by:

createPluginFor in interface PackageParser

Parameters:

astNode - - the astNode for which you want to create an ASTNodePlugin

Returns:

a new ASTNodePlugin corresponding to the given ASTNode.