XBRLAPI

A Java API for XBRL


org.xbrlapi.xlink
Class XLinkHandlerDefaultImpl

java.lang.Object
  extended by org.xbrlapi.xlink.XLinkHandlerDefaultImpl
All Implemented Interfaces:
Serializable, XLinkHandler
Direct Known Subclasses:
Validator, XBRLXLinkHandlerImpl

public class XLinkHandlerDefaultImpl
extends Object
implements XLinkHandler, Serializable

See Also:
Serialized Form

Constructor Summary
XLinkHandlerDefaultImpl()
          Default XLink handler constructor
 
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.
 boolean equals(Object obj)
           
 void error(String namespaceURI, String lName, String qName, Attributes attrs, String message)
          Default error behaviour is to throw an XLink Exception
 int hashCode()
           
 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)
          Default warning behaviour is to ignore the warning
 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.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XLinkHandlerDefaultImpl

public XLinkHandlerDefaultImpl()
Default XLink handler constructor

Method Detail

startSimpleLink

public void startSimpleLink(String namespaceURI,
                            String lName,
                            String qName,
                            Attributes attrs,
                            String href,
                            String role,
                            String arcrole,
                            String title,
                            String show,
                            String actuate)
                     throws XLinkException
Description copied from interface: XLinkHandler
Handles the start of processing a simple link (and custom links).

Specified by:
startSimpleLink in interface XLinkHandler
Throws:
XLinkException
See Also:
XLinkHandler.startSimpleLink(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)

endSimpleLink

public void endSimpleLink(String namespaceURI,
                          String sName,
                          String qName)
                   throws XLinkException
Description copied from interface: XLinkHandler
Handles straight pass through of SAX event for the end of simple link elements.

Specified by:
endSimpleLink in interface XLinkHandler
Throws:
XLinkException
See Also:
XLinkHandler.endSimpleLink(java.lang.String, java.lang.String, java.lang.String)

startTitle

public void startTitle(String namespaceURI,
                       String lName,
                       String qName,
                       Attributes attrs)
                throws XLinkException
Description copied from interface: XLinkHandler
Handles straight pass through of SAX event for XLink title elements

Specified by:
startTitle in interface XLinkHandler
Throws:
XLinkException
See Also:
XLinkHandler.startTitle(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)

endTitle

public void endTitle(String namespaceURI,
                     String sName,
                     String qName)
              throws XLinkException
Description copied from interface: XLinkHandler
Handles straight pass through of SAX event for the end of simple title elements.

Specified by:
endTitle in interface XLinkHandler
Throws:
XLinkException
See Also:
XLinkHandler.endTitle(java.lang.String, java.lang.String, java.lang.String)

titleCharacters

public void titleCharacters(char[] buf,
                            int offset,
                            int len)
                     throws XLinkException
Description copied from interface: XLinkHandler
Handles the character content of a title element

Specified by:
titleCharacters in interface XLinkHandler
Throws:
XLinkException
See Also:
XLinkHandler.titleCharacters(char[], int, int)

startExtendedLink

public void startExtendedLink(String namespaceURI,
                              String lName,
                              String qName,
                              Attributes attrs,
                              String role,
                              String title)
                       throws XLinkException
Description copied from interface: XLinkHandler
Handles the start of processing an extended link.

Specified by:
startExtendedLink in interface XLinkHandler
Throws:
XLinkException
See Also:
XLinkHandler.startExtendedLink(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes, java.lang.String, java.lang.String)

endExtendedLink

public void endExtendedLink(String namespaceURI,
                            String sName,
                            String qName)
                     throws XLinkException
Description copied from interface: XLinkHandler
Handles straight pass through of SAX event for the end of extended link elements.

Specified by:
endExtendedLink in interface XLinkHandler
Throws:
XLinkException
See Also:
XLinkHandler.endExtendedLink(java.lang.String, java.lang.String, java.lang.String)

startResource

public void startResource(String namespaceURI,
                          String lName,
                          String qName,
                          Attributes attrs,
                          String role,
                          String title,
                          String label)
                   throws XLinkException
Description copied from interface: XLinkHandler
Handles the start of processing a local resource.

Specified by:
startResource in interface XLinkHandler
Throws:
XLinkException
See Also:
XLinkHandler.startResource(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes, java.lang.String, java.lang.String, java.lang.String)

endResource

public void endResource(String namespaceURI,
                        String sName,
                        String qName)
                 throws XLinkException
Description copied from interface: XLinkHandler
Handles straight pass through of SAX event for the end of local resources.

Specified by:
endResource in interface XLinkHandler
Throws:
XLinkException
See Also:
XLinkHandler.endResource(java.lang.String, java.lang.String, java.lang.String)

startLocator

public void startLocator(String namespaceURI,
                         String lName,
                         String qName,
                         Attributes attrs,
                         String href,
                         String role,
                         String title,
                         String label)
                  throws XLinkException
Description copied from interface: XLinkHandler
Handles the start of processing a locator.

Specified by:
startLocator in interface XLinkHandler
Throws:
XLinkException
See Also:
XLinkHandler.startLocator(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes, java.lang.String, java.lang.String, java.lang.String, java.lang.String)

endLocator

public void endLocator(String namespaceURI,
                       String sName,
                       String qName)
                throws XLinkException
Description copied from interface: XLinkHandler
Handles straight pass through of SAX event for the end of locators.

Specified by:
endLocator in interface XLinkHandler
Throws:
XLinkException
See Also:
XLinkHandler.endLocator(java.lang.String, java.lang.String, java.lang.String)

startArc

public void startArc(String namespaceURI,
                     String lName,
                     String qName,
                     Attributes attrs,
                     String from,
                     String to,
                     String arcrole,
                     String title,
                     String show,
                     String actuate)
              throws XLinkException
Description copied from interface: XLinkHandler
Handles the start of processing an arc.

Specified by:
startArc in interface XLinkHandler
Throws:
XLinkException
See Also:
XLinkHandler.startArc(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)

endArc

public void endArc(String namespaceURI,
                   String sName,
                   String qName)
            throws XLinkException
Description copied from interface: XLinkHandler
Handles straight pass through of SAX event for the end of simple link elements.

Specified by:
endArc in interface XLinkHandler
Throws:
XLinkException
See Also:
XLinkHandler.endArc(java.lang.String, java.lang.String, java.lang.String)

xmlBaseStart

public void xmlBaseStart(String value)
                  throws XLinkException
Description copied from interface: XLinkHandler
Handles the start of an element, providing any XML Base attribute value.

Specified by:
xmlBaseStart in interface XLinkHandler
Parameters:
value - The value of the XML Base attribute
Throws:
XLinkException
See Also:
XLinkHandler.xmlBaseStart(java.lang.String)

xmlBaseEnd

public void xmlBaseEnd()
                throws XLinkException
Description copied from interface: XLinkHandler
Handles end of an element so that XML base related operations can to done

Specified by:
xmlBaseEnd in interface XLinkHandler
Throws:
XLinkException
See Also:
XLinkHandler.xmlBaseEnd()

error

public void error(String namespaceURI,
                  String lName,
                  String qName,
                  Attributes attrs,
                  String message)
           throws XLinkException
Default error behaviour is to throw an XLink Exception

Specified by:
error in interface XLinkHandler
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
See Also:
XLinkHandler.error(java.lang.String,java.lang.String, java.lang.String, org.xml.sax.Attributes, java.lang.String)

warning

public void warning(String namespaceURI,
                    String lName,
                    String qName,
                    Attributes attrs,
                    String message)
             throws XLinkException
Default warning behaviour is to ignore the warning

Specified by:
warning in interface XLinkHandler
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
See Also:
XLinkHandler.warning(java.lang.String,java.lang.String, java.lang.String, org.xml.sax.Attributes, java.lang.String)

hashCode

public int hashCode()
Overrides:
hashCode in class Object
See Also:
Object.hashCode()

equals

public boolean equals(Object obj)
Overrides:
equals in class Object
See Also:
Object.equals(java.lang.Object)

Get Java XBRL API implementation at SourceForge.net.