com.batavia.xml
Interface FullyQualifiedName

All Superinterfaces:

java.lang.Comparable, ComparablePart, org.relaxng.datatype.ValidationContext, XmlParticle

public interface FullyQualifiedName
extends XmlParticle

Interface for classes that hold a name with a prefix that indicates its namespace.

An XML namespace is a collection of names, identified by a URI reference [RFC2396], which are used in XML documents as element types and attribute names.

Names from XML namespaces may appear as qualified names, which contain a single colon, separating the name into a namespace prefix and a local part. The prefix, which is mapped to a URI reference, selects a namespace. The combination of the universally managed URI namespace and the document's own namespace produces identifiers that are universally unique.

FullyQualifiedName objects are the above specified Names from XML namespaces.

Copyright 2006 J2R BV, The Netherlands.

Part of Licensed Materials.

www.batavia-xbrl.com

Author:

Ron van Ardenne

Method Summary

FullyQualifiedName	createClone(XmlParticle newParent) Create a clones name with identical attributes
java.lang.String	getFullName(XmlParticle parent)
java.lang.String	getName()
NameSpace	getNameSpace()
java.lang.String	getNsUriFullName() returns the local name optionally prefixed with the full namespace uri if present.
java.lang.String	getPrefix(XmlParticle parent) If the prefix is null, the parent XmlParticle is requested for a prefix based on the namespace
boolean	isOptionalNoNamespace()
void	setName(java.lang.String name)
void	setNameSpace(NameSpace nameSpace)
void	setOptionalNoNamespace(boolean optionalNoNamespace)
java.lang.String	toString(XmlParticle parent) Convert this object to a string representation.

Methods inherited from interface com.batavia.xml.XmlParticle

destroy, getBaseUri, getNameSpace, getParent, getPrefix, getTargetNameSpace, isBoolean, isNumber, p_equal, resolveNamespacePrefix, setParent, toXstring

Methods inherited from interface com.batavia.xml.ComparablePart

c_equal, identical, s_equal, u_equal, v_equal, x_equal

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.relaxng.datatype.ValidationContext

isNotation, isUnparsedEntity

Method Detail

createClone

FullyQualifiedName createClone(XmlParticle newParent)

Create a clones name with identical attributes

Returns:

FullyQualifiedName clone

getFullName

java.lang.String getFullName(XmlParticle parent)

Returns:

Returns the fully qualified name incl prefix.

getName

java.lang.String getName()

Returns:

Returns the name.

getNameSpace

NameSpace getNameSpace()

Returns:

Returns the nameSpace.

getPrefix

java.lang.String getPrefix(XmlParticle parent)

If the prefix is null, the parent XmlParticle is requested for a prefix based on the namespace

Returns:

Returns the prefix.

setName

void setName(java.lang.String name)

Parameters:

name - The name to set.

setNameSpace

void setNameSpace(NameSpace nameSpace)

Parameters:

nameSpace - The nameSpace to set.

toString

java.lang.String toString(XmlParticle parent)

Convert this object to a string representation.

Returns:

fullname (prefix:name)

isOptionalNoNamespace

boolean isOptionalNoNamespace()

Returns:

Returns the optionalNoNamespace.

setOptionalNoNamespace

void setOptionalNoNamespace(boolean optionalNoNamespace)

Parameters:

optionalNoNamespace - The optionalNoNamespace to set.

getNsUriFullName

java.lang.String getNsUriFullName()

returns the local name optionally prefixed with the full namespace uri if present.

Returns:

uri prefixed name