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:

Serializable, Cloneable, TreeNode, NamedSBase, SBase, UniqueNamedSBase, UniqueSId, TreeNodeWithChangeSupport

Direct Known Subclasses:

GlobalRenderInformation, LocalRenderInformation

public class RenderInformationBase
extends AbstractNamedSBase
implements UniqueNamedSBase

Since:

1.0

Author:

Eugen Netz, Alexander Diamantikos, Jakob Matthes, Jan Rudolph

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Color	backgroundColor
protected ListOf<ColorDefinition>	listOfColorDefinitions
protected ListOf<GradientBase>	listOfGradientDefinitions
protected ListOf<LineEnding>	listOfLineEndings
protected String	programName
protected String	programVersion
protected String	referenceRenderInformation

Fields inherited from class org.sbml.jsbml.AbstractSBase

ignoredExtensions, ignoredXMLElements, JSBML_WRONG_SBO_TERM, packageName

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, resourceBundle

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

Method Summary

Modifier and Type	Method and Description
boolean	addColorDefinition(ColorDefinition field)
boolean	addGradientBase(GradientBase field)
boolean	addLineEnding(LineEnding lineEnding)
RenderInformationBase	clone()
boolean	equals(Object obj)
boolean	getAllowsChildren()
Color	getBackgroundColor()
SBase	getChildAt(int childIndex)
int	getChildCount()
ListOf<ColorDefinition>	getListOfColorDefinitions()
ListOf<GradientBase>	getListOfGradientDefinitions()
ListOf<LineEnding>	getListOfLineEndings()
String	getProgramName()
String	getProgramVersion()
String	getReferenceRenderInformation()
int	hashCode()
void	initDefaults() Initializes the default values using the namespace.
boolean	isIdMandatory()
boolean	isListOfColorDefinitionsEmpty()
boolean	isListOfGradientDefinitionsEmpty()
boolean	isListOfLineEndingsEmpty()
boolean	isSetBackgroundColor()
boolean	isSetListOfColorDefinitions()
boolean	isSetListOfGradientDefinitions()
boolean	isSetListOfLineEndings()
boolean	isSetProgramName()
boolean	isSetProgramVersion()
boolean	isSetReferenceRenderInformation()
boolean	readAttribute(String attributeName, String prefix, String value)
boolean	removeColorDefinition(ColorDefinition field)
void	removeColorDefinition(int i)
void	removeColorDefinition(String id)
boolean	removeGradientBase(GradientBase field)
void	removeGradientBase(int i)
void	removeLineEnding(int i)
boolean	removeLineEnding(LineEnding lineEnding)
void	setBackgroundColor(Color backgroundColor) Set the value of backgroundColor
void	setListOfColorDefinitions(ListOf<ColorDefinition> listOfColorDefinitions)
void	setListOfGradientDefinitions(ListOf<GradientBase> listOfGradientDefintions)
void	setListOfLineEndings(ListOf<LineEnding> listOfLineEndings)
void	setProgramName(String programName) Set the value of programmName
void	setProgramVersion(String programVersion) Set the value of programVersion
void	setReferenceRenderInformation(String referenceRenderInformation) Set the value of referenceRenderInformation
boolean	unsetBackgroundColor() Unsets the variable backgroundColor
boolean	unsetListOfColorDefinitions()
boolean	unsetListOfGradientDefinitions()
boolean	unsetListOfLineEndings()
boolean	unsetProgramName() Unsets the variable programmName
boolean	unsetProgramVersion() Unsets the variable programVersion
boolean	unsetReferenceRenderInformation() Unsets the variable referenceRenderInformation
Map<String,String>	writeXMLAttributes()

Methods inherited from class org.sbml.jsbml.AbstractNamedSBase

isValidId

Methods inherited from class org.sbml.jsbml.AbstractSBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendAnnotation, appendAnnotation, appendNotes, appendNotes, checkAndSetPackageNamespaceAndVersion, checkAndSetPackageNamespaceAndVersion, checkAttribute, checkIdentifier, checkLevelAndVersionCompatibility, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAllDeclaredNamespaces, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, getElementName, getExtension, getExtensionCount, getExtensionPackages, getFirstElementIndex, getHistory, getId, getIdManager, getLevel, getLevelAndVersion, getMetaId, getModel, getName, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParent, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetId, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetName, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, isValidLevelAndVersionCombination, isValidMetaId, notifyChildChange, registerChild, removeCVTerm, removeCVTerm, removeDeclaredNamespaceByNamespace, removeDeclaredNamespaceByPrefix, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setAnnotation, setHistory, setId, setLevel, setMetaId, setName, setNamespace, setNotes, setNotes, setPackageVersion, setParentSBML, setParentSBMLObject, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, toString, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetId, unsetMetaId, unsetName, 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, isCloningInProgress, isInvalidSBMLAllowed, isLeaf, isReadingInProgress, 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, appendAnnotation, appendAnnotation, appendNotes, appendNotes, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, registerChild, removeCVTerm, removeCVTerm, removeDeclaredNamespaceByNamespace, removeDeclaredNamespaceByPrefix, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTreeNodeChangeListener, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setAnnotation, setHistory, setLevel, setMetaId, setNotes, setNotes, setPackageVersion, 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

programName

protected String programName

programVersion

protected String programVersion

referenceRenderInformation

protected String referenceRenderInformation

backgroundColor

protected Color backgroundColor

listOfColorDefinitions

protected ListOf<ColorDefinition> listOfColorDefinitions

listOfGradientDefinitions

protected ListOf<GradientBase> listOfGradientDefinitions

listOfLineEndings

protected ListOf<LineEnding> listOfLineEndings

Constructor Detail

RenderInformationBase

public RenderInformationBase()

Creates an RenderInformationBase instance

RenderInformationBase

public RenderInformationBase(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(String id,
                             int level,
                             int version)

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

Parameters:

id -

level -

version -

RenderInformationBase

public RenderInformationBase(String id,
                             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

Parameters:

obj -

Method Detail

clone

public RenderInformationBase clone()

Specified by:

clone in interface SBase

Overrides:

clone in class AbstractSBase

initDefaults

public void initDefaults()

Initializes the default values using the namespace.

hashCode

public int hashCode()

Specified by:

hashCode in interface SBase

Overrides:

hashCode in class AbstractSBase

equals

public boolean equals(Object obj)

Specified by:

equals in interface SBase

Overrides:

equals in class AbstractSBase

getProgramName

public String getProgramName()

Returns:

the value of programName

isSetProgramName

public boolean isSetProgramName()

Returns:

whether programmName is set

setProgramName

public void setProgramName(String programName)

Set the value of programmName

Parameters:

programName -

unsetProgramName

public boolean unsetProgramName()

Unsets the variable programmName

Returns:

true, if programmName was set before, otherwise false

getProgramVersion

public String getProgramVersion()

Returns:

the value of programVersion

isSetProgramVersion

public boolean isSetProgramVersion()

Returns:

whether programVersion is set

setProgramVersion

public void setProgramVersion(String programVersion)

Set the value of programVersion

Parameters:

programVersion -

unsetProgramVersion

public boolean unsetProgramVersion()

Unsets the variable programVersion

Returns:

true, if programVersion was set before, otherwise false

getReferenceRenderInformation

public String getReferenceRenderInformation()

Returns:

the value of referenceRenderInformation

isSetReferenceRenderInformation

public boolean isSetReferenceRenderInformation()

Returns:

whether referenceRenderInformation is set

setReferenceRenderInformation

public void setReferenceRenderInformation(String referenceRenderInformation)

Set the value of referenceRenderInformation

Parameters:

referenceRenderInformation -

unsetReferenceRenderInformation

public boolean unsetReferenceRenderInformation()

Unsets the variable referenceRenderInformation

Returns:

true, if referenceRenderInformation was set before, otherwise false

getBackgroundColor

public Color getBackgroundColor()

Returns:

the value of backgroundColor

isSetBackgroundColor

public boolean isSetBackgroundColor()

Returns:

whether backgroundColor is set

setBackgroundColor

public void setBackgroundColor(Color backgroundColor)

Set the value of backgroundColor

Parameters:

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

isListOfColorDefinitionsEmpty

public boolean isListOfColorDefinitionsEmpty()

Returns:

true iff listOfColorDefinitions is not null, but empty (relevant for validation)

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 -

Returns:

removeColorDefinition

public boolean removeColorDefinition(ColorDefinition field)

Parameters:

field -

Returns:

removeColorDefinition

public void removeColorDefinition(int i)

Parameters:

i -

removeColorDefinition

public void removeColorDefinition(String id)

Parameters:

id -

isSetListOfGradientDefinitions

public boolean isSetListOfGradientDefinitions()

Returns:

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

isListOfGradientDefinitionsEmpty

public boolean isListOfGradientDefinitionsEmpty()

Returns:

true iff listOfGradientDefinitions is not null, but empty (relevant for validation)

getListOfGradientDefinitions

public ListOf<GradientBase> getListOfGradientDefinitions()

Returns:

the listOfGradientDefinitions

setListOfGradientDefinitions

public void setListOfGradientDefinitions(ListOf<GradientBase> listOfGradientDefintions)

Parameters:

listOfGradientDefintions -

unsetListOfGradientDefinitions

public boolean unsetListOfGradientDefinitions()

Returns:

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

addGradientBase

public boolean addGradientBase(GradientBase field)

Parameters:

field -

Returns:

removeGradientBase

public boolean removeGradientBase(GradientBase field)

Parameters:

field -

Returns:

removeGradientBase

public void removeGradientBase(int i)

Parameters:

i -

isIdMandatory

public boolean isIdMandatory()

Specified by:

isIdMandatory in interface NamedSBase

Specified by:

isIdMandatory in interface SBase

Overrides:

isIdMandatory in class AbstractSBase

getAllowsChildren

public boolean getAllowsChildren()

Specified by:

getAllowsChildren in interface TreeNode

Overrides:

getAllowsChildren in class AbstractSBase

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface TreeNode

Overrides:

getChildCount in class AbstractSBase

getChildAt

public SBase getChildAt(int childIndex)

Specified by:

getChildAt in interface TreeNode

Overrides:

getChildAt in class AbstractSBase

isSetListOfLineEndings

public boolean isSetListOfLineEndings()

Returns:

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

isListOfLineEndingsEmpty

public boolean isListOfLineEndingsEmpty()

Returns:

true iff listOfLineEndings is not null, but empty (relevant for validation)

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 -

Returns:

removeLineEnding

public boolean removeLineEnding(LineEnding lineEnding)

Parameters:

lineEnding -

Returns:

removeLineEnding

public void removeLineEnding(int i)

Parameters:

i -

writeXMLAttributes

public Map<String,String> writeXMLAttributes()

Specified by:

writeXMLAttributes in interface SBase

Overrides:

writeXMLAttributes in class AbstractSBase

readAttribute

public boolean readAttribute(String attributeName,
                             String prefix,
                             String value)

Specified by:

readAttribute in interface SBase

Overrides:

readAttribute in class AbstractSBase