com.ihr.xbrl.om

Class XBRLDocument

java.lang.Object

com.ihr.xbrl.om.XMLDocumentURI

com.ihr.xbrl.om.XBRLDocument

All Implemented Interfaces:

XBRLDTSDocument, XBRLHasDTSTarget, XBRLValidation, java.io.Serializable

Direct Known Subclasses:

XBRLInstance, XBRLLinkbase, XBRLTaxonomy

public abstract class XBRLDocument
extends XMLDocumentURI

Contains the Properties of the object 2.2.2 XBRL Document Information Item The [Document URI] property is provided by the parent class XMLDocumentURI The [Document Information Item] property is provided by the root class XMLFragment The [Additional Properties] Properties are provided by classes derived by extension of this class

Author:

Ignacio

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XBRLDocument.LockInfo The Class LockInfo.
static class	XBRLDocument.XBRLDocumentType The Enum XBRLDocumentType.

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

XBRLValidation.Direction

Method Summary

Modifier and Type	Method and Description
void	addComment(java.lang.String commentValue) Adds the comment.
boolean	addIdOfElement(XMLFragment newElement) Adds the id of newElement to the set of IDs stored in this document.
boolean	addIdOfElement(XMLFragment newElement, java.lang.String id) Adds the id of newElement to the set of IDs stored in this document.
void	addParent(XBRLDocument parent) Add a new XBRLDocument as parent of this document.
void	changeElementId(XMLFragment newEl, java.lang.String oldId, java.lang.String newId) Changes the key of an element in the internal itemsById hashtable but does not change the id on the target element.
void	checkCleanDocumentInfo() Check clean document info.
void	clear() Clear.
static XMLDocumentURI	createDocument(DTSContainer dts, java.lang.Integer resolvedURI, javax.xml.transform.Source source, boolean addToCache, XBRLDTSDocument parent) Creates a Document, (instance, taxonomy or linkbase) by accessing the root element and looking at the document type if the document is not a linkbase, schema or xbrl instance returns null.
static XMLDocumentURI	createDocument(DTSContainer dts, java.net.URI resolvedURI, javax.xml.transform.Source source, boolean addToCache, XBRLDTSDocument parent) Creates a Document, (instance, taxonomy or linkbase) by accessing the root element and looking at the document type if the document is not a linkbase, schema or xbrl instance returns null.
static XMLDocumentURI	createDocument(XMLDocumentURI node, boolean addToCache) Transforms the XMLDocumentURI in the node parameter into a XBRLDocument Linkbase, Taxonomy or Instance depending on the root node .
static XMLDocumentURI	createDynamicDocument(DTSContainer dts, java.net.URI resolvedURI, javax.xml.transform.Source source, boolean addToCache, XBRLDTSDocument parent) Same as createDocument().
void	delParent(XBRLDocument parent) Del parent.
abstract void	discoverDTS(XBRLDTSDocument parent) All derived classes MUST implement this method and provide the functionality according to section 3.2 of the XBRL 2.1 specification
boolean	equals(java.lang.Object oe) Equals.
abstract XMLDocumentImpl	generateDocNode() This class has to be implemented by objects derived from XBRLDocument and must return a XMLDocumentImpl node with the content of this XBRLDocument object.
java.lang.String	generateId() Generates a new id that is not an existing key in the itemasById internal map.
java.util.Iterator<java.lang.String>	getAllUsedIds() This method returns an iterator over all ids used by elements in this document.
java.util.Collection<java.lang.String>	getComments() Access to the comments in the file.
XBRLDocumentInfo	getDocumentInfo() Deprecated.
void	getDTS() Launches the rules for DTSDiscovery process that will eventually add more objects to the DTSContainer.
abstract XBRLDocument.XBRLDocumentType	getDTSDocumentType() Returns the type of DTS Document.
abstract java.lang.String	getDTSDocumentTypeName() Gets the DTS document type name.
XMLFragment	getElementById(java.lang.String id) This method returns the XMLFragment associated to the id received as a parameter.
java.util.Map<java.lang.String,net.sf.saxon.om.NodeInfo>	getElementsById() Gets the elements by id.
static java.util.HashMap<java.lang.String,net.sf.saxon.om.NodeInfo>	getOrCreateTableId(net.sf.saxon.om.DocumentInfo doc) Used internally by the API to obtain the idTable table in the DocumentInfo using reflection.
java.util.Iterator<XBRLDocument>	getParents() Access to the [Parents] property.
XBRLRoleRef	getRoleRef(java.lang.String roleURI) Gets the role ref.
static net.sf.saxon.om.TreeModel	getTreeModel() Gets the tree model.
int	hashCode() Hash code.
boolean	isContentModified() Returns true if the document content has been modified.
boolean	isDynamic() Returns true when the document is created programatically.
boolean	isIdUsed(java.lang.String id) This method returns true if the id indicated as a parameter corresponds to an XMLFragment in this XBRLDocument.
static int	isOfficialURI(java.net.URI uri) Returns true if the uri passed in as a parameter corresponds with an XBRL document referenced (explicitly or implicitly) in the XBRL 2.1 specification and the uri is not exactly the one indicated in the XBRL 2.1 specification.
void	lock() Implements a lock mechanism to avoid multiple threads to modify content of XBRLDocument during validation in a multi-thread environment.
abstract void	readInfoset() Read all structures that builds the infoset.
void	registerChangeIdListener() Register change id listener.
void	registerChangeIdListener(XBRLDocumentRootNode rootNode) Register change id listener.
void	release() Release.
void	removeComments() Removes the comments.
void	removeIdOfElement(java.lang.String key, XMLFragment element) Used internally to remove multiple ids pointing to the same resource.
void	removeIdOfElement(XMLFragment element) Removes the id of element.
static java.net.URI	resolveURI(java.net.URI base, java.net.URI href) We need a common method to normalize and resolve absolute URIs from a base URI and a relative URI.
void	save() Save the file to the indicated document URI Directories in the path of the file name are created automatically .
void	save(java.io.OutputStream os) Save the file to the indicated OutputStream.
void	save(java.io.OutputStream os, boolean withOptimizations) Save the file to the indicated OutputStream.
void	setComments(java.util.Collection<java.lang.String> fileComments) Sets a new collection of comments for this file.
static void	setLockInfo(int timeout, java.lang.Runnable callback) when lock will be called by a thread, it might be the case the lock shall not wait for longer than a specific amount of time and it might be required to call a method when the time expires and cancel or continue with the operation.
void	setModified(boolean state) Sets the modified.
void	setReadingInfoset(boolean value) Called by parent objects when the infoset is being read.
java.lang.String	toString() To string.
void	unregisterChangeIdListener() Unregister change id listener.
static void	unsetLockInfo() resets the default behaviour of lock for the caller thread.
boolean	updateXML() Updates the XML content of the XBRLDocument so the next call to save or to XdmNode getDocument() will obtain a fresh copy with all changes made in the object library.

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, getXPathToRoot, invalidate, invalidate, isInDTS, isOnValidation, setContainer, setDocumentURICode, setDTSDiscoveryInfo, setDTSKey, setNodeName, setRootNode, setURI, setXBRLDocumentInfo, validate

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

unregisterChangeIdListener

public void unregisterChangeIdListener()

Unregister change id listener.

registerChangeIdListener

public void registerChangeIdListener()

Register change id listener.

registerChangeIdListener

public void registerChangeIdListener(XBRLDocumentRootNode rootNode)

Register change id listener.

Parameters:

rootNode - the root node

checkCleanDocumentInfo

public void checkCleanDocumentInfo()

Check clean document info.

equals

public boolean equals(java.lang.Object oe)

Equals.

Overrides:

equals in class XMLDocumentURI

Parameters:

oe - the oe

Returns:

true, if successful

hashCode

public int hashCode()

Hash code.

Overrides:

hashCode in class XMLDocumentURI

Returns:

the int

resolveURI

public static java.net.URI resolveURI(java.net.URI base,
                                      java.net.URI href)

We need a common method to normalize and resolve absolute URIs from a base URI and a relative URI. We need to normalize file:/ and file:/// references as well. We will use this method now and we will move it later to the URITools class and simplify what we have.

Parameters:

base - the base

href - the href

Returns:

the uri

createDocument

public static XMLDocumentURI createDocument(DTSContainer dts,
                                            java.net.URI resolvedURI,
                                            javax.xml.transform.Source source,
                                            boolean addToCache,
                                            XBRLDTSDocument parent)
                                     throws DTSDiscoveryException,
                                            com.rs.lic.LicenseVerificationException

Creates a Document, (instance, taxonomy or linkbase) by accessing the root element and looking at the document type if the document is not a linkbase, schema or xbrl instance returns null.

The Document may not be part of any DTS.

The Document is first obtained from the cache. If it is not there, then it is loaded from the URI and stored into the cache.

the source parameter is an javax.xml.transform.Source object from which the document will be generated

Parameters:

dts - the dts

resolvedURI - the resolved uri

source - the source

addToCache - the boolean add to cache

parent - the parent

Returns:

XMLDocumentURI object

Throws:

DTSDiscoveryException - the DTS discovery exception

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

Since:

2.6.4

createDynamicDocument

public static XMLDocumentURI createDynamicDocument(DTSContainer dts,
                                                   java.net.URI resolvedURI,
                                                   javax.xml.transform.Source source,
                                                   boolean addToCache,
                                                   XBRLDTSDocument parent)
                                            throws DTSDiscoveryException,
                                                   com.rs.lic.LicenseVerificationException,
                                                   XBRLValidationException

Same as createDocument(). For internal use in TaxonomyBuilder.

Parameters:

dts - the dts

resolvedURI - the resolved uri

source - the source

addToCache - the boolean add to cache

parent - the parent

Returns:

XMLDocumentURI object

Throws:

DTSDiscoveryException - the DTS discovery exception

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

XBRLValidationException - the XBRL validation exception

createDocument

public static XMLDocumentURI createDocument(DTSContainer dts,
                                            java.lang.Integer resolvedURI,
                                            javax.xml.transform.Source source,
                                            boolean addToCache,
                                            XBRLDTSDocument parent)
                                     throws DTSDiscoveryException,
                                            com.rs.lic.LicenseVerificationException

Creates a Document, (instance, taxonomy or linkbase) by accessing the root element and looking at the document type if the document is not a linkbase, schema or xbrl instance returns null.

The Document may not be part of any DTS.

The Document is first obtained from the cache. If it is not there, then it is loaded from the URI and stored into the cache.

the source parameter is an javax.xml.transform.Source object from which the document will be generated

Parameters:

dts - the dts

resolvedURI - the resolved uri

source - the source

addToCache - the add to cache

parent - the parent

Returns:

XMLDocumentURI object

Throws:

DTSDiscoveryException - the DTS discovery exception

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

Since:

2.6.4

isOfficialURI

public static int isOfficialURI(java.net.URI uri)

Returns true if the uri passed in as a parameter corresponds with an XBRL document referenced (explicitly or implicitly) in the XBRL 2.1 specification and the uri is not exactly the one indicated in the XBRL 2.1 specification. This method does not considers other specifications and only checks the file name, not the entire document URI.

This method is used internally to generate a warning when an official document is not loaded from the official location.

Parameters:

uri - the uri

Returns:

true if the document indicated by the uri is referenced in the XBRL 2.1 specification

createDocument

public static XMLDocumentURI createDocument(XMLDocumentURI node,
                                            boolean addToCache)
                                     throws com.rs.lic.LicenseVerificationException,
                                            DTSDiscoveryException

Transforms the XMLDocumentURI in the node parameter into a XBRLDocument Linkbase, Taxonomy or Instance depending on the root node .

Parameters:

node - the XMLDocumentURI object to transform

addToCache - true if the document MUST be added to the cache

Returns:

a XMLDocumentURI

Throws:

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

DTSDiscoveryException - the DTS discovery exception

getDTSDocumentType

public abstract XBRLDocument.XBRLDocumentType getDTSDocumentType()

Returns the type of DTS Document.

Returns:

DTSDocument.INSTANCE, DTSDocument.TAXONOMY or DTSDocument.LINKBASE

getDTSDocumentTypeName

public abstract java.lang.String getDTSDocumentTypeName()

Gets the DTS document type name.

Returns:

the DTS document type name

discoverDTS

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

All derived classes MUST implement this method and provide the functionality according to section 3.2 of the XBRL 2.1 specification

Specified by:

discoverDTS in interface XBRLDTSDocument

Overrides:

discoverDTS in class XMLDocumentURI

Parameters:

parent - the parent

Throws:

DTSDiscoveryException - the DTS discovery exception

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

readInfoset

public abstract void readInfoset()
                          throws XBRLValidationException

Read all structures that builds the infoset.

Throws:

XBRLValidationException - the XBRL validation exception

getDTS

public void getDTS()
            throws DTSDiscoveryException,
                   com.rs.lic.LicenseVerificationException

Launches the rules for DTSDiscovery process that will eventually add more objects to the DTSContainer.

Throws:

DTSDiscoveryException - the DTS discovery exception

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

getParents

public java.util.Iterator<XBRLDocument> getParents()

Access to the [Parents] property.

Returns:

Iterator<XBRLDocument>

addParent

public void addParent(XBRLDocument parent)

Add a new XBRLDocument as parent of this document.

Parameters:

parent - the parent

delParent

public void delParent(XBRLDocument parent)

Del parent.

Parameters:

parent - the parent

addIdOfElement

public boolean addIdOfElement(XMLFragment newElement)

Adds the id of newElement to the set of IDs stored in this document. Two elements cannot have the same ID because this is forbidden according to XML rules.

Don't call this method from inside XMLFragment.getId() or methods overridden by subclasses. Call the addIdOfElement(XMLFragment, String) method instead.

Parameters:

newElement - element from which the ID will be obtained

Returns:

boolean, true if the element is new or is a substitute of previous element and contains an id and and has been added or has replaced previous element. false if the element already exist and is the same element or has no id

addIdOfElement

public boolean addIdOfElement(XMLFragment newElement,
                              java.lang.String id)

Adds the id of newElement to the set of IDs stored in this document. Two elements cannot have the same ID because this is forbidden according to XML rules.

Parameters:

newElement - element to be added. The ID will not be obtained from the node

id - to be set for this XMLFragment. The ID must be the real id set on this element node in the id attribute

Returns:

boolean, true if the element is new or is a substitute of previous element and contains an id and and has been added or has replaced previous element. false if the element already exist and is the same element or has no id

removeIdOfElement

public void removeIdOfElement(XMLFragment element)

Removes the id of element.

Parameters:

element - the element

removeIdOfElement

public void removeIdOfElement(java.lang.String key,
                              XMLFragment element)

Used internally to remove multiple ids pointing to the same resource. This happens for duplicate XBRLUnit or duplicate XBRLContexts

Parameters:

key - the key

element - the element

changeElementId

public void changeElementId(XMLFragment newEl,
                            java.lang.String oldId,
                            java.lang.String newId)
                     throws XBRLInconsistentDTSException

Changes the key of an element in the internal itemsById hashtable but does not change the id on the target element.

Parameters:

newEl - element definition

oldId - the old id

newId - the new ID of the element in the table

Throws:

XBRLInconsistentDTSException - the XBRL inconsistent dts exception

setReadingInfoset

public void setReadingInfoset(boolean value)

Called by parent objects when the infoset is being read.

Parameters:

value - the new reading infoset

getElementsById

public java.util.Map<java.lang.String,net.sf.saxon.om.NodeInfo> getElementsById()

Gets the elements by id.

Returns:

the elements by id

getOrCreateTableId

public static java.util.HashMap<java.lang.String,net.sf.saxon.om.NodeInfo> getOrCreateTableId(net.sf.saxon.om.DocumentInfo doc)

Used internally by the API to obtain the idTable table in the DocumentInfo using reflection.

Parameters:

doc - the doc

Returns:

the or create table id

getAllUsedIds

public java.util.Iterator<java.lang.String> getAllUsedIds()

This method returns an iterator over all ids used by elements in this document.

Returns:

Iterator<String>

Since:

2.6.5

isIdUsed

public boolean isIdUsed(java.lang.String id)

This method returns true if the id indicated as a parameter corresponds to an XMLFragment in this XBRLDocument.

Parameters:

id - String

Returns:

boolean value

Since:

2.6.5

getElementById

public XMLFragment getElementById(java.lang.String id)

This method returns the XMLFragment associated to the id received as a parameter.

Subclasses of this class may contain methods that returns the appropriate object for an id. Use this method as a last resort if you don't know or you don't care about the returned object type.

Parameters:

id - string, the id of the element to retrieve

Returns:

an XMLFragment or null if nothing in this document is indexed under that id

Since:

2.6.5

save

public void save()
          throws XBRLSerializationException

Save the file to the indicated document URI Directories in the path of the file name are created automatically .

Throws:

XBRLSerializationException - the XBRL serialization exception

save

public void save(java.io.OutputStream os)
          throws java.io.IOException,
                 XBRLSerializationException

Save the file to the indicated OutputStream. Note the surrounding XMLDocumentURI already has a URI set that can be obtained from a call to the XMLDocumentURI.getDocumentURI() method. When a call to XMLDocumentURI.setURI(URI) is made, all absolute URIs in xlink:href attributes will be converted to relative URIs. The save() method (with no arguments) ensures the OutputStream corresponds with the file set in the call to XMLDocumentURI.setURI(URI). But this method does not perform that check. Therefore, it is responsibility of the caller to properly set every document URI if this method is used. The advantage of this method is that it will generate no physical file content and can be used in environments where physical files are not desired

Parameters:

os - the OutputStream where the document will be written to.

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

XBRLSerializationException - the XBRL serialization exception

save

public void save(java.io.OutputStream os,
                 boolean withOptimizations)
          throws java.io.IOException,
                 XBRLSerializationException

Save the file to the indicated OutputStream. Note the surrounding XMLDocumentURI already has a URI set that can be obtained from a call to the XMLDocumentURI.getDocumentURI() method. When a call to XMLDocumentURI.setURI(URI) is made, all absolute URIs in xlink:href attributes will be converted to relative URIs. The save() method (with no arguments) ensures the OutputStream corresponds with the file set in the call to XMLDocumentURI.setURI(URI). But this method does not perform that check. Therefore, it is responsibility of the caller to properly set every document URI if this method is used. The advantage of this method is that it will generate no physical file content and can be used in environments where physical files are not desired

Parameters:

os - the OutputStream where the document will be written to.

withOptimizations - the with optimizations

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

XBRLSerializationException - the XBRL serialization exception

setModified

public void setModified(boolean state)

Sets the modified.

Parameters:

state - the new modified

isContentModified

public boolean isContentModified()

Returns true if the document content has been modified. The modified status is set automatically by the API when a fact value is changed or a new fact is added or deleted to the instance etc. This flag is, therefore read only.

When the content is modified the surrounding XML document might not be in sync with the object model. A call to updateXML() will synchronize both models.

Returns:

boolean value

See Also:

updateXML()

updateXML

public boolean updateXML()
                  throws XBRLSerializationException

Updates the XML content of the XBRLDocument so the next call to save or to XdmNode getDocument() will obtain a fresh copy with all changes made in the object library. note this method does not propagate the changes inside the object in the XBRL api that are down on this XBRLDocument, so formula validation accessing facts will not work.

Returns:

true if the document has been updated, false if the document has not been modified

Throws:

XBRLSerializationException - the XBRL serialization exception

Since:

2.6.12

getTreeModel

public static net.sf.saxon.om.TreeModel getTreeModel()

Gets the tree model.

Returns:

tree model

generateDocNode

public abstract XMLDocumentImpl generateDocNode()
                                         throws XBRLSerializationException

This class has to be implemented by objects derived from XBRLDocument and must return a XMLDocumentImpl node with the content of this XBRLDocument object.

Returns:

XMLDocumentImpl

Throws:

XBRLSerializationException - the XBRL serialization exception

removeComments

public void removeComments()

Removes the comments.

getComments

public java.util.Collection<java.lang.String> getComments()

Access to the comments in the file.

Returns:

Collection<String>

setComments

public void setComments(java.util.Collection<java.lang.String> fileComments)

Sets a new collection of comments for this file. The new comments will be serialized to the file during a call to the generateDocNode method.

Parameters:

fileComments - Collection<String>

addComment

public void addComment(java.lang.String commentValue)

Adds the comment.

Parameters:

commentValue - the comment value

clear

public void clear()
           throws java.lang.Throwable

Clear.

Specified by:

clear in interface XBRLDTSDocument

Overrides:

clear in class XMLDocumentURI

Throws:

java.lang.Throwable - the throwable

getRoleRef

public XBRLRoleRef getRoleRef(java.lang.String roleURI)

Gets the role ref.

Parameters:

roleURI - the role URI

Returns:

the role ref

getDocumentInfo

@Deprecated
public XBRLDocumentInfo getDocumentInfo()

Deprecated.

Gets the document info.

Use XMLDocumentURI.getXBRLDocumentInfo() instead

Returns:

the document info

setLockInfo

public static void setLockInfo(int timeout,
                               java.lang.Runnable callback)

when lock will be called by a thread, it might be the case the lock shall not wait for longer than a specific amount of time and it might be required to call a method when the time expires and cancel or continue with the operation.

This methos stores information in a ThreadLocal variable that controls what lock will do depending on the thread calling lock. The most evident use case is the AWT thread calling lock but not blocking the AWT thread for a long time. The AWT thread might postpone the operation and keep processing other events in the meantime.

Parameters:

timeout - amount of time the lock will wait after calling callback or deciding to cancel execution. if this value is negative, the information about how lock will operate on this thread will be reset to the default behavior that is to wait until lock can be acquired

callback - if not null, if timeout expires, this method will be called on the caller thread

unsetLockInfo

public static void unsetLockInfo()

resets the default behaviour of lock for the caller thread.

lock

public void lock()

Implements a lock mechanism to avoid multiple threads to modify content of XBRLDocument during validation in a multi-thread environment.

A call to lock must be followed by a call to release preferebly in a try - finally block as follows:

 doc.lock();
 try {
    ... some code with doc ...
 } finally {
    doc.release();
 }
 

This ensures the document will not remain locked forever

release

public void release()

Release.

toString

public java.lang.String toString()

To string.

Overrides:

toString in class java.lang.Object

Returns:

the string

isDynamic

public boolean isDynamic()

Returns true when the document is created programatically.

Returns:

true, if is dynamic

generateId

public java.lang.String generateId()

Generates a new id that is not an existing key in the itemasById internal map.

Returns:

String