org.sbml.libsbml

Class LocalRenderInformation

java.lang.Object

org.sbml.libsbml.SBase

org.sbml.libsbml.RenderInformationBase

org.sbml.libsbml.LocalRenderInformation

public class LocalRenderInformation
extends RenderInformationBase

render Rendering information stored in Layouts.

LocalRenderInformation is one of the subclasses of RenderInformationBase. A 'local rendering information' object contains color definitions, gradient definitions and line endings as defined in RenderInformationBase. Additionally it has a list of local styles which specifies type, role and id based render information. Local render information can specify id based render information because it does belong to a certain layout and it can reference ids of object in that layout.

Constructor Summary

Constructors

Constructor and Description
LocalRenderInformation() Creates a new LocalRenderInformation using the given SBML Level, Version and “render” package version.
LocalRenderInformation(LocalRenderInformation orig) Copy constructor for LocalRenderInformation.
LocalRenderInformation(long level) Creates a new LocalRenderInformation using the given SBML Level, Version and “render” package version.
LocalRenderInformation(long level, long version) Creates a new LocalRenderInformation using the given SBML Level, Version and “render” package version.
LocalRenderInformation(long level, long version, long pkgVersion) Creates a new LocalRenderInformation using the given SBML Level, Version and “render” package version.
LocalRenderInformation(RenderPkgNamespaces renderns) Creates a new LocalRenderInformation using the given RenderPkgNamespaces object.
LocalRenderInformation(RenderPkgNamespaces renderns, java.lang.String id) Constructor which creates a LocalRenderInformation with the given id and all lists empty.

Method Summary

Modifier and Type	Method and Description
int	addLocalStyle(LocalStyle ls) Adds a copy of the given LocalStyle to this LocalRenderInformation.
int	addStyle(LocalStyle ls) Adds a copy of the given LocalStyle to this LocalRenderInformation.
LocalRenderInformation	cloneObject() Creates and returns a deep copy of this LocalRenderInformation object.
LocalStyle	createLocalStyle() Creates a new LocalStyle object, adds it to this LocalRenderInformation object and returns the LocalStyle object created.
void	delete() Explicitly deletes the underlying native object.
SBase	getElementByMetaId(java.lang.String metaid) Returns the first child element that has the given metaid, or null if no such object is found.
SBase	getElementBySId(java.lang.String id) Returns the first child element that has the given id in the model-wide SId namespace, or null if no such object is found.
java.lang.String	getElementName() Returns the XML element name of this LocalRenderInformation object.
ListOfLocalStyles	getListOfLocalStyles() Returns the ListOfLocalStyles from this LocalRenderInformation.
ListOfLocalStyles	getListOfStyles() Returns the ListOfLocalStyles from this LocalRenderInformation.
LocalStyle	getLocalStyle(long n) Get a LocalStyle from the LocalRenderInformation.
LocalStyle	getLocalStyle(java.lang.String id) Returns a pointer to the style with the given id.
long	getNumLocalStyles() Get the number of LocalStyle objects in this LocalRenderInformation.
long	getNumStyles() Get the number of LocalStyle objects in this LocalRenderInformation.
LocalStyle	getStyle(long n) Get a LocalStyle from the LocalRenderInformation.
LocalStyle	getStyle(java.lang.String id) Returns a pointer to the style with the given id.
int	getTypeCode() Returns the libSBML type code for this LocalRenderInformation object.
void	parseXML(XMLNode node) Parses the xml information in the given node and sets the attributes.
LocalStyle	removeLocalStyle(long n) Removes the nth LocalStyle from this LocalRenderInformation and returns a pointer to it.
LocalStyle	removeLocalStyle(java.lang.String id) Removes the LocalStyle from this LocalRenderInformation based on its identifier and returns a pointer to it.
LocalStyle	removeStyle(long n) Removes the nth LocalStyle from this LocalRenderInformation and returns a pointer to it.
LocalStyle	removeStyle(java.lang.String id) Removes the LocalStyle from this LocalRenderInformation based on its identifier and returns a pointer to it.
XMLNode	toXML() Creates an XMLNode object from this LocalRenderInformation object.

Methods inherited from class org.sbml.libsbml.RenderInformationBase

addColorDefinition, addGradientDefinition, addLineEnding, createColorDefinition, createLinearGradientDefinition, createLineEnding, createRadialGradientDefinition, getBackgroundColor, getColorDefinition, getColorDefinition, getGradientDefinition, getGradientDefinition, getId, getLineEnding, getLineEnding, getListOfColorDefinitions, getListOfGradientDefinitions, getListOfLineEndings, getName, getNumColorDefinitions, getNumGradientDefinitions, getNumLineEndings, getProgramName, getProgramVersion, getReferenceRenderInformation, getReferenceRenderInformationId, hasRequiredAttributes, isGlobalRenderInformation, isLocalRenderInformation, isSetBackgroundColor, isSetId, isSetName, isSetProgramName, isSetProgramVersion, isSetReferenceRenderInformation, removeColorDefinition, removeColorDefinition, removeGradientDefinition, removeGradientDefinition, removeLineEnding, removeLineEnding, renameSIdRefs, setBackgroundColor, setId, setName, setProgramName, setProgramVersion, setReferenceRenderInformation, setReferenceRenderInformationId, unsetBackgroundColor, unsetId, unsetName, unsetProgramName, unsetProgramVersion, unsetReferenceRenderInformation

Methods inherited from class org.sbml.libsbml.SBase

addCVTerm, addCVTerm, appendAnnotation, appendAnnotation, appendNotes, appendNotes, connectToChild, deleteDisabledPlugins, deleteDisabledPlugins, disablePackage, enablePackage, equals, getAncestorOfType, getAncestorOfType, getAnnotation, getAnnotationString, getColumn, getCVTerm, getCVTerms, getDisabledPlugin, getIdAttribute, getLevel, getLine, getListOfAllElements, getListOfAllElements, getListOfAllElementsFromPlugins, getListOfAllElementsFromPlugins, getMetaId, getModel, getModelHistory, getNamespaces, getNotes, getNotesString, getNumCVTerms, getNumDisabledPlugins, getNumPlugins, getPackageCoreVersion, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getPlugin, getPrefix, getResourceBiologicalQualifier, getResourceModelQualifier, getSBMLDocument, getSBOTerm, getSBOTermAsURL, getSBOTermID, getURI, getVersion, hashCode, hasValidLevelVersionNamespaceCombination, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetIdAttribute, isSetMetaId, isSetModelHistory, isSetNotes, isSetSBOTerm, isSetUserData, matchesRequiredSBMLNamespacesForAddition, matchesSBMLNamespaces, removeFromParentAndDelete, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, renameMetaIdRefs, renameUnitSIdRefs, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setIdAttribute, setMetaId, setModelHistory, setNamespaces, setNotes, setNotes, setNotes, setSBOTerm, setSBOTerm, toSBML, toXMLNode, unsetAnnotation, unsetCVTerms, unsetIdAttribute, unsetMetaId, unsetModelHistory, unsetNotes, unsetSBOTerm, unsetUserData

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LocalRenderInformation

public LocalRenderInformation(long level,
                              long version,
                              long pkgVersion)
                       throws SBMLConstructorException

Creates a new LocalRenderInformation using the given SBML Level, Version and “render” package version.

Parameters:

level - a long integer, the SBML Level to assign to this LocalRenderInformation.

version - a long integer, the SBML Version to assign to this LocalRenderInformation.

pkgVersion - a long integer, the SBML Render Version to assign to this LocalRenderInformation.

Throws:

SBMLConstructorException

Note:

Attempting to add an object to an SBMLDocument having a different combination of SBML Level, Version and XML namespaces than the object itself will result in an error at the time a caller attempts to make the addition. A parent object must have compatible Level, Version and XML namespaces. (Strictly speaking, a parent may also have more XML namespaces than a child, but the reverse is not permitted.) The restriction is necessary to ensure that an SBML model has a consistent overall structure. This requires callers to manage their objects carefully, but the benefit is increased flexibility in how models can be created by permitting callers to create objects bottom-up if desired. In situations where objects are not yet attached to parents (e.g., SBMLDocument), knowledge of the intented SBML Level and Version help libSBML determine such things as whether it is valid to assign a particular value to an attribute. For packages, this means that the parent object to which this package element is being added must have been created with the package namespace, or that the package namespace was added to it, even if that parent is not a package object itself.

LocalRenderInformation

public LocalRenderInformation(long level,
                              long version)
                       throws SBMLConstructorException

Creates a new LocalRenderInformation using the given SBML Level, Version and “render” package version.

Parameters:

level - a long integer, the SBML Level to assign to this LocalRenderInformation.

version - a long integer, the SBML Version to assign to this LocalRenderInformation.

pkgVersion - a long integer, the SBML Render Version to assign to this LocalRenderInformation.

Throws:

SBMLConstructorException

Note:

Attempting to add an object to an SBMLDocument having a different combination of SBML Level, Version and XML namespaces than the object itself will result in an error at the time a caller attempts to make the addition. A parent object must have compatible Level, Version and XML namespaces. (Strictly speaking, a parent may also have more XML namespaces than a child, but the reverse is not permitted.) The restriction is necessary to ensure that an SBML model has a consistent overall structure. This requires callers to manage their objects carefully, but the benefit is increased flexibility in how models can be created by permitting callers to create objects bottom-up if desired. In situations where objects are not yet attached to parents (e.g., SBMLDocument), knowledge of the intented SBML Level and Version help libSBML determine such things as whether it is valid to assign a particular value to an attribute. For packages, this means that the parent object to which this package element is being added must have been created with the package namespace, or that the package namespace was added to it, even if that parent is not a package object itself.

LocalRenderInformation

public LocalRenderInformation(long level)
                       throws SBMLConstructorException

Creates a new LocalRenderInformation using the given SBML Level, Version and “render” package version.

Parameters:

level - a long integer, the SBML Level to assign to this LocalRenderInformation.

version - a long integer, the SBML Version to assign to this LocalRenderInformation.

pkgVersion - a long integer, the SBML Render Version to assign to this LocalRenderInformation.

Throws:

SBMLConstructorException

Note:

Attempting to add an object to an SBMLDocument having a different combination of SBML Level, Version and XML namespaces than the object itself will result in an error at the time a caller attempts to make the addition. A parent object must have compatible Level, Version and XML namespaces. (Strictly speaking, a parent may also have more XML namespaces than a child, but the reverse is not permitted.) The restriction is necessary to ensure that an SBML model has a consistent overall structure. This requires callers to manage their objects carefully, but the benefit is increased flexibility in how models can be created by permitting callers to create objects bottom-up if desired. In situations where objects are not yet attached to parents (e.g., SBMLDocument), knowledge of the intented SBML Level and Version help libSBML determine such things as whether it is valid to assign a particular value to an attribute. For packages, this means that the parent object to which this package element is being added must have been created with the package namespace, or that the package namespace was added to it, even if that parent is not a package object itself.

LocalRenderInformation

public LocalRenderInformation()
                       throws SBMLConstructorException

Creates a new LocalRenderInformation using the given SBML Level, Version and “render” package version.

Parameters:

level - a long integer, the SBML Level to assign to this LocalRenderInformation.

version - a long integer, the SBML Version to assign to this LocalRenderInformation.

pkgVersion - a long integer, the SBML Render Version to assign to this LocalRenderInformation.

Throws:

SBMLConstructorException

Note:

Attempting to add an object to an SBMLDocument having a different combination of SBML Level, Version and XML namespaces than the object itself will result in an error at the time a caller attempts to make the addition. A parent object must have compatible Level, Version and XML namespaces. (Strictly speaking, a parent may also have more XML namespaces than a child, but the reverse is not permitted.) The restriction is necessary to ensure that an SBML model has a consistent overall structure. This requires callers to manage their objects carefully, but the benefit is increased flexibility in how models can be created by permitting callers to create objects bottom-up if desired. In situations where objects are not yet attached to parents (e.g., SBMLDocument), knowledge of the intented SBML Level and Version help libSBML determine such things as whether it is valid to assign a particular value to an attribute. For packages, this means that the parent object to which this package element is being added must have been created with the package namespace, or that the package namespace was added to it, even if that parent is not a package object itself.

LocalRenderInformation

public LocalRenderInformation(RenderPkgNamespaces renderns)
                       throws SBMLConstructorException

Creates a new LocalRenderInformation using the given RenderPkgNamespaces object.

The package namespaces object used in this constructor is derived from a SBMLNamespaces object, which encapsulates SBML Level/Version/namespaces information. It is used to communicate the SBML Level, Version, and package version and name information used in addition to SBML Level 3 Core. A common approach to using libSBML's SBMLNamespaces facilities is to create an package namespace object somewhere in a program once, then hand that object as needed to object constructors of that package that accept it as and argument, such as this one.

Parameters:

renderns - the RenderPkgNamespaces object.

Throws:

SBMLConstructorException

Note:

Attempting to add an object to an SBMLDocument having a different combination of SBML Level, Version and XML namespaces than the object itself will result in an error at the time a caller attempts to make the addition. A parent object must have compatible Level, Version and XML namespaces. (Strictly speaking, a parent may also have more XML namespaces than a child, but the reverse is not permitted.) The restriction is necessary to ensure that an SBML model has a consistent overall structure. This requires callers to manage their objects carefully, but the benefit is increased flexibility in how models can be created by permitting callers to create objects bottom-up if desired. In situations where objects are not yet attached to parents (e.g., SBMLDocument), knowledge of the intented SBML Level and Version help libSBML determine such things as whether it is valid to assign a particular value to an attribute. For packages, this means that the parent object to which this package element is being added must have been created with the package namespace, or that the package namespace was added to it, even if that parent is not a package object itself.

LocalRenderInformation

public LocalRenderInformation(RenderPkgNamespaces renderns,
                              java.lang.String id)
                       throws SBMLConstructorException

Constructor which creates a LocalRenderInformation with the given id and all lists empty.

Parameters:

renderns - the SBMLNamespaces object for the SBML 'render' package

id - the new id for the LocalRenderInformation.

Throws:

SBMLConstructorException

Warning:

This constructor is deprecated. The new libSBML API uses constructors that either take the SBML Level and Version, or take an SBMLNamespaces object.

LocalRenderInformation

public LocalRenderInformation(LocalRenderInformation orig)
                       throws SBMLConstructorException

Copy constructor for LocalRenderInformation.

Parameters:

orig - the LocalRenderInformation instance to copy.

Throws:

SBMLConstructorException

Method Detail

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 LocalRenderInformation.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 LocalRenderInformation.delete() themselves.

Overrides:

delete in class RenderInformationBase

cloneObject

public LocalRenderInformation cloneObject()

Creates and returns a deep copy of this LocalRenderInformation object.

Overrides:

cloneObject in class RenderInformationBase

Returns:

a (deep) copy of this LocalRenderInformation object.

getListOfLocalStyles

public ListOfLocalStyles getListOfLocalStyles()

Returns the ListOfLocalStyles from this LocalRenderInformation.

Returns:

the ListOfLocalStyles from this LocalRenderInformation.

See Also:

LocalRenderInformation.addLocalStyle(LocalStyle object), LocalRenderInformation.createLocalStyle(), LocalRenderInformation.getLocalStyle(String sid), LocalRenderInformation.getLocalStyle(long n), LocalRenderInformation.getNumLocalStyles(), LocalRenderInformation.removeLocalStyle(String sid), LocalRenderInformation.removeLocalStyle(long n)

Note:

The pointer that is returned by this function is not owned by the caller, but may be queried and modified. Any changes made will be reflected in any resulting SBML document containing the pointer's parent.

getListOfStyles

public ListOfLocalStyles getListOfStyles()

Returns the ListOfLocalStyles from this LocalRenderInformation.

Returns:

the ListOfLocalStyles from this LocalRenderInformation.

See Also:

LocalRenderInformation.addLocalStyle(LocalStyle object), LocalRenderInformation.createLocalStyle(), LocalRenderInformation.getLocalStyle(String sid), LocalRenderInformation.getLocalStyle(long n), LocalRenderInformation.getNumLocalStyles(), LocalRenderInformation.removeLocalStyle(String sid), LocalRenderInformation.removeLocalStyle(long n)

Note:

The pointer that is returned by this function is not owned by the caller, but may be queried and modified. Any changes made will be reflected in any resulting SBML document containing the pointer's parent.

getLocalStyle

public LocalStyle getLocalStyle(long n)

Get a LocalStyle from the LocalRenderInformation.

Parameters:

n - a long integer representing the index of the LocalStyle to retrieve.

Returns:

the nth LocalStyle in the ListOfLocalStyles within this LocalRenderInformation. If the index n is invalid, null is returned.

See Also:

LocalRenderInformation.addLocalStyle(LocalStyle object), LocalRenderInformation.createLocalStyle(), LocalRenderInformation.getLocalStyle(String sid), LocalRenderInformation.getNumLocalStyles(), LocalRenderInformation.removeLocalStyle(String sid), LocalRenderInformation.removeLocalStyle(long n)

Note:

The pointer that is returned by this function is not owned by the caller, but may be queried and modified. Any changes made will be reflected in any resulting SBML document containing the pointer's parent.

getStyle

public LocalStyle getStyle(long n)

Get a LocalStyle from the LocalRenderInformation.

Parameters:

n - a long integer representing the index of the LocalStyle to retrieve.

Returns:

the nth LocalStyle in the ListOfLocalStyles within this LocalRenderInformation. If the index n is invalid, null is returned.

See Also:

LocalRenderInformation.addStyle(LocalStyle object), LocalRenderInformation.createLocalStyle(), LocalRenderInformation.getStyle(String sid), LocalRenderInformation.getNumStyles(), LocalRenderInformation.removeStyle(String sid), LocalRenderInformation.removeStyle(long n)

Note:

The pointer that is returned by this function is not owned by the caller, but may be queried and modified. Any changes made will be reflected in any resulting SBML document containing the pointer's parent.

getLocalStyle

public LocalStyle getLocalStyle(java.lang.String id)

Returns a pointer to the style with the given id. If the id is invalid, null is returned.

Parameters:

id - id of the LocalStyle to be returned.

Returns:

pointer to the style with the given id or null

getStyle

public LocalStyle getStyle(java.lang.String id)

Returns a pointer to the style with the given id. If the id is invalid, null is returned.

Parameters:

id - id of the LocalStyle to be returned.

Returns:

pointer to the style with the given id or null

addLocalStyle

public int addLocalStyle(LocalStyle ls)

Adds a copy of the given LocalStyle to this LocalRenderInformation.

Parameters:

ls - the LocalStyle object to add.

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_OPERATION_FAILED
• LIBSBML_INVALID_OBJECT
• LIBSBML_LEVEL_MISMATCH
• LIBSBML_VERSION_MISMATCH
• LIBSBML_PKG_VERSION_MISMATCH
• LIBSBML_DUPLICATE_OBJECT_ID

See Also:

LocalRenderInformation.createLocalStyle(), LocalRenderInformation.getLocalStyle(String sid), LocalRenderInformation.getLocalStyle(long n), LocalRenderInformation.getNumLocalStyles(), LocalRenderInformation.removeLocalStyle(String sid), LocalRenderInformation.removeLocalStyle(long n)

Note:

This method should be used with some caution. The fact that this method copies the object passed to it means that the caller will be left holding a physically different object instance than the one contained inside this object. Changes made to the original object instance (such as resetting attribute values) will not affect the instance in this object. In addition, the caller should make sure to free the original object if it is no longer being used, or else a memory leak will result. Please see other methods on this class (particularly a corresponding method whose name begins with the word create) for alternatives that do not lead to these issues.

addStyle

public int addStyle(LocalStyle ls)

Adds a copy of the given LocalStyle to this LocalRenderInformation.

Parameters:

ls - the LocalStyle object to add.

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_OPERATION_FAILED
• LIBSBML_INVALID_OBJECT
• LIBSBML_LEVEL_MISMATCH
• LIBSBML_VERSION_MISMATCH
• LIBSBML_PKG_VERSION_MISMATCH
• LIBSBML_DUPLICATE_OBJECT_ID

See Also:

LocalRenderInformation.createLocalStyle(), LocalRenderInformation.getStyle(String sid), LocalRenderInformation.getStyle(long n), LocalRenderInformation.getNumStyles(), LocalRenderInformation.removeStyle(String sid), LocalRenderInformation.removeStyle(long n)

Note:

This method should be used with some caution. The fact that this method copies the object passed to it means that the caller will be left holding a physically different object instance than the one contained inside this object. Changes made to the original object instance (such as resetting attribute values) will not affect the instance in this object. In addition, the caller should make sure to free the original object if it is no longer being used, or else a memory leak will result. Please see other methods on this class (particularly a corresponding method whose name begins with the word create) for alternatives that do not lead to these issues.

getNumLocalStyles

public long getNumLocalStyles()

Get the number of LocalStyle objects in this LocalRenderInformation.

Returns:

the number of LocalStyle objects in this LocalRenderInformation.

See Also:

LocalRenderInformation.addLocalStyle(LocalStyle object), LocalRenderInformation.createLocalStyle(), LocalRenderInformation.getLocalStyle(String sid), LocalRenderInformation.getLocalStyle(long n), LocalRenderInformation.removeLocalStyle(String sid), LocalRenderInformation.removeLocalStyle(long n)

getNumStyles

public long getNumStyles()

Get the number of LocalStyle objects in this LocalRenderInformation.

Returns:

the number of LocalStyle objects in this LocalRenderInformation.

See Also:

LocalRenderInformation.addStyle(LocalStyle object), LocalRenderInformation.createLocalStyle(), LocalRenderInformation.getStyle(String sid), LocalRenderInformation.getStyle(long n), LocalRenderInformation.removeStyle(String sid), LocalRenderInformation.removeStyle(long n)

createLocalStyle

public LocalStyle createLocalStyle()

Creates a new LocalStyle object, adds it to this LocalRenderInformation object and returns the LocalStyle object created.

Returns:

a new LocalStyle object instance.

See Also:

LocalRenderInformation.addLocalStyle(LocalStyle object), LocalRenderInformation.getLocalStyle(String sid), LocalRenderInformation.getLocalStyle(long n), LocalRenderInformation.getNumLocalStyles(), LocalRenderInformation.removeLocalStyle(String sid), LocalRenderInformation.removeLocalStyle(long n)

Note:

The pointer that is returned by this function is not owned by the caller, but may be queried and modified. Any changes made will be reflected in any resulting SBML document containing the pointer's parent.

removeLocalStyle

public LocalStyle removeLocalStyle(long n)

Removes the nth LocalStyle from this LocalRenderInformation and returns a pointer to it.

Parameters:

n - a long integer representing the index of the LocalStyle to remove.

Returns:

a pointer to the nth LocalStyle in this LocalRenderInformation.

See Also:

LocalRenderInformation.addLocalStyle(LocalStyle object), LocalRenderInformation.createLocalStyle(), LocalRenderInformation.getLocalStyle(String sid), LocalRenderInformation.getLocalStyle(long n), LocalRenderInformation.getNumLocalStyles(), LocalRenderInformation.removeLocalStyle(String sid)

Warning:

The pointer that is returned by this function is owned by the caller, who is responsible for deleting it. Any changes made to the element will not be reflected in any resulting SBML document unless the element is added to an SBML Document. Even in this case, the element's deletion is still the responsibility of the caller with two exceptions: if it is used as the 'disownedItem' in the * ListOf#appendAndOwn() or ListOf#insertAndOwn() functions. All other functions in libsbml add a copy of the element, and do not transfer ownership of the pointer.

removeStyle

public LocalStyle removeStyle(long n)

Removes the nth LocalStyle from this LocalRenderInformation and returns a pointer to it.

Parameters:

n - a long integer representing the index of the LocalStyle to remove.

Returns:

a pointer to the nth LocalStyle in this LocalRenderInformation.

See Also:

LocalRenderInformation.addStyle(LocalStyle object), LocalRenderInformation.createLocalStyle(), LocalRenderInformation.getStyle(String sid), LocalRenderInformation.getStyle(long n), LocalRenderInformation.getNumStyles(), LocalRenderInformation.removeStyle(String sid)

Warning:

The pointer that is returned by this function is owned by the caller, who is responsible for deleting it. Any changes made to the element will not be reflected in any resulting SBML document unless the element is added to an SBML Document. Even in this case, the element's deletion is still the responsibility of the caller with two exceptions: if it is used as the 'disownedItem' in the * ListOf#appendAndOwn() or ListOf#insertAndOwn() functions. All other functions in libsbml add a copy of the element, and do not transfer ownership of the pointer.

removeLocalStyle

public LocalStyle removeLocalStyle(java.lang.String id)

Removes the LocalStyle from this LocalRenderInformation based on its identifier and returns a pointer to it.

Parameters:

id - a string representing the identifier of the LocalStyle to remove.

Returns:

the LocalStyle in this LocalRenderInformation based on the identifier or null if no such LocalStyle exists.

See Also:

LocalRenderInformation.addLocalStyle(LocalStyle object), LocalRenderInformation.createLocalStyle(), LocalRenderInformation.getLocalStyle(String sid), LocalRenderInformation.getLocalStyle(long n), LocalRenderInformation.getNumLocalStyles(), LocalRenderInformation.removeLocalStyle(String sid)

Warning:

The pointer that is returned by this function is owned by the caller, who is responsible for deleting it. Any changes made to the element will not be reflected in any resulting SBML document unless the element is added to an SBML Document. Even in this case, the element's deletion is still the responsibility of the caller with two exceptions: if it is used as the 'disownedItem' in the * ListOf#appendAndOwn() or ListOf#insertAndOwn() functions. All other functions in libsbml add a copy of the element, and do not transfer ownership of the pointer.

removeStyle

public LocalStyle removeStyle(java.lang.String id)

Removes the LocalStyle from this LocalRenderInformation based on its identifier and returns a pointer to it.

Parameters:

id - a string representing the identifier of the LocalStyle to remove.

Returns:

the LocalStyle in this LocalRenderInformation based on the identifier or null if no such LocalStyle exists.

See Also:

LocalRenderInformation.addStyle(LocalStyle object), LocalRenderInformation.createLocalStyle(), LocalRenderInformation.getStyle(String sid), LocalRenderInformation.getStyle(long n), LocalRenderInformation.getNumStyles(), LocalRenderInformation.removeStyle(String sid)

Warning:

The pointer that is returned by this function is owned by the caller, who is responsible for deleting it. Any changes made to the element will not be reflected in any resulting SBML document unless the element is added to an SBML Document. Even in this case, the element's deletion is still the responsibility of the caller with two exceptions: if it is used as the 'disownedItem' in the * ListOf#appendAndOwn() or ListOf#insertAndOwn() functions. All other functions in libsbml add a copy of the element, and do not transfer ownership of the pointer.

getElementName

public java.lang.String getElementName()

Returns the XML element name of this LocalRenderInformation object.

For LocalRenderInformation, the XML element name is always 'renderInformation'.

Overrides:

getElementName in class SBase

Returns:

the name of this element, i.e. 'renderInformation'.

getTypeCode

public int getTypeCode()

Returns the libSBML type code for this LocalRenderInformation object.

LibSBML attaches an identifying code to every kind of SBML object. These are integer constants known as SBML type codes. The names of all the codes begin with the characters SBML_. In the Java language interface for libSBML, the type codes are defined as static integer constants in the interface class libsbmlConstants. Note that different Level 3 package plug-ins may use overlapping type codes; to identify the package to which a given object belongs, call the SBase.getPackageName() method on the object.

The exception to this is lists: all SBML-style list elements have the type SBML_LIST_OF, regardless of what package they are from.

Overrides:

getTypeCode in class RenderInformationBase

Returns:

the SBML type code for this object: SBML_RENDER_LOCALRENDERINFORMATION.

See Also:

LocalRenderInformation.getElementName(), SBase.getPackageName()

Warning:

The specific integer values of the possible type codes may be reused by different libSBML plug-ins for SBML Level 3. packages, To fully identify the correct code, it is necessary to invoke both getPackageName() and getTypeCode() (or ListOf.getItemTypeCode()).

getElementBySId

public SBase getElementBySId(java.lang.String id)

Returns the first child element that has the given id in the model-wide SId namespace, or null if no such object is found.

Overrides:

getElementBySId in class RenderInformationBase

Parameters:

id - a string representing the id attribute of the object to retrieve.

Returns:

a pointer to the SBase element with the given id. If no such object is found, this method returns null.

getElementByMetaId

public SBase getElementByMetaId(java.lang.String metaid)

Returns the first child element that has the given metaid, or null if no such object is found.

Overrides:

getElementByMetaId in class RenderInformationBase

Parameters:

metaid - a string representing the metaid attribute of the object to retrieve.

Returns:

a pointer to the SBase element with the given metaid. If no such object is found this method returns null.

parseXML

public void parseXML(XMLNode node)

Parses the xml information in the given node and sets the attributes. This method should never be called by the user. It is only used to read render information from annotations.

Overrides:

parseXML in class RenderInformationBase

Parameters:

node - the XMLNode object reference that describes the LocalRenderInformation object to be instantiated.

toXML

public XMLNode toXML()

Creates an XMLNode object from this LocalRenderInformation object.

Returns:

the XMLNode with the XML representation for the LocalRenderInformation object.