public class ListOfLocalStyles extends ListOf
ListOfLocalStyles
is the container class that stores LocalStyles in LocalRenderInformation
objects.
Each LocalRenderInformation
object contains a ListOfLocalStyles
which contains zero or
more local style objects.
Constructor and Description |
---|
ListOfLocalStyles()
Constructor which instantiates an empty
ListOfLocalStyles object. |
ListOfLocalStyles(ListOfLocalStyles source)
Copy constructor for
ListOfLocalStyles objects. |
ListOfLocalStyles(long level)
Constructor which instantiates an empty
ListOfLocalStyles object. |
ListOfLocalStyles(long level,
long version)
Constructor which instantiates an empty
ListOfLocalStyles object. |
ListOfLocalStyles(long level,
long version,
long pkgVersion)
Constructor which instantiates an empty
ListOfLocalStyles object. |
ListOfLocalStyles(RenderPkgNamespaces renderns)
Ctor.
|
ListOfLocalStyles(XMLNode node)
Creates a new
ListOfLocalStyles object from the given XMLNode object. |
Modifier and Type | Method and Description |
---|---|
ListOfLocalStyles |
cloneObject()
Creates and returns a deep copy of the
ListOfLocalStyles object. |
void |
delete()
Explicitly deletes the underlying native object.
|
LocalStyle |
get(long i)
Returns a pointer to the
LocalStyle with the given index or null if
the index is invalid. |
LocalStyle |
get(java.lang.String id)
|
java.lang.String |
getElementName()
Returns the XML element name of this object, which for
ListOfLocalStyles , is always 'listOfLocalStyles'. |
int |
getItemTypeCode()
Returns the libSBML type code for this SBML object.
|
int |
getTypeCode()
Returns the libSBML type code for the objects contained in this
ListOf
(i.e., GradientDefinition objects, if the list is non-empty). |
LocalStyle |
remove(long n)
Removes the nth item from this
ListOfLocalStyles items and returns a pointer to
it. |
LocalStyle |
remove(java.lang.String sid)
Removes item in this
ListOfLocalStyles items with the given identifier. |
XMLNode |
toXML()
Creates an
XMLNode object from this ListOfLocalStyles object. |
append, appendAndOwn, appendFrom, clear, clear, connectToChild, getElementByMetaId, getElementBySId, insert, insertAndOwn, removeFromParentAndDelete, size
addCVTerm, addCVTerm, appendAnnotation, appendAnnotation, appendNotes, appendNotes, deleteDisabledPlugins, deleteDisabledPlugins, disablePackage, enablePackage, equals, getAncestorOfType, getAncestorOfType, getAnnotation, getAnnotationString, getColumn, getCVTerm, getCVTerms, getDisabledPlugin, getId, getIdAttribute, getLevel, getLine, getListOfAllElements, getListOfAllElements, getListOfAllElementsFromPlugins, getListOfAllElementsFromPlugins, getMetaId, getModel, getModelHistory, getName, 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, isSetId, isSetIdAttribute, isSetMetaId, isSetModelHistory, isSetName, isSetNotes, isSetSBOTerm, isSetUserData, matchesRequiredSBMLNamespacesForAddition, matchesSBMLNamespaces, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, renameMetaIdRefs, renameSIdRefs, renameUnitSIdRefs, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setId, setIdAttribute, setMetaId, setModelHistory, setName, setNamespaces, setNotes, setNotes, setNotes, setSBOTerm, setSBOTerm, toSBML, toXMLNode, unsetAnnotation, unsetCVTerms, unsetId, unsetIdAttribute, unsetMetaId, unsetModelHistory, unsetName, unsetNotes, unsetSBOTerm, unsetUserData
public ListOfLocalStyles(XMLNode node) throws SBMLConstructorException
ListOfLocalStyles
object from the given XMLNode
object.
The XMLNode
object has to contain a valid XML representation of a
ListOfLocalStyles
object as defined in the render extension specification.
This method is normally called when render information is read from a file and
should normally not have to be called explicitly.
node
- the XMLNode
object reference that describes the ListOfLocalStyles
object to be instantiated.SBMLConstructorException
public ListOfLocalStyles(long level, long version, long pkgVersion) throws SBMLConstructorException
ListOfLocalStyles
object.SBMLConstructorException
public ListOfLocalStyles(long level, long version) throws SBMLConstructorException
ListOfLocalStyles
object.SBMLConstructorException
public ListOfLocalStyles(long level) throws SBMLConstructorException
ListOfLocalStyles
object.SBMLConstructorException
public ListOfLocalStyles() throws SBMLConstructorException
ListOfLocalStyles
object.SBMLConstructorException
public ListOfLocalStyles(RenderPkgNamespaces renderns) throws SBMLConstructorException
SBMLConstructorException
public ListOfLocalStyles(ListOfLocalStyles source) throws SBMLConstructorException
ListOfLocalStyles
objects.SBMLConstructorException
public void delete()
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 ListOfLocalStyles.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 ListOfLocalStyles.delete()
themselves.
public ListOfLocalStyles cloneObject()
ListOfLocalStyles
object.
cloneObject
 in class ListOf
ListOfLocalStyles
public int getTypeCode()
ListOf
(i.e., GradientDefinition objects, if the list is non-empty).
LibSBML attaches an
identifying code to every kind of SBML object. These are known as
SBML type codes. In other languages, the set of type codes
is stored in an enumeration in the Java language interface for
libSBML, the type codes are defined as static integer constants in
interface class libsbmlConstants
. The names of the type codes
all begin with the characters SBML_.
getTypeCode
 in class ListOf
ListOf
instance, or SBML_UNKNOWN
(default).
ListOfLocalStyles.getElementName()
public java.lang.String getElementName()
ListOfLocalStyles
, is always 'listOfLocalStyles'.
getElementName
 in class ListOf
'listOfLocalStyles'.
public XMLNode toXML()
XMLNode
object from this ListOfLocalStyles
object.
XMLNode
with the XML representation for the
ListOfLocalStyles
object.public LocalStyle get(long i)
LocalStyle
with the given index or null if
the index is invalid.
get
 in class ListOf
i
- index of the LocalStyle
object to be returned
LocalStyle
at the given index or null.ListOf.size()
public LocalStyle get(java.lang.String id)
id
- id of the LocalStyle
object to be returned
LocalStyle
at the given id
or null.
public LocalStyle remove(long n)
ListOfLocalStyles
items and returns a pointer to
it.
The caller owns the returned item and is responsible for deleting it.
remove
 in class ListOf
n
- the index of the item to remove
ListOf.size()
public LocalStyle remove(java.lang.String sid)
ListOfLocalStyles
items with the given identifier.
The caller owns the returned item and is responsible for deleting it.
If none of the items in this list have the identifier sid
, then @c
null is returned.
sid
- the identifier of the item to remove
public int getItemTypeCode()
LibSBML attaches an
identifying code to every kind of SBML object. These are known as
SBML type codes. In other languages, the set of type codes
is stored in an enumeration in the Java language interface for
libSBML, the type codes are defined as static integer constants in
interface class libsbmlConstants
. The names of the type codes
all begin with the characters SBML_.
getItemTypeCode
 in class ListOf
SBML_UNKNOWN
(default).
ListOfLocalStyles.getElementName()