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 converter translates all instances of a given identifier (i.e., SBML object 'id' attribute value) of type 'SId' in a Model to another identifier. It does this based on a list of source identifiers, translating each one to its corresponding replacement value in a list of replacement identifiers. It also updates all references to the identifiers so replaced. (More technically, it replaces all values known as type SIdRef in the SBML Level 3 specifications.)

This converter only searches the global SId namespace for the Model child of the SBMLDocument. It does not replace any IDs or SIdRefs for LocalParameters, nor does it replace any UnitSIds or UnitSIdRefs. It likewise does not replace any IDs in a new namespace introduced by a package, such as the PortSId namespace from the Hierarchical Model Composition package, nor any Model objects that are not the direct child of the SBMLDocument, such as the ModelDefinitions from the Hierarchical Model Composition package.

If, however, a package introduces a new element with an 'id' attribute of type SId, any attribute of type SIdRef, or child of type SIdRef (such as a new Math child of a package element), those IDs will be replaced if they match a source identifier.

Configuration and use of SBMLIdConverter

SBMLIdConverter is enabled by creating a ConversionProperties object with the option 'renameSIds', and passing this properties object to SBMLDocument.convert(ConversionProperties). The converter accepts two options, and both must be set or else no conversion is performed:

• 'currentIds': A comma-separated list of identifiers to replace.
• 'newIds': A comma-separated list of identifiers to use as the replacements. The values should correspond one-to-one with the identifiers in 'currentIds' that should be replaced.

General information about the use of SBML converters

The use of all the converters follows a similar approach. First, one creates a ConversionProperties object and calls ConversionProperties.addOption(ConversionOption) on this object with one arguments: a text string that identifies the desired converter. (The text string is specific to each converter consult the documentation for a given converter to find out how it should be enabled.)

Next, for some converters, the caller can optionally set some converter-specific properties using additional calls to ConversionProperties.addOption(ConversionOption). Many converters provide the ability to configure their behavior to some extent this is realized through the use of properties that offer different options. The default property values for each converter can be interrogated using the method SBMLConverter.getDefaultProperties() on the converter class in question .

Finally, the caller should invoke the method SBMLDocument.convert(ConversionProperties) with the ConversionProperties object as an argument.

Example of invoking an SBML converter

The following code fragment illustrates an example using SBMLReactionConverter, which is invoked using the option string 'replaceReactions':

ConversionProperties props = new ConversionProperties()
if (props != null) {
  props.addOption('replaceReactions')
} else {
  // Deal with error.
}

In the case of SBMLReactionConverter, there are no options to affect its behavior, so the next step is simply to invoke the converter on an SBMLDocument object. Continuing the example code:

  // Assume that the variable 'document' has been set to an SBMLDocument object.
  status = document.convert(config)
  if (status != libsbml.LIBSBML_OPERATION_SUCCESS)
  {
    // Handle error somehow.
    System.out.println('Error: conversion failed due to the following:')
    document.printErrors()
  }

Here is an example of using a converter that offers an option. The following code invokes SBMLStripPackageConverter to remove the SBML Level 3 Layout package from a model. It sets the name of the package to be removed by adding a value for the option named 'package' defined by that converter:

ConversionProperties config = new ConversionProperties()
if (config != None) {
  config.addOption('stripPackage')
  config.addOption('package', 'layout')
  status = document.convert(config)
  if (status != LIBSBML_OPERATION_SUCCESS) {
    // Handle error somehow.
    System.out.println('Error: unable to strip the Layout package')
    document.printErrors()
  }
} else {
  // Handle error somehow.
  System.out.println('Error: unable to create ConversionProperties object')
}

Available SBML converters in libSBML

LibSBML provides a number of built-in converters by convention, their names end in Converter. The following are the built-in converters provided by libSBML 5.12.0 :

• CobraToFbcConverter
• CompFlatteningConverter
• FbcToCobraConverter
• FbcV1ToV2Converter
• FbcV2ToV1Converter
• SBMLFunctionDefinitionConverter
• SBMLIdConverter
• SBMLInferUnitsConverter
• SBMLInitialAssignmentConverter
• SBMLLevel1Version1Converter
• SBMLLevelVersionConverter
• SBMLLocalParameterConverter
• SBMLReactionConverter
• SBMLRuleConverter
• SBMLStripPackageConverter
• SBMLUnitsConverter