org.sbml.jsbml.ext.render

Class AbstractRenderPlugin

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.ext.AbstractSBasePlugin

org.sbml.jsbml.ext.render.AbstractRenderPlugin

All Implemented Interfaces:

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

Direct Known Subclasses:

RenderLayoutPlugin, RenderListOfLayoutsPlugin

public abstract class AbstractRenderPlugin
extends AbstractSBasePlugin

Since:

1.0

Version:

$Rev: 1722 $

Author:

Jakob Matthes

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private GlobalRenderInformation	renderInformation
private static long	serialVersionUID
private java.lang.Short	versionMajor
private java.lang.Short	versionMinor

Fields inherited from class org.sbml.jsbml.ext.AbstractSBasePlugin

extendedSBase, packageVersion

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, UNKNOWN_ATTRIBUTES, UNKNOWN_ELEMENTS

Constructor Summary

Constructors

Constructor and Description
AbstractRenderPlugin(AbstractRenderPlugin obj) Clone constructor
AbstractRenderPlugin(int level, int version) Creates a AbstractRenderPlugin instance with a level and version.
AbstractRenderPlugin(SBase extendedElement) Creates an AbstractRenderPlugin instance
AbstractRenderPlugin(java.lang.String id, int level, int version) Creates a AbstractRenderPlugin instance with an id, level, and version.
AbstractRenderPlugin(java.lang.String id, java.lang.String name, int level, int version) Creates a AbstractRenderPlugin instance with an id, name, level, and version.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getAllowsChildren()
javax.swing.tree.TreeNode	getChildAt(int childIndex)
int	getChildCount()
java.lang.String	getElementNamespace() Returns the XML namespace (URI) of the package extension of this plugin object.
java.lang.String	getPackageName() Returns the package name of this plugin object.
java.lang.String	getPrefix() Returns the prefix of the package extension of this plugin object.
GlobalRenderInformation	getRenderInformation()
java.lang.String	getURI() Gets the URI to which this element belongs to.
java.lang.Short	getVersionMajor()
java.lang.Short	getVersionMinor()
void	initDefaults() Initializes the default values using the namespace.
boolean	isSetRenderInformation()
boolean	isSetVersionMajor()
boolean	isSetVersionMinor()
boolean	readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value) Reads and sets the attribute if it is know from this SBasePlugin.
void	setRenderInformation(GlobalRenderInformation renderInformation) Set the value of renderInformation
void	setVersionMajor(short versionMajor) Set the value of versionMajor
void	setVersionMinor(java.lang.Short versionMinor) Set the value of versionMinor
boolean	unsetRenderInformation() Unsets the variable renderInformation
boolean	unsetVersionMajor() Unsets the variable versionMajor
boolean	unsetVersionMinor() Unsets the variable versionMinor
java.util.Map<java.lang.String,java.lang.String>	writeXMLAttributes() Returns a Map containing the XML attributes of this object.

Methods inherited from class org.sbml.jsbml.ext.AbstractSBasePlugin

clone, equals, fireNodeAddedEvent, fireNodeRemovedEvent, firePropertyChange, getExtendedSBase, getLevel, getPackageVersion, getParentSBMLObject, getSBMLDocument, getVersion, hashCode, isSetExtendedSBase, removeFromParent, setExtendedSBase

Methods inherited from class org.sbml.jsbml.AbstractTreeNode

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

Methods inherited from class java.lang.Object

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

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

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

Methods inherited from interface javax.swing.tree.TreeNode

children, getIndex, getParent, isLeaf

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

versionMajor

private java.lang.Short versionMajor

versionMinor

private java.lang.Short versionMinor

renderInformation

private GlobalRenderInformation renderInformation

Constructor Detail

AbstractRenderPlugin

public AbstractRenderPlugin(SBase extendedElement)

Creates an AbstractRenderPlugin instance

AbstractRenderPlugin

public AbstractRenderPlugin(int level,
                    int version)

Creates a AbstractRenderPlugin instance with a level and version.

Parameters:

level -

version -

AbstractRenderPlugin

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

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

Parameters:

id -

level -

version -

AbstractRenderPlugin

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

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

Parameters:

id -

name -

level -

version -

AbstractRenderPlugin

public AbstractRenderPlugin(AbstractRenderPlugin obj)

Clone constructor

Method Detail

getElementNamespace

public java.lang.String getElementNamespace()

Description copied from interface: SBasePlugin

Returns the XML namespace (URI) of the package extension of this plugin object.

Returns:

the URI of the package extension of this plugin object.

getPackageName

public java.lang.String getPackageName()

Description copied from interface: SBasePlugin

Returns the package name of this plugin object.

Returns:

the package name of this plugin object.

getPrefix

public java.lang.String getPrefix()

Description copied from interface: SBasePlugin

Returns the prefix of the package extension of this plugin object.

Returns:

the prefix of the package extension of this plugin object.

getURI

public java.lang.String getURI()

Description copied from interface: SBasePlugin

Gets the URI to which this element belongs to. For example, all elements that belong to SBML Level 3 Version 1 Core must would have the URI 'http://www.sbml.org/sbml/level3/version1/core'; all elements that belong to Layout Extension Version 1 for SBML Level 3 Version 1 Core must would have the URI 'http://www.sbml.org/sbml/level3/version1/layout/version1/' Unlike getElementNamespace, this function first returns the URI for this element by looking into the SBMLNamespaces object of the document with the its package name. If not found it will return the result of getElementNamespace

Returns:

the URI for this element

initDefaults

public void initDefaults()

Initializes the default values using the namespace.

getVersionMinor

public java.lang.Short getVersionMinor()

Returns:

the value of versionMinor

isSetVersionMinor

public boolean isSetVersionMinor()

Returns:

whether versionMinor is set

setVersionMinor

public void setVersionMinor(java.lang.Short versionMinor)

Set the value of versionMinor

unsetVersionMinor

public boolean unsetVersionMinor()

Unsets the variable versionMinor

Returns:

true, if versionMinor was set before, otherwise false

getVersionMajor

public java.lang.Short getVersionMajor()

Returns:

the value of versionMajor

isSetVersionMajor

public boolean isSetVersionMajor()

Returns:

whether versionMajor is set

setVersionMajor

public void setVersionMajor(short versionMajor)

Set the value of versionMajor

unsetVersionMajor

public boolean unsetVersionMajor()

Unsets the variable versionMajor

Returns:

true, if versionMajor was set before, otherwise false

getRenderInformation

public GlobalRenderInformation getRenderInformation()

Returns:

the value of renderInformation

isSetRenderInformation

public boolean isSetRenderInformation()

Returns:

whether renderInformation is set

setRenderInformation

public void setRenderInformation(GlobalRenderInformation renderInformation)

Set the value of renderInformation

unsetRenderInformation

public boolean unsetRenderInformation()

Unsets the variable renderInformation

Returns:

true, if renderInformation was set before, otherwise false

readAttribute

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

Description copied from interface: SBasePlugin

Reads and sets the attribute if it is know from this SBasePlugin.

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.

getChildAt

public javax.swing.tree.TreeNode getChildAt(int childIndex)

getChildCount

public int getChildCount()

getAllowsChildren

public boolean getAllowsChildren()

writeXMLAttributes

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

Description copied from interface: SBasePlugin

Returns a Map containing the XML attributes of this object.

Specified by:

writeXMLAttributes in interface SBasePlugin

Overrides:

writeXMLAttributes in class AbstractSBasePlugin

Returns:

a Map containing the XML attributes of this object.