org.xbrlapi.xlink.handler

Class XBRLCustomLinkRecogniserImpl

java.lang.Object

org.xbrlapi.xlink.CustomLinkRecogniser

org.xbrlapi.xlink.handler.XBRLCustomLinkRecogniserImpl

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CustomLinkRecogniserImpl

public class XBRLCustomLinkRecogniserImpl
extends CustomLinkRecogniser

This class provides an example custom link recogniser tailored to the needs of the non-xlink links used by XBRL.

Author:

Geoffrey Shuetrim (geoff@galexy.net)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
XBRLCustomLinkRecogniserImpl() Constructor for the XBRL custom link recogniser

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getHref(java.lang.String namespaceURI, java.lang.String lName, java.lang.String qName, org.xml.sax.Attributes attrs) Get the href from the custom link
boolean	isLink(java.lang.String namespaceURI, java.lang.String lName, java.lang.String qName, org.xml.sax.Attributes attrs) Returns true if the element with the supplied characteristics is a custom simple link.

Methods inherited from class org.xbrlapi.xlink.CustomLinkRecogniser

equals, getActuate, getArcrole, getRole, getShow, getTitle, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

XBRLCustomLinkRecogniserImpl

public XBRLCustomLinkRecogniserImpl()

Constructor for the XBRL custom link recogniser

Method Detail

isLink

public boolean isLink(java.lang.String namespaceURI,
             java.lang.String lName,
             java.lang.String qName,
             org.xml.sax.Attributes attrs)

Description copied from class: CustomLinkRecogniser

Returns true if the element with the supplied characteristics is a custom simple link. Importantly his method can be called from a SAX start element event and from a SAX end element event.

Specified by:

isLink in class CustomLinkRecogniser

Parameters:

namespaceURI - The namespace of the element.

lName - The localname of the element.

qName - The QName of the element.

attrs - The attributes of the element.

Returns:

true if the element is a custom simple link and false otherwise.

See Also:

CustomLinkRecogniser.isLink(String, String, String, Attributes)

getHref

public java.lang.String getHref(java.lang.String namespaceURI,
                       java.lang.String lName,
                       java.lang.String qName,
                       org.xml.sax.Attributes attrs)
                         throws XLinkException

Get the href from the custom link

Specified by:

getHref in class CustomLinkRecogniser

Returns:

the href

Throws:

XLinkException