## Uses of Class
com.ihr.xbrl.om.XBRLDocument

- Packages that use XBRLDocument
  Package | Description
  --- | ---
  com.ihr.xbrl.adins.efm | Provides the implementation of the Edgar Filer Manual validation add-in This package contains the implementation of the Edgar Filer Manual validation engine according with the rules defined by the U.S.
  com.ihr.xbrl.formula | Provides the classes to implement a plug in processor for XBRL information and execute XQuery formulas defined in XBRL Linkbases The content of this package is the processor and the required classes to compile and execute formulas written in the XQuery language from the W3C.
  com.ihr.xbrl.om | Provides the classes necessary to start processing XBRL information.
  com.ihr.xbrl.om.approps | This package contains classes to implement an Application Properties processor.
  com.ihr.xbrl.om.autofill |
  com.ihr.xbrl.om.exLinks | Provides the classes necessary to process, read and write XBRL Linkbases and XBRL Extended links.
  com.ihr.xbrl.om.formula | Provides the classes necessary to implement a plug in XBRL processor for validation of docuents and taxonomies according to the XBRL formula specification 1.0 At this stage the package is just created.
  com.ihr.xbrl.om.instance | Provides the classes necessary to process, read and write the content of XBRL Instance documents.
  com.ihr.xbrl.om.ixbrl |
  com.ihr.xbrl.om.renderhints | This is a renderhints processor that process resources in linkbases to define render hints that Reporting Standard tools understands
  com.ihr.xbrl.om.table | This package contains an object model to work with tables as defined in the XBRL Table specification The current implementation is based on table linkbase PWD http://www.xbrl.org/Specification/table-linkbase/PWD-2013-05-17/table-linkbase-PWD-2013-05-17.html The XBRLTableProcessor class
  com.ihr.xbrl.om.taxonomy | Provides the classes necessary to process, write and read XBRL Taxonomy schemas and content of the XBRL Taxonomy Schemas that requires XBRL processing.
  com.ihr.xbrl.om.utr | Provides classes for handling the Units Registry from XBRL International The Units Registry provides extra validation of elements based on the element data type and the unit assigned by XBRL International in the Units Registry.
  com.ihr.xbrl.om.xdt | Provides the classes necessary to implement a plug in XBRL processor for validation of dimensional instance documents according to the XBRL Dimensions specification 1.0 This package contains two hierarchies of classes.
  com.ihr.xbrl.om.xenum |
  com.ihr.xbrl.pojo | Provides the classes necessary to access to the content of a DTS using POJO technology.
  com.ihr.xbrl.store |
  com.ihr.xbrl.util | Provides utility classes with static methods that are used by other classes This is a common container for utilities like resolving relative URIs from two absolute URIs or formatting an XML document to a String...

- - ### Uses of XBRLDocument in com.ihr.xbrl.adins.efm

    Methods in com.ihr.xbrl.adins.efm with parameters of type XBRLDocument
    Modifier and Type | Method and Description
    --- | ---
    `XBRLValidationReport` | EFMProcessor.`validate(XBRLDocument xDocument)`

  - ### Uses of XBRLDocument in com.ihr.xbrl.formula

    Methods in com.ihr.xbrl.formula with parameters of type XBRLDocument
    Modifier and Type | Method and Description
    --- | ---
    `XBRLValidationReport` | FlFormulaProcessor.`validate(XBRLDocument xDocument)`

  - ### Uses of XBRLDocument in com.ihr.xbrl.om

    Methods in com.ihr.xbrl.om that return XBRLDocument
    Modifier and Type | Method and Description
    --- | ---
    `XBRLDocument` | DTSContainer.`load(javax.xml.transform.Source source)` Load a DTS.
    `XBRLDocument[]` | DTSContainer.`load(javax.xml.transform.Source[] ss)` Load a DTS from a set of urls.
    `XBRLDocument` | DTSContainer.`load(java.net.URI url)` Load a DTS.
    `XBRLDocument[]` | DTSContainer.`load(java.net.URI[] url)` Load a DTS from a set of urls.

    Methods in com.ihr.xbrl.om that return types with arguments of type XBRLDocument
    Modifier and Type | Method and Description
    --- | ---
    `java.util.Iterator<XBRLDocument>` | XBRLDocument.`getParents()` Access to the [Parents] property.

    Methods in com.ihr.xbrl.om with parameters of type XBRLDocument
    Modifier and Type | Method and Description
    --- | ---
    `void` | XBRLDocument.`addParent(XBRLDocument parent)` Add a new XBRLDocument as parent of this document.
    `void` | XBRLDocument.`delParent(XBRLDocument parent)` Del parent.
    `XBRLValidationReport` | XBRLPlugInProcessor.`validate(XBRLDocument xDocument)` Validates the document according to the rules indicated in this plug-in processor.
    `XBRLValidationReport` | XBRLCoreProcessor.`validate(XBRLDocument doc)` Validates an instance document against all arcroles defined in the XBRL 2.1 specification
    `XBRLValidationReport` | DTSContainer.`validate(XBRLDocument doc)` Validates a new document against this already loaded DTS.

  - ### Uses of XBRLDocument in com.ihr.xbrl.om.approps

    Methods in com.ihr.xbrl.om.approps with parameters of type XBRLDocument
    Modifier and Type | Method and Description
    --- | ---
    `XBRLValidationReport` | XBRLAppPropsProcessor.`validate(XBRLDocument xDocument)`

  - ### Uses of XBRLDocument in com.ihr.xbrl.om.autofill

    Methods in com.ihr.xbrl.om.autofill with parameters of type XBRLDocument
    Modifier and Type | Method and Description
    --- | ---
    `XBRLValidationReport` | AutoFillProcessor.`validate(XBRLDocument xDocument)`

  - ### Uses of XBRLDocument in com.ihr.xbrl.om.exLinks

    Subclasses of XBRLDocument in com.ihr.xbrl.om.exLinks
    Modifier and Type | Class and Description
    --- | ---
    `class` | `XBRLLinkbase` Provides the properties of the XBRL Linkbase information item The [Parent] property is the parent class XBRLDocument An XBRL Linkbase is just the container of documentation and extended links.

    Methods in com.ihr.xbrl.om.exLinks that return XBRLDocument
    Modifier and Type | Method and Description
    --- | ---
    `XBRLDocument` | XBRLLinkbase.`getParent()` Access to the parent property.
    `XBRLDocument` | XBRLExtendedLink.`getParent()` Access to the [Parent] property.

    Methods in com.ihr.xbrl.om.exLinks with parameters of type XBRLDocument
    Modifier and Type | Method and Description
    --- | ---
    `static XBRLExtendedLink` | XBRLExtendedLink.`createExtendedLink(XBRLDocument parent, DTSBase base)` Creates the extended link.
    `static XBRLExtendedLink` | XBRLExtendedLink.`createExtendedLink(XBRLDocument parent, javax.xml.namespace.QName rootElementName, XBRLRoleType role)` Creates the extended link.
    `static XBRLExtendedLink` | XBRLExtendedLink.`createExtendedLink(XBRLDocument parent, net.sf.saxon.s9api.XdmNode node)` Creates the extended link.
    `void` | DTSBase.`serialize(XBRLRelationship rel, XBRLDocument document)` This function makes sure that: 1- the relationship exists in the appropriate ExtendedLink or creates the extended link 2- If the target is a resource, the resource is included in the ExtendedLink as well.
    `void` | XBRLLinkbase.`setParent(XBRLDocument newParent)` Sets the parent of this XBRLLinkbase to a new document.
    `void` | XBRLExtendedLink.`setParent(XBRLDocument parent)` Sets the parent of this extended link.

    Constructors in com.ihr.xbrl.om.exLinks with parameters of type XBRLDocument
    Constructor and Description
    `CalculationLinkbase(XBRLDocument parent, DTSBase base)` Deprecated. use `CalculationLinkbase.CalculationLinkbase(XBRLDocument, XBRLRoleType)` instead
    `CalculationLinkbase(XBRLDocument parent, XBRLRoleType role)` Creates a CalculationLinkbase extended link.
    `CalculationLinkbase(XBRLDocument parent, net.sf.saxon.s9api.XdmNode node)` Instantiates a new calculation linkbase.
    `DefinitionLinkbase(XBRLDocument parent, DTSBase base)` Deprecated. use `DefinitionLinkbase.DefinitionLinkbase(XBRLDocument, XBRLRoleType)` instead
    `DefinitionLinkbase(XBRLDocument parent, XBRLRoleType role)` Creates a DefinitionLinkbase extended link container.
    `DefinitionLinkbase(XBRLDocument parent, net.sf.saxon.s9api.XdmNode node)` Instantiates a new definition linkbase.
    `FootnoteLinkbase(XBRLDocument parent, DTSBase base)` Deprecated. use `FootnoteLinkbase.FootnoteLinkbase(XBRLDocument, XBRLRoleType)` instead
    `FootnoteLinkbase(XBRLDocument parent, XBRLRoleType role)` Creates a Footnote extended link.
    `FootnoteLinkbase(XBRLDocument parent, net.sf.saxon.s9api.XdmNode node)` Instantiates a new footnote linkbase.
    `FormulaLinkbase(XBRLDocument parent, DTSBase base)` Deprecated. use `FormulaLinkbase.FormulaLinkbase(XBRLDocument, XBRLRoleType)` instead
    `FormulaLinkbase(XBRLDocument parent, XBRLRoleType role)` Creates a new Formula Linkbase extended link container.
    `FormulaLinkbase(XBRLDocument parent, net.sf.saxon.s9api.XdmNode node)` Instantiates a new formula linkbase.
    `GenericLinkbase(XBRLDocument parent, DTSBase base)` Deprecated. use `GenericLinkbase.GenericLinkbase(XBRLDocument, XBRLRoleType)` instead
    `GenericLinkbase(XBRLDocument parent, XBRLRoleType role)` Creates a new GenericLinkbase extended link container.
    `GenericLinkbase(XBRLDocument parent, net.sf.saxon.s9api.XdmNode node)` Instantiates a new generic linkbase.
    `LabelLinkbase(XBRLDocument parent, DTSBase base)` Deprecated. use `LabelLinkbase.LabelLinkbase(XBRLDocument, XBRLRoleType)` instead
    `LabelLinkbase(XBRLDocument parent, XBRLRoleType role)` Creates a LabelLinkbase extended link container.
    `LabelLinkbase(XBRLDocument parent, net.sf.saxon.s9api.XdmNode node)` Instantiates a new label linkbase.
    `OtherLinkbase(XBRLDocument parent, XBRLRoleType role, javax.xml.namespace.QName lbType)` Instantiates a new other linkbase.
    `OtherLinkbase(XBRLDocument parent, net.sf.saxon.s9api.XdmNode node)` Instantiates a new other linkbase.
    `PresentationLinkbase(XBRLDocument parent, DTSBase base)` Deprecated. use `PresentationLinkbase.PresentationLinkbase(XBRLDocument, XBRLRoleType)` instead
    `PresentationLinkbase(XBRLDocument parent, XBRLRoleType role)` Creates a new PresentationLinkbase extended link container.
    `PresentationLinkbase(XBRLDocument parent, net.sf.saxon.s9api.XdmNode node)` Instantiates a new presentation linkbase.
    `ReferenceLinkbase(XBRLDocument parent, DTSBase base)` Deprecated. use `ReferenceLinkbase.ReferenceLinkbase(XBRLDocument, XBRLRoleType)` instead
    `ReferenceLinkbase(XBRLDocument parent, XBRLRoleType role)` Creates a new ReferenceLinkbase extended link container.
    `ReferenceLinkbase(XBRLDocument parent, net.sf.saxon.s9api.XdmNode node)` Instantiates a new reference linkbase.
    `VersionLinkbase(XBRLDocument parent, DTSBase base)` Deprecated. use `VersionLinkbase.VersionLinkbase(XBRLDocument, XBRLRoleType)` instead
    `VersionLinkbase(XBRLDocument parent, XBRLRoleType role)` Deprecated. don't use this object as versioning meta data is no longer stored in a linkbase
    `VersionLinkbase(XBRLDocument parent, net.sf.saxon.s9api.XdmNode node)` Deprecated. Instantiates a new version linkbase.
    `XBRLArcroleRef(XBRLDocument parent, XBRLArcroleType arcrole)` Instantiates a new XBRL arcrole ref.
    `XBRLLinkbase(DTSContainer dts, XBRLDocument parent)` Creates a XBRLLinkbase that will contain extended links created later.
    `XBRLLinkbase(XBRLDocument parent)` Creates a XBRLLinkbase that will contain extended links created later.
    `XBRLLinkbase(XBRLDocument parent, XMLDocumentURI combinedDocument)` Creates a linkbase, the parent XBRLDocumentURI Item is an XBRL Taxonomy Used to create embedded linkbases, Parent is the parent taxonomy and XMLDocumentURI is the link:linkbase element.
    `XBRLRoleRef(XBRLDocument parent, XBRLRoleType role)` Instantiates a new XBRL role ref.

  - ### Uses of XBRLDocument in com.ihr.xbrl.om.formula

    Methods in com.ihr.xbrl.om.formula with parameters of type XBRLDocument
    Modifier and Type | Method and Description
    --- | ---
    `XBRLValidationReport` | XBRLFormulaProcessor.`validate(XBRLDocument doc)`

  - ### Uses of XBRLDocument in com.ihr.xbrl.om.instance

    Subclasses of XBRLDocument in com.ihr.xbrl.om.instance
    Modifier and Type | Class and Description
    --- | ---
    `class` | `XBRLInstance` 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.

    Methods in com.ihr.xbrl.om.instance with parameters of type XBRLDocument
    Modifier and Type | Method and Description
    --- | ---
    `void` | XBRLInstance.`addXBRLDocument(XBRLDocument doc, XBRLRoleAndArcroleTypes roleOrArcrole)` Attach a new XBRLDocument directly in the instance regardless it is alreary somewhere under the wood of the DTS.
    `void` | XBRLInstance.`addXBRLDocumentIfNotInDTS(XBRLDocument doc, XBRLRoleAndArcroleTypes roleOrArcrole)` Attach a new XBRLDocument to the instance document using a linkbaseRef or schemaRed only if the document is not in already in the set of documents that can be discovered from this instance document existing DTS entries.
    `void` | XBRLInstance.`delXBRLDocument(XBRLDocument doc)` Detach an XBRLDocument from the set of XBRLDocuments to include in this instance's DTS.

  - ### Uses of XBRLDocument in com.ihr.xbrl.om.ixbrl

    Methods in com.ihr.xbrl.om.ixbrl with parameters of type XBRLDocument
    Modifier and Type | Method and Description
    --- | ---
    `XBRLValidationReport` | IXBRLProcessor.`validate(XBRLDocument xDocument)`

  - ### Uses of XBRLDocument in com.ihr.xbrl.om.renderhints

    Methods in com.ihr.xbrl.om.renderhints with parameters of type XBRLDocument
    Modifier and Type | Method and Description
    --- | ---
    `XBRLValidationReport` | RenderHintsProcessor.`validate(XBRLDocument xDocument)`

  - ### Uses of XBRLDocument in com.ihr.xbrl.om.table

    Methods in com.ihr.xbrl.om.table with parameters of type XBRLDocument
    Modifier and Type | Method and Description
    --- | ---
    `XBRLValidationReport` | XBRLTableProcessor.`validate(XBRLDocument xDocument)`

  - ### Uses of XBRLDocument in com.ihr.xbrl.om.taxonomy

    Subclasses of XBRLDocument in com.ihr.xbrl.om.taxonomy
    Modifier and Type | Class and Description
    --- | ---
    `class` | `XBRLTaxonomy` Provides the properties of an XBRL Taxonomy Information Item The [Parent] property is the parent class XBRLDocument.

    Methods in com.ihr.xbrl.om.taxonomy with parameters of type XBRLDocument
    Modifier and Type | Method and Description
    --- | ---
    `void` | XBRLRoleAndArcroleTypes.`addRef(XBRLDocument doc)` When a role or arcrole is referenced via roleRef its is annotated here.
    `XBRLArcroleRef` | XBRLArcroleType.`getArcroleRef(XBRLDocument parent)` Creates an XBRLArcroleRef object that points to this arcroleRef and that can be serialized.
    `XBRLRoleRef` | XBRLRoleType.`getRoleRef(XBRLDocument parent)` Creates a XBRLRoleRef object pointing to this role and that can be serialized to a roleRef.

  - ### Uses of XBRLDocument in com.ihr.xbrl.om.utr

    Methods in com.ihr.xbrl.om.utr with parameters of type XBRLDocument
    Modifier and Type | Method and Description
    --- | ---
    `XBRLValidationReport` | UTRProcessor.`validate(XBRLDocument xDocument)`

  - ### Uses of XBRLDocument in com.ihr.xbrl.om.xdt

    Methods in com.ihr.xbrl.om.xdt with parameters of type XBRLDocument
    Modifier and Type | Method and Description
    --- | ---
    `XBRLValidationReport` | XDTProcessor.`validate(XBRLDocument doc)` Validates all facts in the instance document.

  - ### Uses of XBRLDocument in com.ihr.xbrl.om.xenum

    Methods in com.ihr.xbrl.om.xenum with parameters of type XBRLDocument
    Modifier and Type | Method and Description
    --- | ---
    `XBRLValidationReport` | ExtensibleEnumerationsProcessor.`validate(XBRLDocument xDocument)`

  - ### Uses of XBRLDocument in com.ihr.xbrl.pojo

    Methods in com.ihr.xbrl.pojo that return XBRLDocument
    Modifier and Type | Method and Description
    --- | ---
    `XBRLDocument` | XBRLRSGenerator.`generate(XBRLDocument doc)` Generate.
    `XBRLDocument` | XBRLRSGenerator.`obtainFromDB(java.lang.String uri, org.hibernate.Session session)` Obtain from db.

    Methods in com.ihr.xbrl.pojo with parameters of type XBRLDocument
    Modifier and Type | Method and Description
    --- | ---
    `XBRLDocument` | XBRLPojoGenerator.`generate(XBRLDocument dtsDoc)` Generate.
    `XBRLExtendedLink` | XBRLRSGenerator.`generate(XBRLExtendedLink exLinkIn, XBRLDocument parent)` Generate.

  - ### Uses of XBRLDocument in com.ihr.xbrl.store

    Methods in com.ihr.xbrl.store with parameters of type XBRLDocument
    Modifier and Type | Method and Description
    --- | ---
    `void` | StorageService.`doStoreDTS(java.lang.String instanceUriOnDatabase, XBRLDocument document, org.hibernate.Session parameter, boolean inNewThread, boolean bForUpdate, org.apache.log4j.Level logLevel, StorageEventListener[] listeners)` Starts the storage of a DTS into the database in an unattended new thread.
    `void` | StorageService.`doStoreDTS(XBRLDocument document, org.hibernate.Session parameter, boolean inNewThread, boolean bForUpdate, org.apache.log4j.Level logLevel, StorageEventListener[] listeners)` Starts the storage of a DTS into the database in an unattended new thread.

    Constructors in com.ihr.xbrl.store with parameters of type XBRLDocument
    Constructor and Description
    `StoreXBRLThread(java.lang.String instanceUriOnDatabase, XBRLDocument[] documents, org.hibernate.Session session, HasEnableDisableOpenMenus app, HasLoadingBar appLoadingBar, HasLogPanel appLogPanel, DbUtil dbUtil, boolean bForUpdate)` Store documents in the XBRL Database in a separate thread During the thread execution the process uses call back functions in other objects in order to inform the main application about progress and errors This version of the constructor uses the documents already read by the parent application.
    `StoreXBRLThread(XBRLDocument[] documents, org.hibernate.Session session, HasEnableDisableOpenMenus app, HasLoadingBar appLoadingBar, HasLogPanel appLogPanel, DbUtil dbUtil, boolean bForUpdate)` Store documents in the XBRL Database in a separate thread During the thread execution the process uses call back functions in other objects in order to inform the main application about progress and errors This version of the constructor uses the documents already read by the parent application.

  - ### Uses of XBRLDocument in com.ihr.xbrl.util

    Methods in com.ihr.xbrl.util that return XBRLDocument
    Modifier and Type | Method and Description
    --- | ---
    `XBRLDocument` | LoadDTSInThread.`getDoc()` Access to the document that has been loaded in the DTS.
    `XBRLDocument` | LoadDTSInThread.`getDoc(int index)` Access to one of the documents loaded (if invoqued with a set of URIs).
    `XBRLDocument[]` | LoadDTSInThread.`getDocsArray()` Returns the array of documents loaded in the DTS.