org.sbml.jsbml.xml.parsers

Class QualParser

java.lang.Object

org.sbml.jsbml.xml.parsers.AbstractReaderWriter

org.sbml.jsbml.xml.parsers.QualParser

All Implemented Interfaces:

PackageParser, ReadingParser, WritingParser

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

Since:

1.0

Version:

$Rev: 1639 $

Author:

Nicolas Rodriguez

Field Detail

groupList

private QualList groupList

The QualList enum which represents the name of the list this parser is currently reading.

logger

private org.apache.log4j.Logger logger

Constructor Detail

QualParser

public QualParser()

Method Detail

getListOfSBMLElementsToWrite

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

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:

sbase - the SBase component to write.

Returns:

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

processEndElement

public boolean processEndElement(java.lang.String elementName,
                        java.lang.String prefix,
                        boolean isNested,
                        java.lang.Object contextObject)

Description copied from interface: ReadingParser

Process the end of the element 'elementName'. Modify or not the contextObject.

Specified by:

processEndElement in interface ReadingParser

Overrides:

processEndElement in class AbstractReaderWriter

Parameters:

elementName - the localName of the XML element.

prefix - the prefix of the XML element.

isNested - boolean value to know if the XML element is a nested element.

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

Returns:

true to remove the contextObject from the stack, if false is returned the contextObject will stay on top of the stack

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.

See Also:

org.sbml.jsbml.xml.parsers.ReadingParser#processStartElement(String elementName, String prefix, boolean hasAttributes, boolean hasNamespaces, Object contextObject)

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

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.

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 namespace URI of the namespace parsed by this class.

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.