org.sbml.jsbml.ext.render

Class RenderInformationBase

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.AbstractNamedSBase

org.sbml.jsbml.ext.render.RenderInformationBase

All Implemented Interfaces:

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

Direct Known Subclasses:

GlobalRenderInformation, LocalRenderInformation

public class RenderInformationBase
extends AbstractNamedSBase
implements UniqueNamedSBase

Since:

1.0

Version:

$Rev: 1722 $

Author:

Eugen Netz, Alexander Diamantikos, Jakob Matthes, Jan Rudolph

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.awt.Color	backgroundColor
protected ListOf<ColorDefinition>	listOfColorDefinitions
protected ListOf<GradientBase>	listOfGradientDefintions
protected ListOf<LineEnding>	listOfLineEndings
protected java.lang.String	programName
protected java.lang.String	programVersion
protected java.lang.String	referenceRenderInformation
private static long	serialVersionUID Generated serial version identifier

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
RenderInformationBase() Creates an RenderInformationBase instance
RenderInformationBase(int level, int version) Creates a RenderInformationBase instance with a level and version.
RenderInformationBase(RenderInformationBase obj) Clone constructor
RenderInformationBase(java.lang.String id) Creates a RenderInformationBase instance with an id.
RenderInformationBase(java.lang.String id, int level, int version) Creates a RenderInformationBase instance with an id, level, and version.
RenderInformationBase(java.lang.String id, java.lang.String name, int level, int version) Creates a RenderInformationBase instance with an id, name, level, and version.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addColorDefinition(ColorDefinition field)
boolean	addGradientBase(GradientBase field)
boolean	addLineEnding(LineEnding lineEnding)
RenderInformationBase	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.
boolean	getAllowsChildren()
java.awt.Color	getBackgroundColor()
SBase	getChildAt(int childIndex)
int	getChildCount()
ListOf<ColorDefinition>	getListOfColorDefinitions()
ListOf<GradientBase>	getListOfGradientDefintions()
ListOf<LineEnding>	getListOfLineEndings()
java.lang.String	getProgramName()
java.lang.String	getProgramVersion()
java.lang.String	getReferenceRenderInformation()
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	isSetBackgroundColor()
boolean	isSetListOfColorDefinitions()
boolean	isSetListOfGradientDefintions()
boolean	isSetListOfLineEndings()
boolean	isSetProgramName()
boolean	isSetProgramVersion()
boolean	isSetReferenceRenderInformation()
boolean	readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value) Sets the given attribute in this SBase.
boolean	removeColorDefinition(ColorDefinition field)
void	removeColorDefinition(int i)
void	removeColorDefinition(java.lang.String id)
boolean	removeGradientBase(GradientBase field)
void	removeGradientBase(int i)
void	removeLineEnding(int i)
boolean	removeLineEnding(LineEnding lineEnding)
void	setBackgroundColor(java.awt.Color backgroundColor) Set the value of backgroundColor
void	setListOfColorDefinitions(ListOf<ColorDefinition> listOfColorDefinitions)
void	setListOfGradientDefintions(ListOf<GradientBase> listOfGradientDefintions)
void	setListOfLineEndings(ListOf<LineEnding> listOfLineEndings)
void	setProgramName(java.lang.String programName) Set the value of programmName
void	setProgramVersion(java.lang.String programVersion) Set the value of programVersion
void	setReferenceRenderInformation(java.lang.String referenceRenderInformation) Set the value of referenceRenderInformation
boolean	unsetBackgroundColor() Unsets the variable backgroundColor
boolean	unsetListOfColorDefinitions()
boolean	unsetListOfGradientDefintions()
boolean	unsetListOfLineEndings()
boolean	unsetProgramName() Unsets the variable programmName
boolean	unsetProgramVersion() Unsets the variable programVersion
boolean	unsetReferenceRenderInformation() Unsets the variable referenceRenderInformation
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, getAnnotation, getAnnotationString, 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.NamedSBase

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

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, getIndex, getParent, isLeaf

Field Detail

serialVersionUID

private static final long serialVersionUID

Generated serial version identifier

See Also:

Constant Field Values

programName

protected java.lang.String programName

programVersion

protected java.lang.String programVersion

referenceRenderInformation

protected java.lang.String referenceRenderInformation

backgroundColor

protected java.awt.Color backgroundColor

listOfColorDefinitions

protected ListOf<ColorDefinition> listOfColorDefinitions

listOfGradientDefintions

protected ListOf<GradientBase> listOfGradientDefintions

listOfLineEndings

protected ListOf<LineEnding> listOfLineEndings

Constructor Detail

RenderInformationBase

public RenderInformationBase()

Creates an RenderInformationBase instance

RenderInformationBase

public RenderInformationBase(java.lang.String id)

Creates a RenderInformationBase instance with an id.

Parameters:

id -

RenderInformationBase

public RenderInformationBase(int level,
                     int version)

Creates a RenderInformationBase instance with a level and version.

Parameters:

level -

version -

RenderInformationBase

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

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

Parameters:

id -

level -

version -

RenderInformationBase

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

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

Parameters:

id -

name -

level -

version -

RenderInformationBase

public RenderInformationBase(RenderInformationBase obj)

Clone constructor

Method Detail

clone

public RenderInformationBase 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.

getProgramName

public java.lang.String getProgramName()

Returns:

the value of programName

isSetProgramName

public boolean isSetProgramName()

Returns:

whether programmName is set

setProgramName

public void setProgramName(java.lang.String programName)

Set the value of programmName

unsetProgramName

public boolean unsetProgramName()

Unsets the variable programmName

Returns:

true, if programmName was set before, otherwise false

getProgramVersion

public java.lang.String getProgramVersion()

Returns:

the value of programVersion

isSetProgramVersion

public boolean isSetProgramVersion()

Returns:

whether programVersion is set

setProgramVersion

public void setProgramVersion(java.lang.String programVersion)

Set the value of programVersion

unsetProgramVersion

public boolean unsetProgramVersion()

Unsets the variable programVersion

Returns:

true, if programVersion was set before, otherwise false

getReferenceRenderInformation

public java.lang.String getReferenceRenderInformation()

Returns:

the value of referenceRenderInformation

isSetReferenceRenderInformation

public boolean isSetReferenceRenderInformation()

Returns:

whether referenceRenderInformation is set

setReferenceRenderInformation

public void setReferenceRenderInformation(java.lang.String referenceRenderInformation)

Set the value of referenceRenderInformation

unsetReferenceRenderInformation

public boolean unsetReferenceRenderInformation()

Unsets the variable referenceRenderInformation

Returns:

true, if referenceRenderInformation was set before, otherwise false

getBackgroundColor

public java.awt.Color getBackgroundColor()

Returns:

the value of backgroundColor

isSetBackgroundColor

public boolean isSetBackgroundColor()

Returns:

whether backgroundColor is set

setBackgroundColor

public void setBackgroundColor(java.awt.Color backgroundColor)

Set the value of backgroundColor

unsetBackgroundColor

public boolean unsetBackgroundColor()

Unsets the variable backgroundColor

Returns:

true, if backgroundColor was set before, otherwise false

isSetListOfColorDefinitions

public boolean isSetListOfColorDefinitions()

Returns:

true, if listOfColorDefinitions contains at least one element, otherwise false

getListOfColorDefinitions

public ListOf<ColorDefinition> getListOfColorDefinitions()

Returns:

the listOfColorDefinitions

setListOfColorDefinitions

public void setListOfColorDefinitions(ListOf<ColorDefinition> listOfColorDefinitions)

Parameters:

listOfColorDefinitions -

unsetListOfColorDefinitions

public boolean unsetListOfColorDefinitions()

Returns:

true, if listOfColorDefinitions contained at least one element, otherwise false

addColorDefinition

public boolean addColorDefinition(ColorDefinition field)

Parameters:

field -

removeColorDefinition

public boolean removeColorDefinition(ColorDefinition field)

Parameters:

field -

removeColorDefinition

public void removeColorDefinition(int i)

Parameters:

i -

removeColorDefinition

public void removeColorDefinition(java.lang.String id)

Parameters:

id -

isSetListOfGradientDefintions

public boolean isSetListOfGradientDefintions()

Returns:

true, if listOfGradientDefintions contains at least one element, otherwise false

getListOfGradientDefintions

public ListOf<GradientBase> getListOfGradientDefintions()

Returns:

the listOfGradientDefintions

setListOfGradientDefintions

public void setListOfGradientDefintions(ListOf<GradientBase> listOfGradientDefintions)

Parameters:

listOfGradientDefintions -

unsetListOfGradientDefintions

public boolean unsetListOfGradientDefintions()

Returns:

true, if listOfGradientDefintions contained at least one element, otherwise false

addGradientBase

public boolean addGradientBase(GradientBase field)

Parameters:

field -

removeGradientBase

public boolean removeGradientBase(GradientBase field)

Parameters:

field -

removeGradientBase

public void removeGradientBase(int i)

Parameters:

i -

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.

Specified by:

isIdMandatory in interface NamedSBase

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.

getAllowsChildren

public boolean getAllowsChildren()

Specified by:

getAllowsChildren in interface javax.swing.tree.TreeNode

Overrides:

getAllowsChildren in class AbstractSBase

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface javax.swing.tree.TreeNode

Overrides:

getChildCount in class AbstractSBase

getChildAt

public SBase getChildAt(int childIndex)

Specified by:

getChildAt in interface javax.swing.tree.TreeNode

Overrides:

getChildAt in class AbstractSBase

isSetListOfLineEndings

public boolean isSetListOfLineEndings()

Returns:

true, if listOfLineEndings contains at least one element, otherwise false

getListOfLineEndings

public ListOf<LineEnding> getListOfLineEndings()

Returns:

the listOfLineEndings

setListOfLineEndings

public void setListOfLineEndings(ListOf<LineEnding> listOfLineEndings)

Parameters:

listOfLineEndings -

unsetListOfLineEndings

public boolean unsetListOfLineEndings()

Returns:

true, if listOfLineEndings contained at least one element, otherwise false

addLineEnding

public boolean addLineEnding(LineEnding lineEnding)

Parameters:

lineEnding -

removeLineEnding

public boolean removeLineEnding(LineEnding lineEnding)

Parameters:

lineEnding -

removeLineEnding

public void removeLineEnding(int i)

Parameters:

i -

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.