org.sbml.libsbml

Class SBMLLevelVersionConverter

java.lang.Object

org.sbml.libsbml.SBMLConverter

org.sbml.libsbml.SBMLLevelVersionConverter

public class SBMLLevelVersionConverter
extends SBMLConverter

SBML converter for transforming documents from one Level+Version to another.

This class of objects is defined by libSBML only and has no direct equivalent in terms of SBML components. It is a class used in the implementation of extra functionality provided by libSBML.

This SBML converter takes an SBML document of one SBML Level+Version combination and attempts to convert it to another Level+Version combination. The target Level+Version is set using an SBMLNamespace object in the ConversionProperties object that controls this converter.

This class is the basis for SBMLDocument.setLevelAndVersion(long lev, long ver, boolean strict).

See Also:

SBMLFunctionDefinitionConverter, SBMLInitialAssignmentConverter, SBMLRuleConverter, SBMLStripPackageConverter, SBMLUnitsConverter

Constructor Summary

Constructors

Constructor and Description
SBMLLevelVersionConverter() Creates a new SBMLLevelVersionConverter object.
SBMLLevelVersionConverter(SBMLLevelVersionConverter obj) Copy constructor creates a copy of an SBMLLevelVersionConverter object.

Method Summary

Methods

Modifier and Type	Method and Description
SBMLConverter	cloneObject() Creates and returns a deep copy of this SBMLConverter object.
int	convert() Perform the conversion.
void	delete() Explicitly deletes the underlying native object.
ConversionProperties	getDefaultProperties() Returns the default properties of this converter.
long	getTargetLevel() Returns the target SBML Level for the conversion.
long	getTargetVersion() Returns the target SBML Version for the conversion.
boolean	getValidityFlag() Returns the flag indicating whether the conversion has been set to 'strict'.
static void	init()
boolean	matchesProperties(ConversionProperties props) Predicate returning true if this converter's properties matches a given set of configuration properties.

Methods inherited from class org.sbml.libsbml.SBMLConverter

getDocument, getProperties, getTargetNamespaces, setDocument, setProperties, swigReleaseOwnership, swigTakeOwnership

Methods inherited from class java.lang.Object

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

Constructor Detail

SBMLLevelVersionConverter

public SBMLLevelVersionConverter()

Creates a new SBMLLevelVersionConverter object.

SBMLLevelVersionConverter

public SBMLLevelVersionConverter(SBMLLevelVersionConverter obj)

Copy constructor creates a copy of an SBMLLevelVersionConverter object.

Parameters:

obj - the SBMLLevelVersionConverter object to copy.

Method Detail

cloneObject

public SBMLConverter cloneObject()

Creates and returns a deep copy of this SBMLConverter object.

Overrides:

cloneObject in class SBMLConverter

Returns:

a (deep) copy of this SBMLConverter object.

convert

public int convert()

Perform the conversion.

This method causes the converter to do the actual conversion work, that is, to convert the SBMLDocument object set by SBMLConverter.setDocument(SBMLDocument doc) and with the configuration options set by SBMLConverter.setProperties(ConversionProperties props).

Overrides:

convert in class SBMLConverter

Returns:

integer value indicating the success/failure of the operation. The set of possible values that may be returned depends on the converter subclass please consult the documentation for the relevant class to find out what the possibilities are.

delete

public void delete()

Explicitly deletes the underlying native object.

In general, application software will not need to call this method directly. The Java language binding for libSBML is implemented as a language wrapper that provides a Java interface to libSBML's underlying C++/C code. Some of the Java methods return objects that are linked to objects created not by Java code, but by C++ code. The Java objects wrapped around them will be deleted when the garbage collector invokes the corresponding C++ finalize() methods for the objects. The finalize() methods in turn call the SBMLLevelVersionConverter.delete() method on the libSBML object.

This method is exposed in case calling programs want to ensure that the underlying object is freed immediately, and not at some arbitrary time determined by the Java garbage collector. In normal usage, callers do not need to invoke SBMLLevelVersionConverter.delete() themselves.

Overrides:

delete in class SBMLConverter

getDefaultProperties

public ConversionProperties getDefaultProperties()

Returns the default properties of this converter.

A given converter exposes one or more properties that can be adjusted in order to influence the behavior of the converter. This method returns the default property settings for this converter. It is meant to be called in order to discover all the settings for the converter object. The run-time properties of the converter object can be adjusted by using the method SBMLConverter.setProperties(ConversionProperties props).

Overrides:

getDefaultProperties in class SBMLConverter

Returns:

the default properties for the converter.

See Also:

SBMLConverter.setProperties(ConversionProperties props), SBMLLevelVersionConverter.matchesProperties(ConversionProperties props)

getTargetLevel

public long getTargetLevel()

Returns the target SBML Level for the conversion.

Returns:

an integer indicating the SBML Level.

getTargetVersion

public long getTargetVersion()

Returns the target SBML Version for the conversion.

Returns:

an integer indicating the Version within the SBML Level.

getValidityFlag

public boolean getValidityFlag()

Returns the flag indicating whether the conversion has been set to 'strict'.

Returns:

true if strict validity has been requested, false otherwise.

init

public static void init()

matchesProperties

public boolean matchesProperties(ConversionProperties props)

Predicate returning true if this converter's properties matches a given set of configuration properties.

Overrides:

matchesProperties in class SBMLConverter

Parameters:

props - the configuration properties to match.

Returns:

true if this converter's properties match, false otherwise.