org.sbml.jsbml.xml

Class XMLAttributes

java.lang.Object

org.sbml.jsbml.xml.XMLAttributes

public class XMLAttributes
extends java.lang.Object

Representation of the attributes on an XML node.

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: 1639 $

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.util.ArrayList<XMLTriple>	attributeNames
(package private) java.util.ArrayList<java.lang.String>	attributeValues

Constructor Summary

Constructors

Constructor and Description
XMLAttributes() Creates a new empty XMLAttributes set.
XMLAttributes(XMLAttributes orig) Copy constructor; creates a copy of this XMLAttributes set.

Method Summary

Methods

Modifier and Type	Method and Description
int	add(java.lang.String name, java.lang.String value) Adds an attribute (a name/value pair) to this XMLAttributes set optionally with a prefix and URI defining a namespace.
int	add(java.lang.String name, java.lang.String value, java.lang.String namespaceURI) Adds an attribute (a name/value pair) to this XMLAttributes set optionally with a prefix and URI defining a namespace.
int	add(java.lang.String name, java.lang.String value, java.lang.String namespaceURI, java.lang.String prefix) Adds an attribute (a name/value pair) to this XMLAttributes set optionally with a prefix and URI defining a namespace.
int	add(XMLTriple triple, java.lang.String value) Adds an attribute with the given XMLTriple/value pair to this XMLAttributes set.
int	clear() Clears (deletes) all attributes in this XMLAttributes object.
XMLAttributes	clone() Creates and returns a deep copy of this XMLAttributes set.
boolean	equals(java.lang.Object sb) Equality comparison method for XMLAttributes.
int	getIndex(java.lang.String name) Returns the index of an attribute with the given name.
int	getIndex(java.lang.String name, java.lang.String uri) Returns the index of an attribute with the given local name and namespace URI.
int	getIndex(XMLTriple triple) Returns the index of an attribute with the given XMLTriple.
int	getLength() Returns the number of attributes in the set.
java.lang.String	getName(int index) Returns the local name of an attribute in this XMLAttributes set (by position).
java.lang.String	getPrefix(int index) Returns the prefix of an attribute in this XMLAttributes set (by position).
java.lang.String	getPrefixedName(int index) Returns the prefixed name of an attribute in this XMLAttributes set (by position).
java.lang.String	getURI(int index) Returns the namespace URI of an attribute in this XMLAttributes set (by position).
java.lang.String	getValue(int index) Returns the value of an attribute in this XMLAttributes set (by position).
java.lang.String	getValue(java.lang.String name) Returns an attribute's value by name.
java.lang.String	getValue(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	getValue(XMLTriple triple) Returns a value of an attribute with the given XMLTriple.
boolean	hasAttribute(int index) Returns true or false depending on whether an attribute with the given index exists in this XMLAttributes.
boolean	hasAttribute(java.lang.String name) Returns true or false depending on whether an attribute with the given local name exists in this XMLAttributes.
boolean	hasAttribute(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 this XMLAttributes.
boolean	hasAttribute(XMLTriple triple) Returns true or false depending on whether an attribute with the given XML triple exists in this XMLAttributes.
int	hashCode() Returns a hashcode for this XMLAttributes object.
boolean	isEmpty() Returns true or false depending on whether this XMLAttributes set is empty.
int	remove(int n) Removes an attribute with the given index from this XMLAttributes set.
int	remove(java.lang.String name) Removes an attribute with the given local name from this XMLAttributes set.
int	remove(java.lang.String name, java.lang.String uri) Removes an attribute with the given local name and namespace URI from this XMLAttributes set.
int	remove(XMLTriple triple) Removes an attribute with the given XMLTriple from this XMLAttributes set.
int	removeResource(int n) Removes an attribute with the given index from this XMLAttributes set.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

attributeNames

java.util.ArrayList<XMLTriple> attributeNames

attributeValues

java.util.ArrayList<java.lang.String> attributeValues

Constructor Detail

XMLAttributes

public XMLAttributes()

Creates a new empty XMLAttributes set.

XMLAttributes

public XMLAttributes(XMLAttributes orig)

Copy constructor; creates a copy of this XMLAttributes set.

Method Detail

equals

public boolean equals(java.lang.Object sb)

Equality comparison method for XMLAttributes.

Overrides:

equals in class java.lang.Object

Parameters:

sb - a reference to an object to which the current object instance will be compared

Returns:

true if sb refers to the same underlying native object as this one, false otherwise

hashCode

public int hashCode()

Returns a hashcode for this XMLAttributes object.

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code usable by Java methods that need them.

clone

public XMLAttributes clone()

Creates and returns a deep copy of this XMLAttributes set.

Overrides:

clone in class java.lang.Object

Returns:

a (deep) copy of this XMLAttributes set.

add

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

Adds an attribute (a name/value pair) to this XMLAttributes set optionally with a prefix and URI defining a namespace.

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:

OPERATION_SUCCESS

add

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

Adds an attribute (a name/value pair) to this XMLAttributes set optionally with a prefix and URI defining a namespace.

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:

OPERATION_SUCCESS

add

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

Adds an attribute (a name/value pair) to this XMLAttributes set optionally with a prefix and URI defining a namespace.

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:

OPERATION_SUCCESS

add

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

Adds an attribute with the given XMLTriple/value pair to this XMLAttributes set.

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:

OPERATION_SUCCESS

removeResource

public int removeResource(int n)

Removes an attribute with the given index from this XMLAttributes set.

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:

OPERATION_SUCCESS

INDEX_EXCEEDS_SIZE

remove

public int remove(int n)

Removes an attribute with the given index from this XMLAttributes set. (This function is an alias of XMLAttributes.removeResource() ).

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:

OPERATION_SUCCESS

INDEX_EXCEEDS_SIZE

remove

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

Removes an attribute with the given local name and namespace URI from this XMLAttributes set.

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:

OPERATION_SUCCESS

OPERATION_FAILED;

remove

public int remove(java.lang.String name)

Removes an attribute with the given local name from this XMLAttributes set.

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:

OPERATION_SUCCESS

OPERATION_FAILED;

remove

public int remove(XMLTriple triple)

Removes an attribute with the given XMLTriple from this XMLAttributes set.

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:

OPERATION_SUCCESS

clear

public int clear()

Clears (deletes) all attributes in this XMLAttributes object.

Returns:

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

OPERATION_SUCCESS

getIndex

public int getIndex(java.lang.String name)

Returns the index of an attribute with the given name.

Parameters:

name - a string, the local name of the attribute for which the index is required.

Returns:

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

getIndex

public int getIndex(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.

getIndex

public int getIndex(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.

getLength

public int getLength()

Returns the number of attributes in the set.

Returns:

the number of attributes in this XMLAttributes set.

getName

public java.lang.String getName(int index)

Returns the local name of an attribute in this XMLAttributes set (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).

getPrefix

public java.lang.String getPrefix(int index)

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

Parameters:

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

Returns:

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

getPrefixedName

public java.lang.String getPrefixedName(int index)

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

Parameters:

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

Returns:

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

getURI

public java.lang.String getURI(int index)

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

Parameters:

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

Returns:

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

getValue

public java.lang.String getValue(int index)

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

Parameters:

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

Returns:

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

getValue

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

Returns an attribute's value by name.

Parameters:

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

Returns:

The attribute value as a string.

getValue

public java.lang.String getValue(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.

getValue

public java.lang.String getValue(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.

hasAttribute

public boolean hasAttribute(int index)

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

Parameters:

index - an integer, the position of the attribute.

Returns:

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

hasAttribute

public boolean hasAttribute(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 this XMLAttributes.

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 this XMLAttributes, false otherwise.

hasAttribute

public boolean hasAttribute(java.lang.String name)

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

Parameters:

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

Returns:

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

hasAttribute

public boolean hasAttribute(XMLTriple triple)

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

Parameters:

triple - an XMLTriple, the XML triple of the attribute

Returns:

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

isEmpty

public boolean isEmpty()

Returns true or false depending on whether this XMLAttributes set is empty.

Returns:

true if this XMLAttributes set is empty, false otherwise.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object