public class DefaultTerm extends SBase
Transition
.
The DefaultTerm
defines the default result of a Transition
, held in the
(required) 'resultLevel' attribute. This term is
used when there are no other FunctionTerm
elements or when none of the Math
elements of the FunctionTerm
elements evaluate to true.
Constructor and Description |
---|
DefaultTerm()
Creates a new
DefaultTerm with the given level, version, and package version. |
DefaultTerm(DefaultTerm orig)
Copy constructor for
DefaultTerm . |
DefaultTerm(long level)
Creates a new
DefaultTerm with the given level, version, and package version. |
DefaultTerm(long level,
long version)
Creates a new
DefaultTerm with the given level, version, and package version. |
DefaultTerm(long level,
long version,
long pkgVersion)
Creates a new
DefaultTerm with the given level, version, and package version. |
DefaultTerm(QualPkgNamespaces qualns)
Creates a new
DefaultTerm with the given QualPkgNamespaces object. |
Modifier and Type | Method and Description |
---|---|
DefaultTerm |
cloneObject()
Creates and returns a deep copy of this
DefaultTerm object. |
void |
delete()
Explicitly deletes the underlying native object.
|
java.lang.String |
getElementName()
Returns the XML name of this object.
|
int |
getResultLevel()
Returns the value of the 'resultLevel' attribute of this
DefaultTerm . |
int |
getTypeCode()
Returns the libSBML type code of this object instance.
|
boolean |
hasRequiredAttributes()
Predicate returning
true if all the required attributes
for this DefaultTerm object have been set. |
boolean |
isSetResultLevel()
Predicate returning
true or false depending on whether this
DefaultTerm 's 'resultLevel' attribute has been set. |
int |
setResultLevel(int resultLevel)
Sets the value of the 'resultLevel' attribute of this
DefaultTerm . |
int |
unsetResultLevel()
Unsets the value of the 'resultLevel' attribute of this
DefaultTerm . |
addCVTerm, addCVTerm, appendAnnotation, appendAnnotation, appendNotes, appendNotes, connectToChild, deleteDisabledPlugins, deleteDisabledPlugins, disablePackage, enablePackage, equals, getAncestorOfType, getAncestorOfType, getAnnotation, getAnnotationString, getColumn, getCVTerm, getCVTerms, getDisabledPlugin, getElementByMetaId, getElementBySId, getId, getIdAttribute, getLevel, getLine, getListOfAllElements, getListOfAllElements, getListOfAllElementsFromPlugins, getListOfAllElementsFromPlugins, getMetaId, getModel, getModelHistory, getName, getNamespaces, getNotes, getNotesString, getNumCVTerms, getNumDisabledPlugins, getNumPlugins, getObjectVersion, 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, removeFromParentAndDelete, 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 DefaultTerm(long level, long version, long pkgVersion) throws SBMLConstructorException
DefaultTerm
with the given level, version, and package version.
level
- a long integer, the SBML Level to assign to this DefaultTerm
.
version
- a long integer, the SBML Version to assign to this DefaultTerm
.
pkgVersion
- a long integer, the SBML Qual Version to assign to this DefaultTerm
.
SBMLConstructorException
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.public DefaultTerm(long level, long version) throws SBMLConstructorException
DefaultTerm
with the given level, version, and package version.
level
- a long integer, the SBML Level to assign to this DefaultTerm
.
version
- a long integer, the SBML Version to assign to this DefaultTerm
.
pkgVersion
- a long integer, the SBML Qual Version to assign to this DefaultTerm
.
SBMLConstructorException
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.public DefaultTerm(long level) throws SBMLConstructorException
DefaultTerm
with the given level, version, and package version.
level
- a long integer, the SBML Level to assign to this DefaultTerm
.
version
- a long integer, the SBML Version to assign to this DefaultTerm
.
pkgVersion
- a long integer, the SBML Qual Version to assign to this DefaultTerm
.
SBMLConstructorException
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.public DefaultTerm() throws SBMLConstructorException
DefaultTerm
with the given level, version, and package version.
level
- a long integer, the SBML Level to assign to this DefaultTerm
.
version
- a long integer, the SBML Version to assign to this DefaultTerm
.
pkgVersion
- a long integer, the SBML Qual Version to assign to this DefaultTerm
.
SBMLConstructorException
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.public DefaultTerm(QualPkgNamespaces qualns) throws SBMLConstructorException
DefaultTerm
with the given QualPkgNamespaces
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.
qualns
- the QualPkgNamespaces
object.
SBMLConstructorException
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.public DefaultTerm(DefaultTerm orig) throws SBMLConstructorException
DefaultTerm
.
orig
- the DefaultTerm
instance to copy.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 DefaultTerm.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 DefaultTerm.delete()
themselves.
public DefaultTerm cloneObject()
DefaultTerm
object.
cloneObject
 in class SBase
DefaultTerm
object.public int getResultLevel()
DefaultTerm
.
DefaultTerm
as a integer.public boolean isSetResultLevel()
true
or false
depending on whether this
DefaultTerm
's 'resultLevel' attribute has been set.
true
if this DefaultTerm
's 'resultLevel' attribute has been set,
otherwise false
is returned.public int setResultLevel(int resultLevel)
DefaultTerm
.
resultLevel
- int value of the 'resultLevel' attribute to be set.
public int unsetResultLevel()
DefaultTerm
.
public java.lang.String getElementName()
getElementName
 in class SBase
public int getTypeCode()
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 getPackageName()
method on the object.
getTypeCode
 in class SBase
SBML_QUAL_DEFAULT_TERM
.
DefaultTerm.getElementName()
,
SBase.getPackageName()
public boolean hasRequiredAttributes()
true
if all the required attributes
for this DefaultTerm
object have been set.
hasRequiredAttributes
 in class SBase
DefaultTerm
object is: