org.sbml.libsbml

Class GlobalRenderInformation

java.lang.Object

org.sbml.libsbml.SBase

org.sbml.libsbml.RenderInformationBase

org.sbml.libsbml.GlobalRenderInformation

public class GlobalRenderInformation
extends RenderInformationBase

render Render information stored in a ListOfLayouts.

GlobalRenderInformation is one of the subclasses of RenderInformationBase. A global render information object contains color definitions, gradient definitions and line endings as defined in RenderInformationBase. Additionally it has a list of global styles which specifies type and role based render information. This class of objects cannot specify id-based render information because it does not belong to a certain layout but it belongs to all layouts. GlobalRenderInformation can be applied to all layouts.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int	addGlobalStyle(GlobalStyle gs) Adds a copy of the given GlobalStyle to this GlobalRenderInformation.
int	addStyle(GlobalStyle gs) Adds a copy of the given GlobalStyle to this GlobalRenderInformation.
GlobalRenderInformation	cloneObject() Creates and returns a deep copy of this GlobalRenderInformation object.
GlobalStyle	createGlobalStyle() Creates a new GlobalStyle object, adds it to this GlobalRenderInformation object and returns the GlobalStyle object created.
GlobalStyle	createStyle(java.lang.String id) Creates a new GlobalStyle object with the given id, adds it to this GlobalRenderInformation object and returns the GlobalStyle 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 GlobalRenderInformation object.
GlobalStyle	getGlobalStyle(long n) Get a GlobalStyle from the GlobalRenderInformation.
GlobalStyle	getGlobalStyle(java.lang.String id) Get a GlobalStyle from the GlobalRenderInformation.
ListOfGlobalStyles	getListOfGlobalStyles() Returns the ListOfGlobalStyles from this GlobalRenderInformation.
ListOfGlobalStyles	getListOfStyles() Returns the ListOfGlobalStyles from this GlobalRenderInformation.
long	getNumGlobalStyles() Get the number of GlobalStyle objects in this GlobalRenderInformation.
long	getNumStyles() Get the number of GlobalStyle objects in this GlobalRenderInformation.
GlobalStyle	getStyle(long n) Get a GlobalStyle from the GlobalRenderInformation.
GlobalStyle	getStyle(java.lang.String id) Get a GlobalStyle from the GlobalRenderInformation.
int	getTypeCode() Returns the libSBML type code for this GlobalRenderInformation object.
void	parseXML(XMLNode node) Parses the xml information in the given node and sets the attributes.
GlobalStyle	removeGlobalStyle(long n) Removes the nth GlobalStyle from this GlobalRenderInformation and returns a pointer to it.
GlobalStyle	removeGlobalStyle(java.lang.String sid) Removes the GlobalStyle with the given id from this GlobalRenderInformation and returns a pointer to it.
GlobalStyle	removeStyle(long n) Removes the nth GlobalStyle from this GlobalRenderInformation and returns a pointer to it.
XMLNode	toXML() Creates an XMLNode object from this GlobalRenderInformation 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

GlobalRenderInformation

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

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

Parameters:

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

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

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

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.

GlobalRenderInformation

public GlobalRenderInformation(long level,
                               long version)
                        throws SBMLConstructorException

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

Parameters:

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

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

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

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.

GlobalRenderInformation

public GlobalRenderInformation(long level)
                        throws SBMLConstructorException

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

Parameters:

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

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

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

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.

GlobalRenderInformation

public GlobalRenderInformation()
                        throws SBMLConstructorException

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

Parameters:

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

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

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

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.

GlobalRenderInformation

public GlobalRenderInformation(RenderPkgNamespaces renderns)
                        throws SBMLConstructorException

Creates a new GlobalRenderInformation 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.

GlobalRenderInformation

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

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

Parameters:

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

id - the new id for the GlobalRenderInformation.

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.

GlobalRenderInformation

public GlobalRenderInformation(GlobalRenderInformation orig)
                        throws SBMLConstructorException

Copy constructor for GlobalRenderInformation.

Parameters:

orig - the GlobalRenderInformation 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 GlobalRenderInformation.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 GlobalRenderInformation.delete() themselves.

Overrides:

delete in class RenderInformationBase

cloneObject

public GlobalRenderInformation cloneObject()

Creates and returns a deep copy of this GlobalRenderInformation object.

Overrides:

cloneObject in class RenderInformationBase

Returns:

a (deep) copy of this GlobalRenderInformation object.

getListOfGlobalStyles

public ListOfGlobalStyles getListOfGlobalStyles()

Returns the ListOfGlobalStyles from this GlobalRenderInformation.

Returns:

the ListOfGlobalStyles from this GlobalRenderInformation.

See Also:

GlobalRenderInformation.addGlobalStyle(GlobalStyle object), GlobalRenderInformation.createGlobalStyle(), GlobalRenderInformation.getGlobalStyle(String sid), GlobalRenderInformation.getGlobalStyle(long n), GlobalRenderInformation.getNumGlobalStyles(), GlobalRenderInformation.removeGlobalStyle(String sid), GlobalRenderInformation.removeGlobalStyle(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 ListOfGlobalStyles getListOfStyles()

Returns the ListOfGlobalStyles from this GlobalRenderInformation.

Returns:

the ListOfGlobalStyles from this GlobalRenderInformation.

See Also:

GlobalRenderInformation.addStyle(GlobalStyle object), #createStyle(), GlobalRenderInformation.getStyle(String sid), GlobalRenderInformation.getStyle(long n), GlobalRenderInformation.getNumStyles(), GlobalRenderInformation.removeGlobalStyle(String sid), GlobalRenderInformation.removeGlobalStyle(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.

getGlobalStyle

public GlobalStyle getGlobalStyle(long n)

Get a GlobalStyle from the GlobalRenderInformation.

Parameters:

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

Returns:

the nth GlobalStyle in the ListOfGlobalStyles within this GlobalRenderInformation or null if no such object exists.

See Also:

GlobalRenderInformation.addGlobalStyle(GlobalStyle object), GlobalRenderInformation.createGlobalStyle(), GlobalRenderInformation.getGlobalStyle(String sid), GlobalRenderInformation.getNumGlobalStyles(), GlobalRenderInformation.removeGlobalStyle(String sid), GlobalRenderInformation.removeGlobalStyle(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 GlobalStyle getStyle(long n)

Get a GlobalStyle from the GlobalRenderInformation.

Parameters:

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

Returns:

the nth GlobalStyle in the ListOfGlobalStyles within this GlobalRenderInformation or null if no such object exists.

See Also:

GlobalRenderInformation.addStyle(GlobalStyle object), #createStyle(), GlobalRenderInformation.getStyle(String sid), GlobalRenderInformation.getNumStyles(), GlobalRenderInformation.removeGlobalStyle(String sid), GlobalRenderInformation.removeGlobalStyle(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.

getGlobalStyle

public GlobalStyle getGlobalStyle(java.lang.String id)

Get a GlobalStyle from the GlobalRenderInformation.

Parameters:

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

Returns:

the GlobalStyle in this GlobalRenderInformation based on the identifier or null if no such GlobalStyle exists.

See Also:

GlobalRenderInformation.addGlobalStyle(GlobalStyle object), GlobalRenderInformation.createGlobalStyle(), GlobalRenderInformation.getGlobalStyle(String sid), GlobalRenderInformation.getNumGlobalStyles(), GlobalRenderInformation.removeGlobalStyle(String sid), GlobalRenderInformation.removeGlobalStyle(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.

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.

getStyle

public GlobalStyle getStyle(java.lang.String id)

Get a GlobalStyle from the GlobalRenderInformation.

Parameters:

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

Returns:

the GlobalStyle in this GlobalRenderInformation based on the identifier or null if no such GlobalStyle exists.

See Also:

GlobalRenderInformation.addStyle(GlobalStyle object), #createStyle(), GlobalRenderInformation.getStyle(String sid), GlobalRenderInformation.getNumStyles(), GlobalRenderInformation.removeGlobalStyle(String sid), GlobalRenderInformation.removeGlobalStyle(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.

addGlobalStyle

public int addGlobalStyle(GlobalStyle gs)

Adds a copy of the given GlobalStyle to this GlobalRenderInformation.

Parameters:

gs - the GlobalStyle 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:

GlobalRenderInformation.createGlobalStyle(), GlobalRenderInformation.getGlobalStyle(String sid), GlobalRenderInformation.getGlobalStyle(long n), GlobalRenderInformation.getNumGlobalStyles(), GlobalRenderInformation.removeGlobalStyle(String sid), GlobalRenderInformation.removeGlobalStyle(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(GlobalStyle gs)

Adds a copy of the given GlobalStyle to this GlobalRenderInformation.

Parameters:

gs - the GlobalStyle 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:

#createStyle(), GlobalRenderInformation.getStyle(String sid), GlobalRenderInformation.getStyle(long n), GlobalRenderInformation.getNumStyles(), GlobalRenderInformation.removeGlobalStyle(String sid), GlobalRenderInformation.removeGlobalStyle(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.

getNumGlobalStyles

public long getNumGlobalStyles()

Get the number of GlobalStyle objects in this GlobalRenderInformation.

Returns:

the number of GlobalStyle objects in this GlobalRenderInformation.

See Also:

GlobalRenderInformation.addGlobalStyle(GlobalStyle object), GlobalRenderInformation.createGlobalStyle(), GlobalRenderInformation.getGlobalStyle(String sid), GlobalRenderInformation.getGlobalStyle(long n), GlobalRenderInformation.removeGlobalStyle(String sid), GlobalRenderInformation.removeGlobalStyle(long n)

getNumStyles

public long getNumStyles()

Get the number of GlobalStyle objects in this GlobalRenderInformation.

Returns:

the number of GlobalStyle objects in this GlobalRenderInformation.

See Also:

GlobalRenderInformation.addStyle(GlobalStyle object), #createStyle(), GlobalRenderInformation.getStyle(String sid), GlobalRenderInformation.getStyle(long n), GlobalRenderInformation.removeGlobalStyle(String sid), GlobalRenderInformation.removeGlobalStyle(long n)

createGlobalStyle

public GlobalStyle createGlobalStyle()

Creates a new GlobalStyle object, adds it to this GlobalRenderInformation object and returns the GlobalStyle object created.

Returns:

a new GlobalStyle object instance.

See Also:

GlobalRenderInformation.addGlobalStyle(GlobalStyle object), GlobalRenderInformation.getGlobalStyle(String sid), GlobalRenderInformation.getGlobalStyle(long n), GlobalRenderInformation.getNumGlobalStyles(), GlobalRenderInformation.removeGlobalStyle(String sid), GlobalRenderInformation.removeGlobalStyle(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.

createStyle

public GlobalStyle createStyle(java.lang.String id)

Creates a new GlobalStyle object with the given id, adds it to this GlobalRenderInformation object and returns the GlobalStyle object created.

Returns:

a new GlobalStyle object instance.

See Also:

GlobalRenderInformation.addStyle(GlobalStyle object), GlobalRenderInformation.getStyle(String sid), GlobalRenderInformation.getStyle(long n), GlobalRenderInformation.getNumStyles(), GlobalRenderInformation.removeGlobalStyle(String sid), GlobalRenderInformation.removeGlobalStyle(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.

removeGlobalStyle

public GlobalStyle removeGlobalStyle(long n)

Removes the nth GlobalStyle from this GlobalRenderInformation and returns a pointer to it.

Parameters:

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

Returns:

a pointer to the nth GlobalStyle in this GlobalRenderInformation.

See Also:

GlobalRenderInformation.addGlobalStyle(GlobalStyle object), GlobalRenderInformation.createGlobalStyle(), GlobalRenderInformation.getGlobalStyle(String sid), GlobalRenderInformation.getGlobalStyle(long n), GlobalRenderInformation.getNumGlobalStyles(), GlobalRenderInformation.removeGlobalStyle(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.

removeGlobalStyle

public GlobalStyle removeGlobalStyle(java.lang.String sid)

Removes the GlobalStyle with the given id from this GlobalRenderInformation and returns a pointer to it.

Parameters:

sid - the id of the GlobalStyle to remove.

Returns:

a pointer to the nth GlobalStyle in this GlobalRenderInformation.

See Also:

GlobalRenderInformation.addGlobalStyle(GlobalStyle object), GlobalRenderInformation.createGlobalStyle(), GlobalRenderInformation.getGlobalStyle(String sid), GlobalRenderInformation.getGlobalStyle(long n), GlobalRenderInformation.getNumGlobalStyles(), GlobalRenderInformation.removeGlobalStyle(long n)

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 GlobalStyle removeStyle(long n)

Removes the nth GlobalStyle from this GlobalRenderInformation and returns a pointer to it.

Parameters:

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

Returns:

a pointer to the nth GlobalStyle in this GlobalRenderInformation.

See Also:

GlobalRenderInformation.addStyle(GlobalStyle object), #createStyle(), GlobalRenderInformation.getStyle(String sid), GlobalRenderInformation.getStyle(long n), GlobalRenderInformation.getNumStyles(), GlobalRenderInformation.removeGlobalStyle(long n), GlobalRenderInformation.removeGlobalStyle(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 GlobalRenderInformation object.

For GlobalRenderInformation, 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 GlobalRenderInformation 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_GLOBALRENDERINFORMATION.

See Also:

GlobalRenderInformation.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 GlobalRenderInformation object to be instantiated.

toXML

public XMLNode toXML()

Creates an XMLNode object from this GlobalRenderInformation object.

Returns:

the XMLNode with the XML representation for the GlobalRenderInformation object.