org.sbml.jsbml.xml.parsers

Interface PackageParser

public interface PackageParser

Interface that define some common methods that the parsers for SBML packages need to implement in order to provide some basic information about them.

Author:

Nicolas Rodriguez

Method Summary

Methods

Modifier and Type	Method and Description
SBasePlugin	createPluginFor(SBase sbase) Creates a new SBasePlugin for the given SBase and add it to the SBasePlugin map of the SBase.
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.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.
boolean	isRequired() Returns the value of the required attribute for this package.

Method Detail

createPluginFor

SBasePlugin createPluginFor(SBase sbase)

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

Parameters:

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

Returns:

a new SBasePlugin corresponding to the given SBase.

getNamespaceFor

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.

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

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.

getPackageNamespaces

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

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

Returns:

a List of all the valid namespaces for the package.

getPackageName

java.lang.String getPackageName()

Returns the short name of this package.

Returns:

the short name of this package.

isRequired

boolean isRequired()

Returns the value of the required attribute for this package.

Returns:

the value of the required attribute for this package.