Validator

Overview

Package

Class

Tree

Deprecated

Index

Help

XBRLAPI

A Java API for XBRL

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.xbrlapi.xlink
Class Validator

java.lang.Object
  org.xbrlapi.xlink.XLinkHandlerDefaultImpl
      org.xbrlapi.xlink.Validator

All Implemented Interfaces:: Serializable, XLinkHandler

public class Validator
extends XLinkHandlerDefaultImpl
extends XLinkHandlerDefaultImpl

Utility handler to perform validation of XLink content in XML documents

Author:: Geoffrey Shuetrim (geoff@galexy.net)
See Also:: Serialized Form

Constructor Summary
`Validator(File file)` Constructor that is given the URI of the document to be validated
`Validator(InputSource is)` Constructor that is given the URI of the document to be validated.
`Validator(URI uri)` Constructor that is given the URI of the document to be validated

Method Summary
`protected static void`	`badUsage(String message)` Report incorrect usage of the command line XLink validator
`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)` Record the error message
`Document`	`getResults()` Returns an XML DOM document that contains one message element (as a child of the root message element) for each of the errors and warnings generated during the validation process.
`static void`	`main(String[] args)` Enable commandline usage of the XLink validator
`void`	`printMessages()` Print the errors and warnings to System out
`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)` Record 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 org.xbrlapi.xlink.XLinkHandlerDefaultImpl
`equals, hashCode`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

Validator

public Validator(URI uri)

Constructor that is given the URI of the document to be validated

Parameters:: uri - The URI of the document to be validated

Validator

public Validator(File file)

Constructor that is given the URI of the document to be validated

Parameters:: file - The file to be validated

Validator

public Validator(InputSource is)

Constructor that is given the URI of the document to be validated.

Parameters:: is - The input source for the XML to be validated

Method Detail

getResults

public Document getResults()

Returns an XML DOM document that contains one message element (as a child of the root message element) for each of the errors and warnings generated during the validation process. The message elements contain a

type attribute that takes a value of "error" or "warning"
message attribute that is the text of the message
lName attribute containing the element local name
qName attribute containing the element local name
namespaceURI attribute containing the element's namespace URI
a duplicate of each of the attribute on the element that generated the message

Returns:: The DOM document containing the error messages and warning messages