com.batavia.xml
Interface XmlDocument

All Known Subinterfaces:

InstanceDocument, LinkbaseDocument, RegularSchema, TaxonomyDocument, TaxonomySchema, ValidationDocument, XbrlDocument

public interface XmlDocument

Interface for all types of documents in XBRL environment.

XbrlDocuments should be able to initilize based on a system id or uri that points to the location containing the xbrl data.

Copyright 2006 J2R BV, The Netherlands.

Part of Licensed Materials.

www.batavia-xbrl.com

Author:

Ron van Ardenne

Method Summary

void	fromXml(java.lang.String uri) Initilize based on a system id or uri that points to the location containing the xbrl data.
XmlElement	getRoot() Get the root element for this document.
java.lang.String	getSystemId() Get the system id or uri that points to the location containing the xbrl data.
void	setRoot(XmlElement root) SetImpl the root element for this document.
void	setSystemId(java.lang.String systemId) SetImpl the system id foor this document.
void	toXml(org.xml.sax.ContentHandler contentHandler) Pass the content of this document to the given Contenthandler through SAX events. delagate to the children
void	toXml(java.io.OutputStream data) Write the content of this document to the given OutputStream. delagate to the children
boolean	validate(ValidationDocument msgs) Validate this xbrl part (of the instance and/or its supporting discoverable taxonomy set) and add messages on any problem to the given XbrlValidationMessagesImpl collection.

Method Detail

fromXml

void fromXml(java.lang.String uri)
             throws XbrlException

Initilize based on a system id or uri that points to the location containing the xbrl data. throws XbrlException in case of fatal error for this document

Throws:

XbrlException

getRoot

XmlElement getRoot()

Get the root element for this document.

Returns:

Returns the root.

getSystemId

java.lang.String getSystemId()

Get the system id or uri that points to the location containing the xbrl data.

Returns:

String the system id.

setRoot

void setRoot(XmlElement root)

SetImpl the root element for this document.

Parameters:

root - The root to set.

setSystemId

void setSystemId(java.lang.String systemId)

SetImpl the system id foor this document.

Parameters:

systemId - The systemId to set.

toXml

void toXml(java.io.OutputStream data)
           throws XbrlException

Write the content of this document to the given OutputStream. delagate to the children

Throws:

XbrlException

toXml

void toXml(org.xml.sax.ContentHandler contentHandler)
           throws XbrlException

Pass the content of this document to the given Contenthandler through SAX events. delagate to the children

Throws:

XbrlException

validate

boolean validate(ValidationDocument msgs)

Validate this xbrl part (of the instance and/or its supporting discoverable taxonomy set) and add messages on any problem to the given XbrlValidationMessagesImpl collection.

Parameters:

msgs - The messages that indicate the problems with the instance and or its supporting. Empty when there are no problems. taxonomy set

Returns:

true if there ar no problems with this XbrlElement