org.sbml.jsbml.ext.render

Class ColorDefinition

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.AbstractNamedSBase

org.sbml.jsbml.ext.render.ColorDefinition

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, javax.swing.tree.TreeNode, NamedSBase, SBase, TreeNodeWithChangeSupport

public class ColorDefinition
extends AbstractNamedSBase

Since:

1.0

Version:

$Rev: 1737 $

Author:

Eugen Netz, Alexander Diamantikos, Jakob Matthes, Jan Rudolph

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static long	serialVersionUID Generated serial version identifier
private java.awt.Color	value

Fields inherited from class org.sbml.jsbml.AbstractSBase

ignoredExtensions, ignoredXMLElements

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, UNKNOWN_ATTRIBUTES, UNKNOWN_ELEMENTS

Constructor Summary

Constructors

Constructor and Description
ColorDefinition() Creates an ColorDefinition instance
ColorDefinition(ColorDefinition obj) Clone constructor
ColorDefinition(int level, int version) Creates a ColorDefinition instance with a level and version.
ColorDefinition(java.lang.String id) Creates a ColorDefinition instance with an id.
ColorDefinition(java.lang.String id, java.awt.Color value) Creates a ColorDefinition instance with an id.
ColorDefinition(java.lang.String id, int level, int version) Creates a ColorDefinition instance with an id, level, and version.
ColorDefinition(java.lang.String id, java.lang.String name, int level, int version) Creates a ColorDefinition instance with an id, name, level, and version.

Method Summary

Methods

Modifier and Type	Method and Description
ColorDefinition	clone() Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.
boolean	equals(java.lang.Object obj) Returns true if and only if the given SBase has exactly the same properties like this SBase instance.
java.awt.Color	getValue()
int	hashCode() Returns a hash code value for this SBase instance.
void	initDefaults() Initializes the default values using the namespace.
boolean	isIdMandatory() This method can be used to query if the identifier of this NamedSBase is required to be defined (i.e., not null) in the definition of SBML.
boolean	isSetValue()
boolean	readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value) Sets the given attribute in this SBase.
void	setValue(java.awt.Color value) Set the value of value
boolean	unsetValue() Unsets the variable value
java.util.Map<java.lang.String,java.lang.String>	writeXMLAttributes() Returns a map with all the attributes of this SBase that need to be written out in XML.

Methods inherited from class org.sbml.jsbml.AbstractNamedSBase

getId, getName, isSetId, isSetName, isValidId, setId, setName, toString, unsetId, unsetName

Methods inherited from class org.sbml.jsbml.AbstractSBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendNotes, appendNotes, checkLevelAndVersionCompatibility, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAllowsChildren, getAnnotation, getAnnotationString, getChildAt, getChildCount, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getIdManager, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getParent, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, isValidLevelAndVersionCombination, isValidMetaId, notifyChildChange, registerChild, removeCVTerm, removeCVTerm, setAnnotation, setHistory, setLevel, setMetaId, setNamespace, setNotes, setNotes, setParentSBML, setParentSBMLObject, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetMetaId, unsetNamespace, unsetNotes, unsetPlugin, unsetSBOTerm

Methods inherited from class org.sbml.jsbml.AbstractTreeNode

addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, children, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, getIndex, getListOfTreeNodeChangeListeners, getNumChildren, getRoot, getTreeNodeChangeListenerCount, getUserObject, indexOf, isLeaf, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, userObjectKeySet

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.sbml.jsbml.SBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendNotes, appendNotes, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, registerChild, removeCVTerm, removeCVTerm, removeTreeNodeChangeListener, setAnnotation, setHistory, setLevel, setMetaId, setNotes, setNotes, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetMetaId, unsetNotes, unsetPlugin, unsetSBOTerm

Methods inherited from interface org.sbml.jsbml.util.TreeNodeWithChangeSupport

addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, fireNodeRemovedEvent, firePropertyChange, getListOfTreeNodeChangeListeners, getRoot, getTreeNodeChangeListenerCount, getUserObject, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeUserObject, userObjectKeySet

Methods inherited from interface javax.swing.tree.TreeNode

children, getAllowsChildren, getChildAt, getChildCount, getIndex, getParent, isLeaf

Field Detail

serialVersionUID

private static final long serialVersionUID

Generated serial version identifier

See Also:

Constant Field Values

value

private java.awt.Color value

Constructor Detail

ColorDefinition

public ColorDefinition()

Creates an ColorDefinition instance

ColorDefinition

public ColorDefinition(java.lang.String id)

Creates a ColorDefinition instance with an id.

Parameters:

id -

ColorDefinition

public ColorDefinition(java.lang.String id,
               java.awt.Color value)

Creates a ColorDefinition instance with an id.

Parameters:

id -

ColorDefinition

public ColorDefinition(int level,
               int version)

Creates a ColorDefinition instance with a level and version.

Parameters:

level -

version -

ColorDefinition

public ColorDefinition(java.lang.String id,
               int level,
               int version)

Creates a ColorDefinition instance with an id, level, and version.

Parameters:

id -

level -

version -

ColorDefinition

public ColorDefinition(java.lang.String id,
               java.lang.String name,
               int level,
               int version)

Creates a ColorDefinition instance with an id, name, level, and version.

Parameters:

id -

name -

level -

version -

ColorDefinition

public ColorDefinition(ColorDefinition obj)

Clone constructor

Method Detail

clone

public ColorDefinition clone()

Description copied from interface: SBase

Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.

Specified by:

clone in interface SBase

Specified by:

clone in class AbstractSBase

Returns:

a copy of this object

initDefaults

public void initDefaults()

Initializes the default values using the namespace.

hashCode

public int hashCode()

Description copied from interface: SBase

Returns a hash code value for this SBase instance.

Specified by:

hashCode in interface SBase

Overrides:

hashCode in class AbstractNamedSBase

Returns:

a hash code value for this SBase instance.

See Also:

Object.hashCode()

equals

public boolean equals(java.lang.Object obj)

Description copied from interface: SBase

Returns true if and only if the given SBase has exactly the same properties like this SBase instance.

Specified by:

equals in interface SBase

Overrides:

equals in class AbstractNamedSBase

Parameters:

obj - the SBase to be compared to.

Returns:

true if and only if the given Object is an instance of SBase that has exactly the same properties like this SBase instance.

isIdMandatory

public boolean isIdMandatory()

Description copied from interface: NamedSBase

This method can be used to query if the identifier of this NamedSBase is required to be defined (i.e., not null) in the definition of SBML.

Returns:

true if the identifier of this element must be set in order to create a valid SBML representation. false otherwise, i.e., if the identifier can be understood as an optional attribute.

getValue

public java.awt.Color getValue()

Returns:

the value of value

isSetValue

public boolean isSetValue()

Returns:

whether value is set

setValue

public void setValue(java.awt.Color value)

Set the value of value

unsetValue

public boolean unsetValue()

Unsets the variable value

Returns:

true, if value was set before, otherwise false

writeXMLAttributes

public java.util.Map<java.lang.String,java.lang.String> writeXMLAttributes()

Description copied from interface: SBase

Returns a map with all the attributes of this SBase that need to be written out in XML.

The attribute name is used as a key and the attribute value as value. If a prefix is needed for the attribute name, it need to be set directly in this map.

Specified by:

writeXMLAttributes in interface SBase

Overrides:

writeXMLAttributes in class AbstractNamedSBase

Returns:

a Map containing the XML attributes of this object.

readAttribute

public boolean readAttribute(java.lang.String attributeName,
                    java.lang.String prefix,
                    java.lang.String value)

Description copied from interface: SBase

Sets the given attribute in this SBase.

If the given attribute name is not recognized, nothing is done and false is returned.

Specified by:

readAttribute in interface SBase

Overrides:

readAttribute in class AbstractNamedSBase

Parameters:

attributeName - localName of the XML attribute

prefix - prefix of the XML attribute

value - value of the XML attribute

Returns:

true if the attribute has been successfully read.