com.ihr.xbrl.om.instance

Class XBRLInstance

java.lang.Object

com.ihr.xbrl.om.XMLDocumentURI

com.ihr.xbrl.om.XBRLDocument

com.ihr.xbrl.om.instance.XBRLInstance

All Implemented Interfaces:

XBRLDTSDocument, XBRLHasDTSTarget, XBRLValidation, java.io.Serializable, java.lang.Cloneable

public class XBRLInstance
extends XBRLDocument
implements java.lang.Cloneable

Class that encapsulates the content of an XBRL instance document Instance documents can be created via API calls or can be created from the content of an XML file.

Author:

Ignacio

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.ihr.xbrl.om.XBRLDocument

XBRLDocument.LockInfo, XBRLDocument.XBRLDocumentType

Nested classes/interfaces inherited from interface com.ihr.xbrl.om.XBRLValidation

XBRLValidation.Direction

Field Summary

Fields

Modifier and Type	Field and Description
static javax.xml.namespace.QName	docNodeName The document root node name xbrli:xbrl.
static net.sf.saxon.om.StructuredQName	sqnDocNodeName The Constant sqnDocNodeName.

Constructor Summary

Constructors

Constructor and Description
XBRLInstance(DTSContainer dts) Creates a new empty instance document.
XBRLInstance(DTSContainer[] dtss) Creates a new empty instance document and creates link:schemaRef and link:linkbaseRef elements to all root URIs of the DTSContainers received as a parameter.
XBRLInstance(DTSContainer dts, javax.xml.transform.Source xmlSource, boolean deepProcess) Creates an instance document and obtains the content from a javax.xml.transform.Source object The Document URI of this instance will be set to the systemId of the Source provided as a parameter.
XBRLInstance(DTSContainer dts, XBRLInstance instanceBasedOn) Creates an empty instance optionally based on another instance.
XBRLInstance(DTSContainer dts, net.sf.saxon.s9api.XdmNode doc, boolean bAddToCache) Creates an instance document and sets the document content to the supplied XdmNode.
XBRLInstance(XMLDocumentURI doc, boolean bAddToCache) Creates a new empty instance document according to the configuration object received.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear.
XBRLInstance	clone() Clone.
void	copyHistory(XBRLInstance fromInstance) This method copy all history details from instance in the fromInstance parameter to facts in this instance document.
void	deduplicate() Eliminate duplicate identical facts on this instance.
void	discoverDTS(XBRLDTSDocument parent) This process MUST not use Schema Aware XPath expressions and MUST be limited to the elements that cause DTS Discovery.
boolean	equals(java.lang.Object obj) Equals.
XMLDocumentImpl	generateDocNode() Generates an XML representation of the instance document obtains information from the internal objects and not from the NodeInfo document.
XBRLContext	getContextById(java.lang.String id) Gets the context by id.
XBRLDocument.XBRLDocumentType	getDTSDocumentType() Gets the DTS document type.
java.lang.String	getDTSDocumentTypeName() Gets the DTS document type name.
XBRLFact	getFactById(java.lang.String id) find the element with the correspondent id and return the instance or tuple pointed to.
XBRLInstanceRootNode	getInstanceRootNode() Gets the instance root node.
XBRLUnit	getUnitById(java.lang.String id) Gets the unit that contains an id attribute that matches the value of the id parameter.
java.lang.String	getXPathToRoot() Gets the x path to root.
int	hashCode() Hash code.
static boolean	isIXBRL(XMLDocumentURI documentNode) Returns true if the XMLDocumentURI is an iXBRL document.
static boolean	isIXBRL1_1(XMLDocumentURI documentNode) Returns true if the XMLDocumentURI is an iXBRL 1.1 document.
void	merge(XBRLInstance otherInstance) Add to this instance document all the facts and contexts from the instance document in the parameter.
void	optimize(DTSContainer dts, boolean bRelativizeSchemaRefs, boolean bGenerateSchemalocation) Optimize the instance document by removing unused elements
static java.util.Collection<java.lang.String>	prepareComments(java.lang.String description) Prepare comments.
void	readInfoset() Read infoset.
void	setOldDocument(net.sf.saxon.s9api.XdmNode fakeNode) This method is here to dynamically set the property oldDocument so this instance will be converted to current DTSContainer.
void	setRootNode(XBRLInstanceRootNode instance) Sets the root node.
boolean	setURI(java.net.URI newURI) Sets the URI.
java.lang.String	toString() To string.

Methods inherited from class com.ihr.xbrl.om.XBRLDocument

addComment, addIdOfElement, addIdOfElement, addParent, changeElementId, checkCleanDocumentInfo, createDocument, createDocument, createDocument, createDynamicDocument, delParent, generateId, getAllUsedIds, getComments, getDocumentInfo, getDTS, getElementById, getElementsById, getOrCreateTableId, getParents, getRoleRef, getTreeModel, isContentModified, isDynamic, isIdUsed, isOfficialURI, lock, registerChangeIdListener, registerChangeIdListener, release, removeComments, removeIdOfElement, removeIdOfElement, resolveURI, save, save, save, setComments, setLockInfo, setModified, setReadingInfoset, unregisterChangeIdListener, unsetLockInfo, updateXML

Methods inherited from class com.ihr.xbrl.om.XMLDocumentURI

addChild, delChild, evaluateList, getBase, getChildren, getContainer, getDocument, getDocumentRootNode, getDocumentURI, getDocumentURICode, getDTSDiscoveryInfo, getDTSKey, getFriendlyName, getLocalFile, getOldDocument, getPackageName, getPackageVersion, getPrefix, getPrefixes, getValidationReport, getXBRLDocumentInfo, invalidate, invalidate, isInDTS, isOnValidation, setContainer, setDocumentURICode, setDTSDiscoveryInfo, setDTSKey, setNodeName, setRootNode, setXBRLDocumentInfo, validate

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

docNodeName

public static final javax.xml.namespace.QName docNodeName

The document root node name xbrli:xbrl.

sqnDocNodeName

public static final net.sf.saxon.om.StructuredQName sqnDocNodeName

The Constant sqnDocNodeName.

Constructor Detail

XBRLInstance

public XBRLInstance(DTSContainer dts,
                    net.sf.saxon.s9api.XdmNode doc,
                    boolean bAddToCache)
             throws DTSDiscoveryException

Creates an instance document and sets the document content to the supplied XdmNode. If the value of the bAddToCache parameter is true the document will be added to the documents cache in the DTS.

Parameters:

dts - the dts

doc - the doc

bAddToCache - the b add to cache

Throws:

DTSDiscoveryException - the DTS discovery exception

XBRLInstance

public XBRLInstance(DTSContainer dts)

Creates a new empty instance document.

Parameters:

dts - The DTSContainer under which this instance is going to be created

XBRLInstance

public XBRLInstance(XMLDocumentURI doc,
                    boolean bAddToCache)
             throws DTSDiscoveryException

Creates a new empty instance document according to the configuration object received. And the content of the XMLDocumentURI is supplied.

This is an internal method and should not be used by applications. This method is called from the XBRLDocument.createDocument(XMLDocumentURI, boolean) method during the creation of an XBRL Instance document.

This constructor is also used by clone() with bAddToCache set to false

Parameters:

doc - XMLDocumentURI to transform into an XBRLInstance object

bAddToCache - the b add to cache

Throws:

DTSDiscoveryException - the DTS discovery exception

XBRLInstance

public XBRLInstance(DTSContainer dts,
                    XBRLInstance instanceBasedOn)

Creates an empty instance optionally based on another instance. This is useful for formula processor.

Parameters:

dts - The DTSContainer under which this instance is going to be created

instanceBasedOn - The instance under wich this instance is based, maybe null

XBRLInstance

public XBRLInstance(DTSContainer[] dtss)
             throws com.rs.lic.LicenseVerificationException

Creates a new empty instance document and creates link:schemaRef and link:linkbaseRef elements to all root URIs of the DTSContainers received as a parameter.

This method was created to facilitate instance document creation inside the formula linkbase.

The incoming DTS are all merged into a new DTSContainer

Parameters:

dtss - the dtss

Throws:

com.rs.lic.LicenseVerificationException - the license verification exception

XBRLInstance

public XBRLInstance(DTSContainer dts,
                    javax.xml.transform.Source xmlSource,
                    boolean deepProcess)
             throws net.sf.saxon.s9api.SaxonApiException,
                    DTSDiscoveryException

Creates an instance document and obtains the content from a javax.xml.transform.Source object

The Document URI of this instance will be set to the systemId of the Source provided as a parameter. The Source will be transformed into XML nodes and the nodes will be the new document content.

Parameters:

dts - The DTSContainer under which the instance document is going to be created

xmlSource - The Source of the XML nodes to be read

deepProcess - boolean, true if the xmlSource is schema validated and nodes can be processed. false otherwise

Throws:

net.sf.saxon.s9api.SaxonApiException - in case of problems reading the Source

DTSDiscoveryException - the DTS discovery exception

Method Detail

hashCode

public int hashCode()

Hash code.

Overrides:

hashCode in class XBRLDocument

Returns:

the int

equals

public boolean equals(java.lang.Object obj)

Equals.

Overrides:

equals in class XBRLDocument

Parameters:

obj - the obj

Returns:

true, if successful

clone

public XBRLInstance clone()

Clone.

Overrides:

clone in class java.lang.Object

Returns:

the XBRL instance

clear

public void clear()
           throws java.lang.Throwable

Clear.

Specified by:

clear in interface XBRLDTSDocument

Overrides:

clear in class XBRLDocument

Throws:

java.lang.Throwable - the throwable

getDTSDocumentType

public XBRLDocument.XBRLDocumentType getDTSDocumentType()

Gets the DTS document type.

Specified by:

getDTSDocumentType in class XBRLDocument

Returns:

the DTS document type

getFactById

public XBRLFact getFactById(java.lang.String id)
                     throws XBRLValidationException

find the element with the correspondent id and return the instance or tuple pointed to.

Parameters:

id - the id

Returns:

XMLFragment

Throws:

XBRLValidationException - the XBRL validation exception

getInstanceRootNode

public XBRLInstanceRootNode getInstanceRootNode()

Gets the instance root node.

Returns:

the instance root node

setRootNode

public void setRootNode(XBRLInstanceRootNode instance)

Sets the root node.

Parameters:

instance - the new root node

merge

public void merge(XBRLInstance otherInstance)

Add to this instance document all the facts and contexts from the instance document in the parameter.

Parameters:

otherInstance - is the document to include into this document

optimize

public void optimize(DTSContainer dts,
                     boolean bRelativizeSchemaRefs,
                     boolean bGenerateSchemalocation)

Optimize the instance document by removing unused elements. - unreferenced context are removed - unreferenced units are removed

Parameters:

dts - the dts

bRelativizeSchemaRefs - turn the content of xlink:href relative to the documentURI

bGenerateSchemalocation - creates a xsi:schemaLocation element

getDTSDocumentTypeName

public java.lang.String getDTSDocumentTypeName()

Gets the DTS document type name.

Specified by:

getDTSDocumentTypeName in class XBRLDocument

Returns:

the DTS document type name

generateDocNode

public XMLDocumentImpl generateDocNode()
                                throws XBRLSerializationException

Generates an XML representation of the instance document obtains information from the internal objects and not from the NodeInfo document. The NodeInfo document is not updated

Specified by:

generateDocNode in class XBRLDocument

Returns:

XMLDocumentImpl

Throws:

XBRLSerializationException - the XBRL serialization exception

prepareComments

public static java.util.Collection<java.lang.String> prepareComments(java.lang.String description)
                                                              throws XBRLSerializationException

Prepare comments.

Parameters:

description - the description

Returns:

the collection

Throws:

XBRLSerializationException - the XBRL serialization exception

setURI

public boolean setURI(java.net.URI newURI)
               throws DTSDiscoveryException

Sets the URI.

Overrides:

setURI in class XMLDocumentURI

Parameters:

newURI - the new URI

Returns:

true, if successful

Throws:

DTSDiscoveryException - the DTS discovery exception

discoverDTS

public void discoverDTS(XBRLDTSDocument parent)
                 throws DTSDiscoveryException,
                        com.rs.lic.LicenseVerificationException

This process MUST not use Schema Aware XPath expressions and MUST be limited to the elements that cause DTS Discovery.

Specified by:

discoverDTS in interface XBRLDTSDocument

Specified by:

discoverDTS in class XBRLDocument

Parameters:

parent - the parent

Throws:

DTSDiscoveryException - the DTS discovery exception

com.rs.lic.LicenseVerificationException - the license verification exception

getContextById

public XBRLContext getContextById(java.lang.String id)
                           throws XBRLValidationException

Gets the context by id.

Parameters:

id - the id

Returns:

the context by id

Throws:

XBRLValidationException - the XBRL validation exception

getUnitById

public XBRLUnit getUnitById(java.lang.String id)
                     throws XBRLValidationException

Gets the unit that contains an id attribute that matches the value of the id parameter. The unit might be on linbo units ot might be on the instance as XML nodes.

Parameters:

id - the unit id

Returns:

the unit by id or null if no unit corresponds with the id

Throws:

XBRLValidationException - if the object referenced by the id is not an XBRLUnit

readInfoset

public void readInfoset()
                 throws XBRLValidationException

Read infoset.

Specified by:

readInfoset in class XBRLDocument

Throws:

XBRLValidationException - the XBRL validation exception

getXPathToRoot

public java.lang.String getXPathToRoot()

Gets the x path to root.

Overrides:

getXPathToRoot in class XMLDocumentURI

Returns:

the x path to root

isIXBRL

public static boolean isIXBRL(XMLDocumentURI documentNode)

Returns true if the XMLDocumentURI is an iXBRL document. False otherwise

Parameters:

documentNode - the node

Returns:

true, if is ixbrl

isIXBRL1_1

public static boolean isIXBRL1_1(XMLDocumentURI documentNode)

Returns true if the XMLDocumentURI is an iXBRL 1.1 document. False otherwise

Parameters:

documentNode - the node

Returns:

true, if is ixbrl

copyHistory

public void copyHistory(XBRLInstance fromInstance)

This method copy all history details from instance in the fromInstance parameter to facts in this instance document.

Parameters:

fromInstance - the instance document whose facts history is going to be copied into this instance facts

toString

public java.lang.String toString()

To string.

Overrides:

toString in class XBRLDocument

Returns:

the string

deduplicate

public void deduplicate()

Eliminate duplicate identical facts on this instance.

setOldDocument

public void setOldDocument(net.sf.saxon.s9api.XdmNode fakeNode)

This method is here to dynamically set the property oldDocument so this instance will be converted to current DTSContainer. It is used internally by the API in order to force XBRLInstances generated by the IXBRL processor to follow the same path that regular files follow, even if its surronding XML tree in already a valid set of RS API nodes it is not schema validated and the schemas has not been loaded.

Parameters:

fakeNode - the new old document