com.ihr.xbrl.om

Class XBRLNamespaceContext

java.lang.Object

com.ihr.xbrl.om.XBRLNamespaceContext

All Implemented Interfaces:

javax.xml.namespace.NamespaceContext, net.sf.saxon.om.NamespaceResolver

Direct Known Subclasses:

HTMLHandlerNamespaceContext, TransformNamespaceContext

public class XBRLNamespaceContext
extends java.lang.Object
implements javax.xml.namespace.NamespaceContext, net.sf.saxon.om.NamespaceResolver

This class handles resolution of prefixes to namespaces and vice-versa. This class plays the role of an XPE Namespace Context and a Saxon NamespaceResolver.

Static namespaces defined in this class includes:

xml : XBRL.XML_baseNS
xbrli : XBRL.XBRL_instanceNS
link : XBRL.XBRL_linkbaseNS
xlink : XBRL.XLINK_NS
xl : XBRL.XBRL_xlNS
f : http://xbrl.org/2007/formula
vl : XBRL.XBRL_version_2006_NS
xs : XBRL.XML_schemaNS
xu : http://www.xmldb.org/xupdate
--- removed --- xfi : http://www.xbrl.org/2005/function/instance
xfid : http://www.xbrl.org/2005/function/instance/dimensions
xsi : XBRL.XSI_NS
xbrldt : XBRL.XBRL_dimension_t_NS
xbrldi : XBRL.XBRL_dimension_i_NS
ver : XBRL.XBRL_versionNS
ixbrl : XBRL.XBRL_inlineNS

It is possible to dynamically add new prefixes and namespaces to this object
This class can contain a fallBack class if the prefix cannot be resolved by this class.

Author:

Ignacio

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	rsInternalPrefix Prefix to be added to standard prefixes to allow RS code to refer to namespaces using own own prefixes and avoid collisions with prefixes in incoming files.

Constructor Summary

Constructors

Constructor and Description
XBRLNamespaceContext() Instantiates a new XBRL namespace context.

Method Summary

Modifier and Type	Method and Description
void	addNamespace(java.lang.String prefix, java.lang.String namespace) Adds the namespace.
void	clear() Clear.
void	delNamespace(java.lang.String uri) Only non static namespaces can be deleted.
static java.lang.String	fixRemoveRSPrefix(java.lang.String prefix) The RS API uses internally a set of static prefixes that identifies the namespaces defined in the specifications.
java.lang.String	getNamespaceURI(java.lang.String prefix) Gets the namespace URI.
java.lang.String	getPrefix(java.lang.String s) Gets the prefix.
java.util.Iterator<java.lang.String>	getPrefixes(java.lang.String s) Gets the prefixes.
static java.lang.String	getStaticNamespaceURI(java.lang.String prefix) Returns the statically assigned namespace URI for the corresponding prefix or null if the namespace URI is not statically assigned.
static java.lang.String	getStaticPrefix(java.lang.String namespace) Returns the statically assigned prefix for the corresponding namespace URI or null if the prefix is not statically assigned.
java.lang.String	getURIForPrefix(java.lang.String prefix, boolean useDefault) Gets the URI for prefix.
java.util.Iterator<java.lang.String>	iteratePrefixes() Iterate prefixes.
void	setFallBackNamespaceContext(net.sf.saxon.om.NamespaceResolver fallbackNamespaceContext) If the namespace is not found in this namespace context try the next one in the chain This method does not work with Saxon NamespaceResolver(s).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

rsInternalPrefix

public static final java.lang.String rsInternalPrefix

Prefix to be added to standard prefixes to allow RS code to refer to namespaces using own own prefixes and avoid collisions with prefixes in incoming files.

See Also:

Constant Field Values

Constructor Detail

XBRLNamespaceContext

public XBRLNamespaceContext()

Instantiates a new XBRL namespace context.

Method Detail

clear

public void clear()

Clear.

addNamespace

public void addNamespace(java.lang.String prefix,
                         java.lang.String namespace)

Adds the namespace.

Parameters:

prefix - the prefix

namespace - the namespace

delNamespace

public void delNamespace(java.lang.String uri)

Only non static namespaces can be deleted.

Parameters:

uri - the uri

getNamespaceURI

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

Gets the namespace URI.

Specified by:

getNamespaceURI in interface javax.xml.namespace.NamespaceContext

Parameters:

prefix - the prefix

Returns:

the namespace URI

getStaticNamespaceURI

public static java.lang.String getStaticNamespaceURI(java.lang.String prefix)

Returns the statically assigned namespace URI for the corresponding prefix or null if the namespace URI is not statically assigned.

Parameters:

prefix - the prefix

Returns:

the static namespace uri

getStaticPrefix

public static java.lang.String getStaticPrefix(java.lang.String namespace)

Returns the statically assigned prefix for the corresponding namespace URI or null if the prefix is not statically assigned.

Parameters:

namespace - the namespace

Returns:

the static prefix

fixRemoveRSPrefix

public static java.lang.String fixRemoveRSPrefix(java.lang.String prefix)

The RS API uses internally a set of static prefixes that identifies the namespaces defined in the specifications. In order to avoid collisions between standard prefixes and prefixes in our code we decided to add a custom prefix on the standard prefixes. The custom prefix value is "_rs__" plus the standard prefix.

Parameters:

prefix - the prefix to check to remove the custom prefix

Returns:

This method returns the standard prefix of a namespace after removing the custom prefix if it is part of the prefix parameter. This method returns the same prefix received in all other cases

getPrefix

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

Gets the prefix.

Specified by:

getPrefix in interface javax.xml.namespace.NamespaceContext

Parameters:

s - the s

Returns:

the prefix

getPrefixes

public java.util.Iterator<java.lang.String> getPrefixes(java.lang.String s)

Gets the prefixes.

Specified by:

getPrefixes in interface javax.xml.namespace.NamespaceContext

Parameters:

s - the s

Returns:

the prefixes

getURIForPrefix

public java.lang.String getURIForPrefix(java.lang.String prefix,
                                        boolean useDefault)

Gets the URI for prefix.

Specified by:

getURIForPrefix in interface net.sf.saxon.om.NamespaceResolver

Parameters:

prefix - the prefix

useDefault - the use default

Returns:

the URI for prefix

iteratePrefixes

public java.util.Iterator<java.lang.String> iteratePrefixes()

Iterate prefixes.

Specified by:

iteratePrefixes in interface net.sf.saxon.om.NamespaceResolver

Returns:

the iterator

setFallBackNamespaceContext

public void setFallBackNamespaceContext(net.sf.saxon.om.NamespaceResolver fallbackNamespaceContext)

If the namespace is not found in this namespace context try the next one in the chain This method does not work with Saxon NamespaceResolver(s). Only with NamespaceContext(s)

Parameters:

fallbackNamespaceContext - NamespaceContext