org.sbml.jsbml.xml

Class XMLNamespaces

java.lang.Object

org.sbml.jsbml.xml.XMLNamespaces

public class XMLNamespaces
extends java.lang.Object

Representation of XML Namespaces.

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.

This class serves to organize functionality for tracking XML namespaces in a document or data stream. The namespace declarations are stored as a list of pairs of XML namespace URIs and prefix strings. These correspond to the parts of a namespace declaration on an XML element. For example, in the following XML fragment,

<annotation>
    <mysim:nodecolors xmlns:mysim='urn:lsid:mysim.org'
         mysim:bgcolor='green' mysim:fgcolor='white'/>
</annotation>

there is one namespace declaration. Its URI is urn:lsid:mysim.org and its prefix is mysim. This pair could be stored as one item in an XMLNamespaces list.

XMLNamespaces provides various methods for manipulating the list of prefix-URI pairs. Individual namespaces stored in a given XMLNamespace object instance can be retrieved based on their index using getPrefix(int index), or by their characteristics such as their URI or position in the list.

Since:

0.8

Version:

$Rev: 1639 $

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.util.LinkedHashMap<java.lang.String,java.lang.String>	namespaces HashMap

Constructor Summary

Constructors

Constructor and Description
XMLNamespaces() Creates a new empty list of XML namespace declarations.
XMLNamespaces(XMLNamespaces orig) Copy constructor; creates a copy of this XMLNamespaces list.

Method Summary

Methods

Modifier and Type	Method and Description
int	add(java.lang.String uri) Appends an XML namespace URI with an empty prefix to this list of namespace declarations.
int	add(java.lang.String uri, java.lang.String prefix) Appends an XML namespace prefix and URI pair to this list of namespace declarations.
int	clear() Clears (deletes) all XML namespace declarations in this XMLNamespaces object.
XMLNamespaces	clone() Creates and returns a deep copy of this XMLNamespaces list.
boolean	equals(java.lang.Object sb) Equality comparison method for XMLNamespaces.
int	getIndex(java.lang.String uri) Gets the index of an XML namespace declaration by URI.
int	getIndexByPrefix(java.lang.String prefix) Gets the index of an XML namespace declaration by prefix.
int	getLength() Returns the total number of URI-and-prefix pairs stored in this particular XMLNamespaces instance.
java.lang.String	getPrefix(int index) Gets the prefix of an XML namespace declaration by its position.
java.lang.String	getPrefix(java.lang.String uri) Gets the prefix of an XML namespace declaration by its URI.
java.lang.String	getURI() Gets the URI of an XML namespace declaration by the empty prefix.
java.lang.String	getURI(int index) Gets the URI of an XML namespace declaration by its position.
java.lang.String	getURI(java.lang.String prefix) Gets the URI of an XML namespace declaration by its prefix.
int	hashCode() Returns a hashcode for this XMLNamespaces object.
boolean	hasNS(java.lang.String uri, java.lang.String prefix) Returns true or false depending on whether an XML Namespace with the given URI and prefix pair is contained in this XMLNamespaces list.
boolean	hasPrefix(java.lang.String prefix) Returns true or false depending on whether an XML Namespace with the given prefix is contained in this XMLNamespaces list.
boolean	hasURI(java.lang.String uri) Returns true or false depending on whether an XML Namespace with the given URI is contained in this XMLNamespaces list.
boolean	isEmpty() Returns true or false depending on whether this XMLNamespaces list is empty.
int	remove(int index) Removes an XML Namespace stored in the given position of this list.
int	remove(java.lang.String prefix) Removes an XML Namespace with the given prefix.

Methods inherited from class java.lang.Object

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

Field Detail

namespaces

java.util.LinkedHashMap<java.lang.String,java.lang.String> namespaces

HashMap

Constructor Detail

XMLNamespaces

public XMLNamespaces()

Creates a new empty list of XML namespace declarations.

XMLNamespaces

public XMLNamespaces(XMLNamespaces orig)

Copy constructor; creates a copy of this XMLNamespaces list.

Parameters:

orig - the XMLNamespaces object to copy

Method Detail

equals

public boolean equals(java.lang.Object sb)

Equality comparison method for XMLNamespaces.

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 XMLNamespaces object.

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code usable by Java methods that need them.

clone

public XMLNamespaces clone()

Creates and returns a deep copy of this XMLNamespaces list.

Overrides:

clone in class java.lang.Object

Returns:

a (deep) copy of this XMLNamespaces list.

add

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

Appends an XML namespace prefix and URI pair to this list of namespace declarations.

An XMLNamespace object stores a list of pairs of namespaces and their prefixes. If there is an XML namespace with the given uri prefix in this list, then its corresponding URI will be overwritten by the new uri. Calling programs could use one of the other XMLNamespaces methods, such as hasPrefix(String) and hasURI(String) to inquire whether a given prefix and/or URI is already present in this XMLNamespaces object.

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:

OPERATION_SUCCESS

add

public int add(java.lang.String uri)

Appends an XML namespace URI with an empty prefix to this list of namespace declarations.

An XMLNamespace object stores a list of pairs of namespaces and their prefixes. If there is an XML namespace with the given uri prefix in this list, then its corresponding URI will be overwritten by the new uri. Calling programs could use one of the other XMLNamespaces methods, such as hasPrefix(String) and hasURI(String) to inquire whether a given prefix and/or URI is already present in this XMLNamespaces object.

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:

OPERATION_SUCCESS

remove

public int remove(int index)

Removes an XML Namespace stored in the given position of this list.

Parameters:

index - an integer, position of the namespace to remove.

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 prefix)

Removes an XML Namespace with the given prefix.

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:

OPERATION_SUCCESS

See Also:

remove(int index)

clear

public int clear()

Clears (deletes) all XML namespace declarations in this XMLNamespaces object.

Returns:

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

OPERATION_SUCCESS

See Also:

remove(int index)

getIndex

public int getIndex(java.lang.String uri)

Gets the index of an XML namespace declaration by URI.

An XMLNamespace object stores a list of pairs of namespaces and their prefixes. If this XMLNamespaces object contains a pair with the given URI uri, this method returns its index in the list.

Parameters:

uri - a string, the URI of the sought-after namespace.

Returns:

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

getIndexByPrefix

public int getIndexByPrefix(java.lang.String prefix)

Gets the index of an XML namespace declaration by prefix.

An XMLNamespace object stores a list of pairs of namespaces and their prefixes. If this XMLNamespaces object contains a pair with the given prefix prefix, this method returns its index in the list.

Parameters:

prefix - a string, the prefix string of the sought-after namespace

Returns:

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

getLength

public int getLength()

Returns the total number of URI-and-prefix pairs stored in this particular XMLNamespaces instance.

Returns:

the number of namespaces in this list.

getPrefix

public java.lang.String getPrefix(int index)

Gets the prefix of an XML namespace declaration by its position.

An XMLNamespace object stores a list of pairs of namespaces and their prefixes. This method returns the prefix of the nth element in that list (if it exists). Callers should use XMLAttributes.getLength() first to find out how many namespaces are stored in the list.

Parameters:

index - an integer, position of the sought-after prefix

Returns:

the prefix of an XML namespace declaration in this list (by position), or an empty string if the index is out of range

See Also:

getLength()

getPrefix

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

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

An XMLNamespace object stores a list of pairs of namespaces and their prefixes. This method returns the prefix for a pair that has the given uri.

Parameters:

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

Returns:

the prefix of an XML namespace declaration given its URI, or an empty string if no such uri exists in this XMLNamespaces object

getURI

public java.lang.String getURI(int index)

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

An XMLNamespace object stores a list of pairs of namespaces and their prefixes. This method returns the URI of the nth element in that list (if it exists). Callers should use XMLAttributes.getLength() first to find out how many namespaces are stored in the list.

Parameters:

index - an integer, position of the required URI.

Returns:

the URI of an XML namespace declaration in this list (by position), or an empty string if the index is out of range.

See Also:

getLength()

getURI

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

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

An XMLNamespace object stores a list of pairs of namespaces and their prefixes. This method returns the namespace URI for a pair that has the given prefix.

Parameters:

prefix - a string, the prefix of the required URI

Returns:

the URI of an XML namespace declaration having the given prefix, or an empty string if no such prefix-and-URI pair exists in this XMLNamespaces object

See Also:

getURI()

getURI

public java.lang.String getURI()

Gets the URI of an XML namespace declaration by the empty prefix.

An XMLNamespace object stores a list of pairs of namespaces and their prefixes. This method returns the namespace URI for a pair that has the empty prefix.

Returns:

the URI of an XML namespace declaration having the empty prefix, or an empty string if no such prefix-and-URI pair exists in this XMLNamespaces object

See Also:

getURI()

isEmpty

public boolean isEmpty()

Returns true or false depending on whether this XMLNamespaces list is empty.

Returns:

true if this XMLNamespaces list is empty, false otherwise.

hasURI

public boolean hasURI(java.lang.String uri)

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

Parameters:

uri - a string, the uri for the namespace

Returns:

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

hasPrefix

public boolean hasPrefix(java.lang.String prefix)

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

Parameters:

prefix - a string, the prefix for the namespace

Returns:

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

hasNS

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

Returns true or false depending on whether an XML Namespace with the given URI and prefix pair is contained in this XMLNamespaces list.

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