com.ihr.xbrl.om.sax

Class XBRLDocumentInfo

java.lang.Object

com.ihr.xbrl.om.sax.XBRLDocumentInfo

public class XBRLDocumentInfo
extends java.lang.Object

This class contains information collected during SAX parsing of the XBRL document such as the document type and document included extended links, if the document is a schema it might contain embedded linkbases with extended links and that structure is collected here.

Author:

Ignacio

Constructor Summary

Constructors

Constructor and Description
XBRLDocumentInfo(DTSContainer dts) Instantiates a new XBRL document info.

Method Summary

Modifier and Type	Method and Description
void	addExtendedLinkNode(net.sf.saxon.om.NodeInfo ni) Adds the extended link node.
void	addLocator(net.sf.saxon.om.NodeInfo ni, java.lang.String label) Adds the locator.
void	addRelationship(net.sf.saxon.om.NodeInfo ni, java.lang.String arcroleURI) Adds the relationship.
void	addResource(net.sf.saxon.om.NodeInfo ni, java.lang.String label) Adds the resource.
void	clear() Clear.
XBRLDocumentInfo	createEmbedded() Creates the embedded.
KeyNodesCollected	getCollectedNodes() Gets the collected nodes.
java.util.LinkedList<XBRLDocumentInfo>	getEmbeddedLinkbases() Gets the embedded linkbases.
java.util.List<net.sf.saxon.om.NodeInfo>	getExtendedLinks() Gets the extended links.
XBRLDocumentInfo	getParent() Gets the parent.
XBRLDocument.XBRLDocumentType	getXbrlDocumentType() Gets the xbrl document type.
boolean	isEmpty() Checks if is empty.
void	removeAllEmbeddedLinkbases() Removes the all embedded linkbases.
void	removeAllExtendedLinks() Removes the all extended links.
void	setXbrlDocumentType(XBRLDocument.XBRLDocumentType documentType) Sets the xbrl document type.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XBRLDocumentInfo

public XBRLDocumentInfo(DTSContainer dts)

Instantiates a new XBRL document info.

Parameters:

dts - the dts

Method Detail

clear

public void clear()

Clear.

getParent

public XBRLDocumentInfo getParent()

Gets the parent.

Returns:

the parent

getCollectedNodes

public KeyNodesCollected getCollectedNodes()

Gets the collected nodes.

Returns:

the collected nodes

setXbrlDocumentType

public void setXbrlDocumentType(XBRLDocument.XBRLDocumentType documentType)

Sets the xbrl document type.

Parameters:

documentType - the new xbrl document type

getXbrlDocumentType

public XBRLDocument.XBRLDocumentType getXbrlDocumentType()

Gets the xbrl document type.

Returns:

the xbrl document type

createEmbedded

public XBRLDocumentInfo createEmbedded()

Creates the embedded.

Returns:

the XBRL document info

getEmbeddedLinkbases

public java.util.LinkedList<XBRLDocumentInfo> getEmbeddedLinkbases()

Gets the embedded linkbases.

Returns:

the embedded linkbases

addExtendedLinkNode

public void addExtendedLinkNode(net.sf.saxon.om.NodeInfo ni)

Adds the extended link node.

Parameters:

ni - the ni

getExtendedLinks

public java.util.List<net.sf.saxon.om.NodeInfo> getExtendedLinks()

Gets the extended links.

Returns:

the extended links

removeAllExtendedLinks

public void removeAllExtendedLinks()

Removes the all extended links.

removeAllEmbeddedLinkbases

public void removeAllEmbeddedLinkbases()

Removes the all embedded linkbases.

addResource

public void addResource(net.sf.saxon.om.NodeInfo ni,
                        java.lang.String label)

Adds the resource.

Parameters:

ni - the ni

label - the label

addLocator

public void addLocator(net.sf.saxon.om.NodeInfo ni,
                       java.lang.String label)

Adds the locator.

Parameters:

ni - the ni

label - the label

addRelationship

public void addRelationship(net.sf.saxon.om.NodeInfo ni,
                            java.lang.String arcroleURI)

Adds the relationship.

Parameters:

ni - the ni

arcroleURI - the arcrole URI

isEmpty

public boolean isEmpty()

Checks if is empty.

Returns:

true, if is empty