org.sbml.jsbml.xml

Class XMLTriple

java.lang.Object

org.sbml.jsbml.xml.XMLTriple

public class XMLTriple
extends java.lang.Object

Representation of a qualified XML name.

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.

A 'triple' in the jsbml XML layer encapsulates the notion of qualified name, meaning an element name or an attribute name with an optional namespace qualifier. An XMLTriple instance carries up to three data items:

• The name of the attribute or element; that is, the attribute name as it appears in an XML document or data stream;

• The XML namespace prefix (if any) of the attribute. For example, in the following fragment of XML, the namespace prefix is the string mysim and it appears on both the element someelement and the attribute attribA. When both the element and the attribute are stored as XMLTriple objects, their prefix is mysim.

                  <mysim:someelement mysim:attribA='value' />
                  

• The XML namespace URI with which the prefix is associated. In XML, every namespace used must be declared and mapped to a URI.

XMLTriple objects are the lowest-level data item in the XML layer of jsbml. Other objects such as XMLToken make use of XMLTriple objects.

Since:

0.8

Version:

$Rev: 1639 $

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	name
private java.lang.String	namespaceURI
private java.lang.String	prefix

Constructor Summary

Constructors

Constructor and Description
XMLTriple() Creates a new, empty XMLTriple.
XMLTriple(java.lang.String triplet) Creates a new XMLTriple by splitting the given triplet separated by space.
XMLTriple(java.lang.String triplet, char sepchar) Creates a new XMLTriple by splitting the given triplet on the separator character sepchar.
XMLTriple(java.lang.String name, java.lang.String uri, java.lang.String prefix) Creates a new XMLTriple with the given name, uri and and prefix.
XMLTriple(XMLTriple orig) Creates a copy of this XMLTriple set.

Method Summary

Methods

Modifier and Type	Method and Description
XMLTriple	clone() Creates and returns a deep copy of this XMLTriple set.
boolean	equals(java.lang.Object sb) Equality comparison method for XMLTriple.
java.lang.String	getName() Returns the name portion of this XMLTriple.
java.lang.String	getPrefix() Returns the prefix portion of this XMLTriple.
java.lang.String	getPrefixedName() Returns the prefixed name from this XMLTriple.
java.lang.String	getURI() Returns the URI portion of this XMLTriple.
int	hashCode() Returns a hashcode for this XMLTriple object.
boolean	isEmpty() Deprecated. libSBML internal
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

name

private java.lang.String name

prefix

private java.lang.String prefix

namespaceURI

private java.lang.String namespaceURI

Constructor Detail

XMLTriple

public XMLTriple()

Creates a new, empty XMLTriple.

XMLTriple

public XMLTriple(java.lang.String name,
         java.lang.String uri,
         java.lang.String prefix)

Creates a new XMLTriple with the given name, uri and and prefix.

Parameters:

name - a string, name for the XMLTriple.

uri - a string, URI of the XMLTriple.

prefix - a string, prefix for the URI of the XMLTriple,

XMLTriple

public XMLTriple(java.lang.String triplet,
         char sepchar)

Creates a new XMLTriple by splitting the given triplet on the separator character sepchar.

Triplet may be in one of the following formats:

• name
• uri sepchar name
• uri sepchar name sepchar prefix

Parameters:

triplet - a string representing the triplet as above

sepchar - a character, the sepchar used in the triplet

XMLTriple

public XMLTriple(java.lang.String triplet)

Creates a new XMLTriple by splitting the given triplet separated by space.

Triplet may be in one of the following formats:

• name
• uri name
• uri name prefix

Parameters:

triplet - a string representing the triplet as above

XMLTriple

public XMLTriple(XMLTriple orig)

Creates a copy of this XMLTriple set.

Method Detail

equals

public boolean equals(java.lang.Object sb)

Equality comparison method for XMLTriple.

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

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code usable by Java methods that need them.

clone

public XMLTriple clone()

Creates and returns a deep copy of this XMLTriple set.

Overrides:

clone in class java.lang.Object

Returns:

a (deep) copy of this XMLTriple set.

getName

public java.lang.String getName()

Returns the name portion of this XMLTriple.

Returns:

a string, the name from this XMLTriple.

getPrefix

public java.lang.String getPrefix()

Returns the prefix portion of this XMLTriple.

Returns:

a string, the prefix portion of this XMLTriple.

getURI

public java.lang.String getURI()

Returns the URI portion of this XMLTriple.

Returns:

URI a string, the prefix portion of this XMLTriple.

getPrefixedName

public java.lang.String getPrefixedName()

Returns the prefixed name from this XMLTriple.

Returns:

a string, the prefixed name from this XMLTriple.

isEmpty

@Deprecated
public boolean isEmpty()

Deprecated. libSBML internal

Predicate returning true or false depending on whether this XMLTriple is empty.

Returns:

true if this XMLTriple is empty, false otherwise.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object