org.xbrlapi.xlink
Interface XLinkHandler

All Superinterfaces:

Serializable

All Known Implementing Classes:

Validator, XBRLXLinkHandlerImpl, XLinkHandlerDefaultImpl, XLinkHandlerImpl

public interface XLinkHandler
extends Serializable

Event handler for the XLink processor, responsible for performing the user required responses to the XLink structures being processed by the XLink processor. The XLink handler is very similar in nature to the SAX content handler. The XLink processor receives events from the SAX parser that is parsing in the XLinks and then passes those events through to the nominated XLinkHandler, augmented with a range of state information relating to where abouts in an XLink structure the XLink event has been triggered from.

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

void	endArc(String namespaceURI, String sName, String qName) Handles straight pass through of SAX event for the end of simple link elements.
void	endExtendedLink(String namespaceURI, String sName, String qName) Handles straight pass through of SAX event for the end of extended link elements.
void	endLocator(String namespaceURI, String sName, String qName) Handles straight pass through of SAX event for the end of locators.
void	endResource(String namespaceURI, String sName, String qName) Handles straight pass through of SAX event for the end of local resources.
void	endSimpleLink(String namespaceURI, String sName, String qName) Handles straight pass through of SAX event for the end of simple link elements.
void	endTitle(String namespaceURI, String sName, String qName) Handles straight pass through of SAX event for the end of simple title elements.
void	error(String namespaceURI, String lName, String qName, Attributes attrs, String message) Handle an error message from the XLink processor allowing the handler to decide how seriously to take the error.
void	startArc(String namespaceURI, String lName, String qName, Attributes attrs, String from, String to, String arcrole, String title, String show, String actuate) Handles the start of processing an arc.
void	startExtendedLink(String namespaceURI, String lName, String qName, Attributes attrs, String role, String title) Handles the start of processing an extended link.
void	startLocator(String namespaceURI, String lName, String qName, Attributes attrs, String href, String role, String title, String label) Handles the start of processing a locator.
void	startResource(String namespaceURI, String lName, String qName, Attributes attrs, String role, String title, String label) Handles the start of processing a local resource.
void	startSimpleLink(String namespaceURI, String lName, String qName, Attributes attrs, String href, String role, String arcrole, String title, String show, String actuate) Handles the start of processing a simple link (and custom links).
void	startTitle(String namespaceURI, String lName, String qName, Attributes attrs) Handles straight pass through of SAX event for XLink title elements
void	titleCharacters(char[] buf, int offset, int len) Handles the character content of a title element
void	warning(String namespaceURI, String lName, String qName, Attributes attrs, String message) Handle a warning that the document may not be doing what the creator of the XLink intended
void	xmlBaseEnd() Handles end of an element so that XML base related operations can to done
void	xmlBaseStart(String value) Handles the start of an element, providing any XML Base attribute value.

Method Detail

startSimpleLink

void startSimpleLink(String namespaceURI,
                     String lName,
                     String qName,
                     Attributes attrs,
                     String href,
                     String role,
                     String arcrole,
                     String title,
                     String show,
                     String actuate)
                     throws XLinkException

Handles the start of processing a simple link (and custom links).

Parameters:

namespaceURI -

lName -

qName -

attrs -

href -

role -

arcrole -

title -

show -

actuate -

Throws:

XLinkException

endSimpleLink

void endSimpleLink(String namespaceURI,
                   String sName,
                   String qName)
                   throws XLinkException

Handles straight pass through of SAX event for the end of simple link elements.

Parameters:

namespaceURI -

sName -

qName -

Throws:

XLinkException

startTitle

void startTitle(String namespaceURI,
                String lName,
                String qName,
                Attributes attrs)
                throws XLinkException

Handles straight pass through of SAX event for XLink title elements

Parameters:

namespaceURI -

lName -

qName -

attrs -

Throws:

XLinkException

endTitle

void endTitle(String namespaceURI,
              String sName,
              String qName)
              throws XLinkException

Handles straight pass through of SAX event for the end of simple title elements.

Parameters:

namespaceURI -

sName -

qName -

Throws:

XLinkException

titleCharacters

void titleCharacters(char[] buf,
                     int offset,
                     int len)
                     throws XLinkException

Handles the character content of a title element

Parameters:

buf -

offset -

len -

Throws:

XLinkException

startExtendedLink

void startExtendedLink(String namespaceURI,
                       String lName,
                       String qName,
                       Attributes attrs,
                       String role,
                       String title)
                       throws XLinkException

Handles the start of processing an extended link.

Parameters:

namespaceURI -

lName -

qName -

attrs -

role -

title -

Throws:

XLinkException

endExtendedLink

void endExtendedLink(String namespaceURI,
                     String sName,
                     String qName)
                     throws XLinkException

Handles straight pass through of SAX event for the end of extended link elements.

Parameters:

namespaceURI -

sName -

qName -

Throws:

XLinkException

startResource

void startResource(String namespaceURI,
                   String lName,
                   String qName,
                   Attributes attrs,
                   String role,
                   String title,
                   String label)
                   throws XLinkException

Handles the start of processing a local resource.

Parameters:

namespaceURI -

lName -

qName -

attrs -

role -

title -

label -

Throws:

XLinkException

endResource

void endResource(String namespaceURI,
                 String sName,
                 String qName)
                 throws XLinkException

Handles straight pass through of SAX event for the end of local resources.

Parameters:

namespaceURI -

sName -

qName -

Throws:

XLinkException

startLocator

void startLocator(String namespaceURI,
                  String lName,
                  String qName,
                  Attributes attrs,
                  String href,
                  String role,
                  String title,
                  String label)
                  throws XLinkException

Handles the start of processing a locator.

Parameters:

namespaceURI -

lName -

qName -

attrs -

href -

role -

title -

label -

Throws:

XLinkException

endLocator

void endLocator(String namespaceURI,
                String sName,
                String qName)
                throws XLinkException

Handles straight pass through of SAX event for the end of locators.

Parameters:

namespaceURI -

sName -

qName -

Throws:

XLinkException

startArc

void startArc(String namespaceURI,
              String lName,
              String qName,
              Attributes attrs,
              String from,
              String to,
              String arcrole,
              String title,
              String show,
              String actuate)
              throws XLinkException

Handles the start of processing an arc.

Parameters:

namespaceURI -

lName -

qName -

attrs -

from -

to -

arcrole -

title -

show -

actuate -

Throws:

XLinkException

endArc

void endArc(String namespaceURI,
            String sName,
            String qName)
            throws XLinkException

Handles straight pass through of SAX event for the end of simple link elements.

Parameters:

namespaceURI -

sName -

qName -

Throws:

XLinkException

xmlBaseStart

void xmlBaseStart(String value)
                  throws XLinkException

Handles the start of an element, providing any XML Base attribute value.

Parameters:

value - The value of the XML Base attribute

Throws:

XLinkException

xmlBaseEnd

void xmlBaseEnd()
                throws XLinkException

Handles end of an element so that XML base related operations can to done

Throws:

XLinkException

error

void error(String namespaceURI,
           String lName,
           String qName,
           Attributes attrs,
           String message)
           throws XLinkException

Handle an error message from the XLink processor allowing the handler to decide how seriously to take the error.

Parameters:

namespaceURI - Namespace of the element generating the error

lName - local name of the element generating the error

qName - qName of the element generating the error

attrs - attributes of the element generating the error

message - The text of the error message

Throws:

XLinkException - if the handler does not deal with the XLink problem internally

warning

void warning(String namespaceURI,
             String lName,
             String qName,
             Attributes attrs,
             String message)
             throws XLinkException

Handle a warning that the document may not be doing what the creator of the XLink intended

Parameters:

namespaceURI - Namespace of the element generating the error

lName - local name of the element generating the error

qName - qName of the element generating the error

attrs - attributes of the element generating the error

message - The text of the warning message

Throws:

XLinkException - if the handler does not deal with the XLink warning internally