org.sbml.jsbml.xml

Class XMLToken

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.xml.XMLToken

All Implemented Interfaces:

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

Direct Known Subclasses:

XMLNode

public abstract class XMLToken
extends AbstractTreeNode

Representation of a token in an XML stream.

This class of objects is defined by JSBML only and has no direct equivalent in terms of SBML components. This class is not prescribed by the SBML specifications, although it is used to implement features defined in SBML.

Since:

0.8

Version:

$Rev$

Author:

Nicolas Rodriguez, Andreas Dräger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected XMLAttributes	attributes
protected java.lang.StringBuilder	characters
protected long	column
protected boolean	isEndElement
protected boolean	isEOF
protected boolean	isStartElement
protected boolean	isText
protected long	line
protected XMLNamespaces	namespaces
private static long	serialVersionUID Generated serial version identifier
protected XMLTriple	triple the XMLTripe (name, uri and prefix) of this XML element.

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, resourceBundle

Constructor Summary

Constructors

Constructor and Description
XMLToken() Creates a new empty XMLToken.
XMLToken(java.lang.String chars) Creates a text XMLToken.
XMLToken(java.lang.String chars, long line) Creates a text XMLToken.
XMLToken(java.lang.String chars, long line, long column) Creates a text XMLToken.
XMLToken(XMLToken orig) Copy constructor; creates a copy of this XMLToken.
XMLToken(XMLTriple triple) Creates an end element XMLToken.
XMLToken(XMLTriple triple, long line) Creates an end element XMLToken.
XMLToken(XMLTriple triple, long line, long column) Creates an end element XMLToken.
XMLToken(XMLTriple triple, XMLAttributes attributes) Creates a start element XMLToken with the given set of attributes.
XMLToken(XMLTriple triple, XMLAttributes attributes, long line) Creates a start element XMLToken with the given set of attributes.
XMLToken(XMLTriple triple, XMLAttributes attributes, long line, long column) Creates a start element XMLToken with the given set of attributes.
XMLToken(XMLTriple triple, XMLAttributes attributes, XMLNamespaces namespaces) Creates a start element XMLToken with the given set of attributes and namespace declarations.
XMLToken(XMLTriple triple, XMLAttributes attributes, XMLNamespaces namespaces, long line) Creates a start element XMLToken with the given set of attributes and namespace declarations.
XMLToken(XMLTriple triple, XMLAttributes attributes, XMLNamespaces namespaces, long line, long column) Creates a start element XMLToken with the given set of attributes and namespace declarations.

Method Summary

Modifier and Type	Method and Description
int	addAttr(java.lang.String name, java.lang.String value) Adds an attribute to the attribute set in this XMLToken optionally with a prefix and URI defining a namespace.
int	addAttr(java.lang.String name, java.lang.String value, java.lang.String namespaceURI) Adds an attribute to the attribute set in this XMLToken optionally with a prefix and URI defining a namespace.
int	addAttr(java.lang.String name, java.lang.String value, java.lang.String namespaceURI, java.lang.String prefix) Adds an attribute to the attribute set in this XMLToken optionally with a prefix and URI defining a namespace.
int	addAttr(XMLTriple triple, java.lang.String value) Adds an attribute with the given XMLTriple/value pair to the attribute set in this XMLToken.
int	addNamespace(java.lang.String uri) Appends an XML namespace URI to this XMLToken.
int	addNamespace(java.lang.String uri, java.lang.String prefix) Appends an XML namespace prefix and URI pair to this XMLToken.
void	append(java.lang.String chars) Appends characters to this XML text content.
int	clearAttributes() Clears (deletes) all attributes in this XMLToken.
int	clearNamespaces() Clears (deletes) all XML namespace declarations in the XMLNamespaces of this XMLToken.
abstract XMLToken	clone()
boolean	equals(java.lang.Object obj)
XMLAttributes	getAttributes() Returns the attributes of this element.
int	getAttributesLength() Returns the number of attributes in the attributes set.
int	getAttrIndex(java.lang.String name) Returns the index of an attribute with the given local name.
int	getAttrIndex(java.lang.String name, java.lang.String uri) Returns the index of an attribute with the given local name and namespace URI.
int	getAttrIndex(XMLTriple triple) Returns the index of an attribute with the given XMLTriple.
java.lang.String	getAttrName(int index) Returns the local name of an attribute in the attributes set in this XMLToken (by position).
java.lang.String	getAttrPrefix(int index) Returns the prefix of an attribute in the attribute set in this XMLToken (by position).
java.lang.String	getAttrPrefixedName(int index) Returns the prefixed name of an attribute in the attribute set in this XMLToken (by position).
java.lang.String	getAttrURI(int index) Returns the namespace URI of an attribute in the attribute set in this XMLToken (by position).
java.lang.String	getAttrValue(int index) Returns the value of an attribute in the attribute set in this XMLToken (by position).
java.lang.String	getAttrValue(java.lang.String name) Returns a value of an attribute with the given local name.
java.lang.String	getAttrValue(java.lang.String name, java.lang.String uri) Returns a value of an attribute with the given local name and namespace URI.
java.lang.String	getAttrValue(XMLTriple triple) Returns a value of an attribute with the given XMLTriple.
java.lang.String	getCharacters() Returns the text of this element.
long	getColumn() Returns the column at which this XMLToken occurred in the input document or data stream.
long	getLine() Returns the line at which this XMLToken occurred in the input document or data stream.
java.lang.String	getName() Returns the (unqualified) name of this XML element.
int	getNamespaceIndex(java.lang.String uri) Returns the index of an XML namespace declaration by URI.
int	getNamespaceIndexByPrefix(java.lang.String prefix) Returns the index of an XML namespace declaration by prefix.
java.lang.String	getNamespacePrefix(int index) Returns the prefix of an XML namespace declaration by position.
java.lang.String	getNamespacePrefix(java.lang.String uri) Returns the prefix of an XML namespace declaration by its URI.
XMLNamespaces	getNamespaces() Returns the XML namespace declarations for this XML element.
int	getNamespacesLength() Returns the number of XML namespaces stored in the XMLNamespaces of this XMLToken.
java.lang.String	getNamespaceURI() Returns the URI of an XML namespace declaration for the empty prefix.
java.lang.String	getNamespaceURI(int index) Returns the URI of an XML namespace declaration by its position.
java.lang.String	getNamespaceURI(java.lang.String prefix) Returns the URI of an XML namespace declaration by its prefix.
java.lang.String	getPrefix() Returns the namespace prefix of this XML element.
java.lang.String	getURI() Returns the namespace URI of this XML element.
boolean	hasAttr(int index) Returns true or false depending on whether an attribute with the given index exists in the attribute set in this XMLToken.
boolean	hasAttr(java.lang.String name) Returns true or false depending on whether an attribute with the given local name exists in the attribute set in this XMLToken.
boolean	hasAttr(java.lang.String name, java.lang.String uri) Returns true or false depending on whether an attribute with the given local name and namespace URI exists in the attribute set in this XMLToken.
boolean	hasAttr(XMLTriple triple) Returns true or false depending on whether an attribute with the given XML triple exists in the attribute set in this XMLToken
int	hashCode()
boolean	hasNamespaceNS(java.lang.String uri, java.lang.String prefix) Returns true or false depending on whether an XML Namespace with the given uri/prefix pair is contained in the XMLNamespaces of this XMLToken.
boolean	hasNamespacePrefix(java.lang.String prefix) Returns true or false depending on whether an XML Namespace with the given prefix is contained in the XMLNamespaces of this XMLToken.
boolean	hasNamespaceURI(java.lang.String uri) Returns true or false depending on whether an XML Namespace with the given URI is contained in the XMLNamespaces of this XMLToken.
boolean	isAttributesEmpty() Returns true or false depending on whether the attribute set in this XMLToken set is empty.
boolean	isElement() Returns true or false depending on whether this XMLToken is an XML element.
boolean	isEnd() Returns true or false depending on whether this XMLToken is an XML end element.
boolean	isEndFor(XMLToken element) Returns true or false depending on whether this XMLToken is an XML end element for the given start element.
boolean	isEOF() Returns true or false depending on whether this XMLToken is an end of file marker.
boolean	isNamespacesEmpty() Returns true or false depending on whether the XMLNamespaces of this XMLToken is empty.
boolean	isStart() Returns true or false depending on whether this XMLToken is an XML start element.
boolean	isText() Returns true or false depending on whether this XMLToken is an XML text element.
int	removeAttr(int n) Removes an attribute with the given index from the attribute set in this XMLToken.
int	removeAttr(java.lang.String name) Removes an attribute with the given local name from the attribute set in this XMLToken.
int	removeAttr(java.lang.String name, java.lang.String uri) Removes an attribute with the given local name and namespace URI from the attribute set in this XMLToken.
int	removeAttr(XMLTriple triple) Removes an attribute with the given XMLTriple from the attribute set in this XMLToken.
int	removeNamespace(int index) Removes an XML Namespace stored in the given position of the XMLNamespaces of this XMLToken.
int	removeNamespace(java.lang.String prefix) Removes an XML Namespace with the given prefix.
int	setAttributes(XMLAttributes attributes) Sets an XMLAttributes to this XMLToken.
void	setCharacters(java.lang.String chars) Sets the characters in this XMLToken.
int	setEnd() Declares this XML start element is also an end element.
int	setEOF() Declares this XMLToken is an end-of-file (input) marker.
int	setNamespaces(XMLNamespaces namespaces) Sets an XMLnamespaces to this XML element.
int	setTriple(XMLTriple triple) Sets the XMLTripe (name, uri and prefix) of this XML element.
int	unsetEnd() Declares this XML start/end element is no longer an end element.

Methods inherited from class org.sbml.jsbml.AbstractTreeNode

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.swing.tree.TreeNode

getAllowsChildren, getChildAt, getChildCount

Field Detail

serialVersionUID

private static final long serialVersionUID

Generated serial version identifier

See Also:

Constant Field Values

attributes

protected XMLAttributes attributes

characters

protected java.lang.StringBuilder characters

column

protected long column

isEndElement

protected boolean isEndElement

isEOF

protected boolean isEOF

isStartElement

protected boolean isStartElement

isText

protected boolean isText

line

protected long line

namespaces

protected XMLNamespaces namespaces

triple

protected XMLTriple triple

the XMLTripe (name, uri and prefix) of this XML element.

Constructor Detail

XMLToken

public XMLToken()

Creates a new empty XMLToken.

XMLToken

public XMLToken(java.lang.String chars)

Creates a text XMLToken.

Parameters:

chars - a string, the text to be added to the XMLToken

XMLToken

public XMLToken(java.lang.String chars,
                long line)

Creates a text XMLToken.

Parameters:

chars - a string, the text to be added to the XMLToken

line - a long integer, the line number (default = 0).

XMLToken

public XMLToken(java.lang.String chars,
                long line,
                long column)

Creates a text XMLToken.

Parameters:

chars - a String, the text to be added to the XMLToken

line - a long integer, the line number (default = 0).

column - a long integer, the column number (default = 0).

XMLToken

public XMLToken(XMLToken orig)

Copy constructor; creates a copy of this XMLToken.

Parameters:

orig -

XMLToken

public XMLToken(XMLTriple triple)

Creates an end element XMLToken.

Parameters:

triple - XMLTriple.

XMLToken

public XMLToken(XMLTriple triple,
                long line)

Creates an end element XMLToken.

Parameters:

triple - XMLTriple.

line - a long integer, the line number (default = 0).

XMLToken

public XMLToken(XMLTriple triple,
                long line,
                long column)

Creates an end element XMLToken.

Parameters:

triple - XMLTriple.

line - a long integer, the line number (default = 0).

column - a long integer, the column number (default = 0).

XMLToken

public XMLToken(XMLTriple triple,
                XMLAttributes attributes)

Creates a start element XMLToken with the given set of attributes.

Parameters:

triple - XMLTriple.

attributes - XMLAttributes, the attributes to set.

XMLToken

public XMLToken(XMLTriple triple,
                XMLAttributes attributes,
                long line)

Creates a start element XMLToken with the given set of attributes.

Parameters:

triple - XMLTriple.

attributes - XMLAttributes, the attributes to set.

line - a long integer, the line number (default = 0).

XMLToken

public XMLToken(XMLTriple triple,
                XMLAttributes attributes,
                long line,
                long column)

Creates a start element XMLToken with the given set of attributes.

Parameters:

triple - XMLTriple.

attributes - XMLAttributes, the attributes to set.

line - a long integer, the line number (default = 0).

column - a long integer, the column number (default = 0).

XMLToken

public XMLToken(XMLTriple triple,
                XMLAttributes attributes,
                XMLNamespaces namespaces)

Creates a start element XMLToken with the given set of attributes and namespace declarations.

Parameters:

triple - XMLTriple.

attributes - XMLAttributes, the attributes to set.

namespaces - XMLNamespaces, the namespaces to set.

XMLToken

public XMLToken(XMLTriple triple,
                XMLAttributes attributes,
                XMLNamespaces namespaces,
                long line)

Creates a start element XMLToken with the given set of attributes and namespace declarations.

Parameters:

triple - XMLTriple.

attributes - XMLAttributes, the attributes to set.

namespaces - XMLNamespaces, the namespaces to set.

line - a long integer, the line number (default = 0).

XMLToken

public XMLToken(XMLTriple triple,
                XMLAttributes attributes,
                XMLNamespaces namespaces,
                long line,
                long column)

Creates a start element XMLToken with the given set of attributes and namespace declarations.

Parameters:

triple - XMLTriple.

attributes - XMLAttributes, the attributes to set.

namespaces - XMLNamespaces, the namespaces to set.

line - a long integer, the line number (default = 0).

column - a long integer, the column number (default = 0).

Method Detail

addAttr

public int addAttr(java.lang.String name,
                   java.lang.String value)

Adds an attribute to the attribute set in this XMLToken optionally with a prefix and URI defining a namespace. Nothing will be done if this XMLToken is not a start element.

Parameters:

name - a string, the local name of the attribute.

value - a string, the value of the attribute.

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• JSBML.OPERATION_SUCCESS
• JSBML.OPERATION_FAILED

addAttr

public int addAttr(java.lang.String name,
                   java.lang.String value,
                   java.lang.String namespaceURI)

Adds an attribute to the attribute set in this XMLToken optionally with a prefix and URI defining a namespace. Nothing will be done if this XMLToken is not a start element.

Parameters:

name - a string, the local name of the attribute.

value - a string, the value of the attribute.

namespaceURI - a string, the namespace URI of the attribute.

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• JSBML.OPERATION_SUCCESS
• JSBML.OPERATION_FAILED

addAttr

public int addAttr(java.lang.String name,
                   java.lang.String value,
                   java.lang.String namespaceURI,
                   java.lang.String prefix)

Adds an attribute to the attribute set in this XMLToken optionally with a prefix and URI defining a namespace. Nothing will be done if this XMLToken is not a start element.

Parameters:

name - a string, the local name of the attribute.

value - a string, the value of the attribute.

namespaceURI - a string, the namespace URI of the attribute.

prefix - a string, the prefix of the namespace

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• JSBML.OPERATION_SUCCESS
• JSBML.OPERATION_FAILED

addAttr

public int addAttr(XMLTriple triple,
                   java.lang.String value)

Adds an attribute with the given XMLTriple/value pair to the attribute set in this XMLToken. Nothing will be done if this XMLToken is not a start element.

Parameters:

triple - an XMLTriple, the XML triple of the attribute.

value - a string, the value of the attribute.

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• JSBML.OPERATION_SUCCESS
• JSBML.OPERATION_FAILED

addNamespace

public int addNamespace(java.lang.String uri)

Appends an XML namespace URI to this XMLToken. If there is an XML namespace with the given prefix in this XMLToken, then the existing XML namespace will be overwritten by the new one.

Nothing will be done if this XMLToken is not a start element.

Parameters:

uri - a string, the uri for the namespace

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• JSBML.OPERATION_SUCCESS
• JSBML.OPERATION_FAILED

addNamespace

public int addNamespace(java.lang.String uri,
                        java.lang.String prefix)

Appends an XML namespace prefix and URI pair to this XMLToken. If there is an XML namespace with the given prefix in this XMLToken, then the existing XML namespace will be overwritten by the new one.

Nothing will be done if this XMLToken is not a start element.

Parameters:

uri - a string, the uri for the namespace

prefix - a string, the prefix for the namespace

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• JSBML.OPERATION_SUCCESS
• JSBML.OPERATION_FAILED

Throws:

java.lang.IllegalArgumentException - if one of the arguments is null or if the prefix is malformed.

append

public void append(java.lang.String chars)

Appends characters to this XML text content.

Parameters:

chars -

clearAttributes

public int clearAttributes()

Clears (deletes) all attributes in this XMLToken. Nothing will be done if this XMLToken is not a start element.

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• JSBML.OPERATION_SUCCESS
• JSBML.OPERATION_FAILED

clearNamespaces

public int clearNamespaces()

Clears (deletes) all XML namespace declarations in the XMLNamespaces of this XMLToken. Nothing will be done if this XMLToken is not a start element.

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• JSBML.OPERATION_SUCCESS
• JSBML.OPERATION_FAILED

clone

public abstract XMLToken clone()

Specified by:

clone in class AbstractTreeNode

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class AbstractTreeNode

getAttributes

public XMLAttributes getAttributes()

Returns the attributes of this element.

Returns:

the XMLAttributes of this XML element.

getAttributesLength

public int getAttributesLength()

Returns the number of attributes in the attributes set.

Returns:

the number of attributes in the attributes set in this XMLToken.

getAttrIndex

public int getAttrIndex(java.lang.String name)

Returns the index of an attribute with the given local name.

Parameters:

name - a string, the local name of the attribute.

Returns:

the index of an attribute with the given local name, or -1 if not present.

getAttrIndex

public int getAttrIndex(java.lang.String name,
                        java.lang.String uri)

Returns the index of an attribute with the given local name and namespace URI.

Parameters:

name - a string, the local name of the attribute.

uri - a string, the namespace URI of the attribute.

Returns:

the index of an attribute with the given local name and namespace URI, or -1 if not present.

getAttrIndex

public int getAttrIndex(XMLTriple triple)

Returns the index of an attribute with the given XMLTriple.

Parameters:

triple - an XMLTriple, the XML triple of the attribute for which the index is required.

Returns:

the index of an attribute with the given XMLTriple, or -1 if not present.

getAttrName

public java.lang.String getAttrName(int index)

Returns the local name of an attribute in the attributes set in this XMLToken (by position).

Parameters:

index - an integer, the position of the attribute whose local name is required.

Returns:

the local name of an attribute in this list (by position).

getAttrPrefix

public java.lang.String getAttrPrefix(int index)

Returns the prefix of an attribute in the attribute set in this XMLToken (by position).

Parameters:

index - an integer, the position of the attribute whose prefix is required.

Returns:

the namespace prefix of an attribute in the attribute set (by position).

getAttrPrefixedName

public java.lang.String getAttrPrefixedName(int index)

Returns the prefixed name of an attribute in the attribute set in this XMLToken (by position).

Parameters:

index - an integer, the position of the attribute whose prefixed name is required.

Returns:

the prefixed name of an attribute in the attribute set (by position).

getAttrURI

public java.lang.String getAttrURI(int index)

Returns the namespace URI of an attribute in the attribute set in this XMLToken (by position).

Parameters:

index - an integer, the position of the attribute whose namespace URI is required.

Returns:

the namespace URI of an attribute in the attribute set (by position).

getAttrValue

public java.lang.String getAttrValue(int index)

Returns the value of an attribute in the attribute set in this XMLToken (by position).

Parameters:

index - an integer, the position of the attribute whose value is required.

Returns:

the value of an attribute in the attribute set (by position).

getAttrValue

public java.lang.String getAttrValue(java.lang.String name)

Returns a value of an attribute with the given local name.

Parameters:

name - a string, the local name of the attribute whose value is required.

Returns:

The attribute value as a string.

getAttrValue

public java.lang.String getAttrValue(java.lang.String name,
                                     java.lang.String uri)

Returns a value of an attribute with the given local name and namespace URI.

Parameters:

name - a string, the local name of the attribute whose value is required.

uri - a string, the namespace URI of the attribute.

Returns:

The attribute value as a string.

getAttrValue

public java.lang.String getAttrValue(XMLTriple triple)

Returns a value of an attribute with the given XMLTriple.

Parameters:

triple - an XMLTriple, the XML triple of the attribute whose value is required.

Returns:

The attribute value as a string.

getCharacters

public java.lang.String getCharacters()

Returns the text of this element.

Returns:

the characters of this XML text.

getColumn

public long getColumn()

Returns the column at which this XMLToken occurred in the input document or data stream.

Returns:

the column at which this XMLToken occurred.

getLine

public long getLine()

Returns the line at which this XMLToken occurred in the input document or data stream.

Returns:

the line at which this XMLToken occurred.

getName

public java.lang.String getName()

Returns the (unqualified) name of this XML element.

Returns:

the (unqualified) name of this XML element.

getNamespaceIndex

public int getNamespaceIndex(java.lang.String uri)

Returns the index of an XML namespace declaration by URI.

Parameters:

uri - a string, uri of the required namespace.

Returns:

the index of the given declaration, or -1 if not present.

getNamespaceIndexByPrefix

public int getNamespaceIndexByPrefix(java.lang.String prefix)

Returns the index of an XML namespace declaration by prefix.

Parameters:

prefix - a string, prefix of the required namespace.

Returns:

the index of the given declaration, or -1 if not present.

getNamespacePrefix

public java.lang.String getNamespacePrefix(int index)

Returns the prefix of an XML namespace declaration by position.

Callers should use getNamespacesLength() to find out how many namespaces are stored in the XMLNamespaces.

Parameters:

index - an integer, position of the required prefix.

Returns:

the prefix of an XML namespace declaration in the XMLNamespaces (by position).

See Also:

getNamespacesLength()

getNamespacePrefix

public java.lang.String getNamespacePrefix(java.lang.String uri)

Returns the prefix of an XML namespace declaration by its URI.

Parameters:

uri - a string, the URI of the prefix being sought

Returns:

the prefix of an XML namespace declaration given its URI.

getNamespaces

public XMLNamespaces getNamespaces()

Returns the XML namespace declarations for this XML element.

Returns:

the XML namespace declarations for this XML element.

getNamespacesLength

public int getNamespacesLength()

Returns the number of XML namespaces stored in the XMLNamespaces of this XMLToken.

Returns:

the number of namespaces in this list.

getNamespaceURI

public java.lang.String getNamespaceURI()

Returns the URI of an XML namespace declaration for the empty prefix.

Returns:

the URI of an XML namespace declaration for the empty prefix.

getNamespaceURI

public java.lang.String getNamespaceURI(int index)

Returns the URI of an XML namespace declaration by its position.

Parameters:

index - an integer, position of the required URI.

Returns:

the URI of an XML namespace declaration in the XMLNamespaces (by position).

See Also:

getNamespacesLength()

getNamespaceURI

public java.lang.String getNamespaceURI(java.lang.String prefix)

Returns the URI of an XML namespace declaration by its prefix.

Parameters:

prefix - a string, the prefix of the required URI

Returns:

the URI of an XML namespace declaration given its prefix.

getPrefix

public java.lang.String getPrefix()

Returns the namespace prefix of this XML element.

Returns:

the namespace prefix of this XML element.

getURI

public java.lang.String getURI()

Returns the namespace URI of this XML element.

Returns:

the namespace URI of this XML element.

hasAttr

public boolean hasAttr(int index)

Returns true or false depending on whether an attribute with the given index exists in the attribute set in this XMLToken.

Parameters:

index - an integer, the position of the attribute.

Returns:

true if an attribute with the given index exists in the attribute set in this XMLToken, false otherwise.

hasAttr

public boolean hasAttr(java.lang.String name)

Returns true or false depending on whether an attribute with the given local name exists in the attribute set in this XMLToken.

Parameters:

name - a string, the local name of the attribute.

Returns:

true if an attribute with the given local name exists in the attribute set in this XMLToken, false otherwise.

hasAttr

public boolean hasAttr(java.lang.String name,
                       java.lang.String uri)

Returns true or false depending on whether an attribute with the given local name and namespace URI exists in the attribute set in this XMLToken.

Parameters:

name - a string, the local name of the attribute.

uri - a string, the namespace URI of the attribute.

Returns:

true if an attribute with the given local name and namespace URI exists in the attribute set in this XMLToken, false otherwise.

hasAttr

public boolean hasAttr(XMLTriple triple)

Returns true or false depending on whether an attribute with the given XML triple exists in the attribute set in this XMLToken

Parameters:

triple - an XMLTriple, the XML triple of the attribute

Returns:

true if an attribute with the given XML triple exists in the attribute set in this XMLToken, false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractTreeNode

hasNamespaceNS

public boolean hasNamespaceNS(java.lang.String uri,
                              java.lang.String prefix)

Returns true or false depending on whether an XML Namespace with the given uri/prefix pair is contained in the XMLNamespaces of this XMLToken.

Parameters:

uri - a string, the uri for the namespace

prefix - a string, the prefix for the namespace

Returns:

true if an XML Namespace with the given uri/prefix pair is contained in the XMLNamespaces of this XMLToken, false otherwise.

hasNamespacePrefix

public boolean hasNamespacePrefix(java.lang.String prefix)

Returns true or false depending on whether an XML Namespace with the given prefix is contained in the XMLNamespaces of this XMLToken.

Parameters:

prefix - a string, the prefix for the namespace

Returns:

true if an XML Namespace with the given URI is contained in the XMLNamespaces of this XMLToken, false otherwise.

hasNamespaceURI

public boolean hasNamespaceURI(java.lang.String uri)

Returns true or false depending on whether an XML Namespace with the given URI is contained in the XMLNamespaces of this XMLToken.

Parameters:

uri - a string, the uri for the namespace

Returns:

true if an XML Namespace with the given URI is contained in the XMLNamespaces of this XMLToken, false otherwise.

isAttributesEmpty

public boolean isAttributesEmpty()

Returns true or false depending on whether the attribute set in this XMLToken set is empty.

Returns:

true if the attribute set in this XMLToken is empty, false otherwise.

isElement

public boolean isElement()

Returns true or false depending on whether this XMLToken is an XML element.

Returns:

true if this XMLToken is an XML element, false otherwise.

isEnd

public boolean isEnd()

Returns true or false depending on whether this XMLToken is an XML end element.

Returns:

true if this XMLToken is an XML end element, false otherwise.

isEndFor

public boolean isEndFor(XMLToken element)

Returns true or false depending on whether this XMLToken is an XML end element for the given start element.

Parameters:

element - XMLToken, element for which query is made.

Returns:

true if this XMLToken is an XML end element for the given XMLToken start element, false otherwise.

isEOF

public boolean isEOF()

Returns true or false depending on whether this XMLToken is an end of file marker.

Returns:

true if this XMLToken is an end of file (input) marker, false otherwise.

isNamespacesEmpty

public boolean isNamespacesEmpty()

Returns true or false depending on whether the XMLNamespaces of this XMLToken is empty.

Returns:

true if the XMLNamespaces of this XMLToken is empty, false otherwise.

isStart

public boolean isStart()

Returns true or false depending on whether this XMLToken is an XML start element.

Returns:

true if this XMLToken is an XML start element, false otherwise.

isText

public boolean isText()

Returns true or false depending on whether this XMLToken is an XML text element.

Returns:

true if this XMLToken is an XML text element, false otherwise.

removeAttr

public int removeAttr(int n)

Removes an attribute with the given index from the attribute set in this XMLToken. Nothing will be done if this XMLToken is not a start element.

Parameters:

n - an integer the index of the resource to be deleted

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• JSBML.OPERATION_SUCCESS
• JSBML.OPERATION_FAILED
• JSBML.INDEX_EXCEEDS_SIZE

removeAttr

public int removeAttr(java.lang.String name)

Removes an attribute with the given local name from the attribute set in this XMLToken. Nothing will be done if this XMLToken is not a start element.

Parameters:

name - a string, the local name of the attribute.

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• JSBML.OPERATION_SUCCESS
• JSBML.OPERATION_FAILED

removeAttr

public int removeAttr(java.lang.String name,
                      java.lang.String uri)

Removes an attribute with the given local name and namespace URI from the attribute set in this XMLToken. Nothing will be done if this XMLToken is not a start element.

Parameters:

name - a string, the local name of the attribute.

uri - a string, the namespace URI of the attribute.

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• JSBML.OPERATION_SUCCESS
• JSBML.OPERATION_FAILED

removeAttr

public int removeAttr(XMLTriple triple)

Removes an attribute with the given XMLTriple from the attribute set in this XMLToken. Nothing will be done if this XMLToken is not a start element.

Parameters:

triple - an XMLTriple, the XML triple of the attribute.

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• JSBML.OPERATION_SUCCESS
• JSBML.OPERATION_FAILED

removeNamespace

public int removeNamespace(int index)

Removes an XML Namespace stored in the given position of the XMLNamespaces of this XMLToken. Nothing will be done if this XMLToken is not a start element.

Parameters:

index - an integer, position of the removed namespace.

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• JSBML.OPERATION_SUCCESS
• JSBML.OPERATION_FAILED
• JSBML.INDEX_EXCEEDS_SIZE

removeNamespace

public int removeNamespace(java.lang.String prefix)

Removes an XML Namespace with the given prefix. Nothing will be done if this XMLToken is not a start element.

Parameters:

prefix - a string, prefix of the required namespace.

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• JSBML.OPERATION_SUCCESS
• JSBML.OPERATION_FAILED

setAttributes

public int setAttributes(XMLAttributes attributes)

Sets an XMLAttributes to this XMLToken. Nothing will be done if this XMLToken is not a start element.

Parameters:

attributes - XMLAttributes to be set to this XMLToken.

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• JSBML.OPERATION_SUCCESS
• JSBML.OPERATION_FAILED

setCharacters

public void setCharacters(java.lang.String chars)

Sets the characters in this XMLToken.

Parameters:

chars - the characters to set

setEnd

public int setEnd()

Declares this XML start element is also an end element.

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• JSBML.OPERATION_SUCCESS

setEOF

public int setEOF()

Declares this XMLToken is an end-of-file (input) marker.

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• JSBML.OPERATION_SUCCESS
• JSBML.OPERATION_FAILED

setNamespaces

public int setNamespaces(XMLNamespaces namespaces)

Sets an XMLnamespaces to this XML element.

Nothing will be done if this XMLToken is not a start element.

Parameters:

namespaces - XMLNamespaces to be set to this XMLToken.

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• JSBML.OPERATION_SUCCESS
• JSBML.OPERATION_FAILED

setTriple

public int setTriple(XMLTriple triple)

Sets the XMLTripe (name, uri and prefix) of this XML element.

Nothing will be done if this XML element is a text node.

Parameters:

triple - XMLTriple to be added to this XML element.

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• JSBML.OPERATION_SUCCESS
• JSBML.OPERATION_FAILED

unsetEnd

public int unsetEnd()

Declares this XML start/end element is no longer an end element.

Returns:

integer value indicating success/failure of the function. The possible values returned by this function are:

• JSBML.OPERATION_SUCCESS