DTSContainer - Revision history

Ihr: Reverted edits by Waexu (Talk) to last revision by Ihr

2010-11-08T20:17:13Z

Reverted edits by Waexu (Talk) to last revision by Ihr

New page

[[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/DTSContainer.html DTSContainer javadoc page]]

==Description==

A DTSContainer object is the placeholder for all other objects in the DTS.

==How to create an instance of a DTSContainer==

There are four ways:

* By a call to <tt>DTSContainer.newEmptyContainer()</tt> method [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/DTSContainer.html#newEmptyContainer() javadoc link]]. This is the most commonly used way.

* By a call to <tt>DTSContainer.newEmptyContainer(java.util.Properties)</tt> method [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/DTSContainer.html#newEmptyContainer(java.util.Properties) javadoc link]]. This is used in special cases were the processor requires special initialization. Two properties exists and are documented as constants in the DTSContainer object. Documentation in this wiki will come later.

* By a call to <tt>DTSContainer.newCompatibleContainer(net.sf.saxon.s9api.Processor, java.util.Properties)</tt> method [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/DTSContainer.html#newCompatibleContainer(net.sf.saxon.s9api.Processor,_java.util.Properties) javadoc link]]. This is a special case that allows the creation of a DTSContainer reusing the Saxon processor from the application or from another DTSContainer object. The properties parameter may be <tt>null</tt> or may by the properties of another DTSContainer.

* By a call to <tt>mergeDTSs(com.ihr.xbrl.om.DTSContainer[])</tt> method [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/DTSContainer.html#mergeDTSs(com.ihr.xbrl.om.DTSContainer%5b%5d) javadoc link]]. This is another special case that allow the user to merge the result of an array of DTSContainers into a single DTSContainer. Note: the resulting DTSContainer may not be valid in the DTSs to merge contains not compatible elements like a duplicate definition of the same role type.

==Usage==

Inside an application the user is free to create as many DTSContainer objects he needs. The content of each DTSContainer is completely isolated from the others. Changes in one DTSContainer will not other instances of a DTSContainer.

Each DTSContainer object contains a new instance of the Saxonica processor. It may be interesting in some applications that all DTSContainers created inside the application were ''compatible'' among them (this is, for example, the case when there are multiple different DTSs for which XhBtRmL templates exists inside the same Transformation Processor).

==What's inside a DTSContainer object==

The DTSContainer object contains useful information required to work with the DTS. All the information is collected during the DTS Discovery Process (implemented in any of the four overloaded load methods) or during the different validation processes. The API automatically collects the information for you.

The following is a list of the information collected during the DTS discovery process:

===All concepts defined===

This is all XBRL concepts in all discovered XBRL Taxonomies. The user can access a concept using the concept QName by setting the QName namespace to the namespace of the XBRLTaxonomy and the QName local part to the element name as it is defined in the taxonomy and then calling the [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/DTSContainer.html#getConcept(javax.xml.namespace.QName) getConcept(QName)]] method. The returned object is an [[XMLFragment]] that can be casted to an [[XBRLItem]] or an [[XBRLTuple]].

Concepts in the DTS can be accessed sequentially by retrieving a concepts iterator [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/DTSContainer.html#getConcepts() getConcepts()]]

The user can also access individual items only iterators [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/DTSContainer.html#getItemDeclarations() getItemDeclarations()]] and tuples only iterators [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/DTSContainer.html#getTupleDeclarations() getTupleDeclarations()]].

===All role types===

This includes static role types defined in the XBRL 2.1 specification and that does not require any definition in a taxonomy and all other role types defined in taxonomy schemas in the DTS.

The roles can be accessed by the role URI or sequentially by retrieving a role type iterator.

===All arcrole types===

This includes static arcrole types defined in the XBRL 2.1 specification and that does not require any definition in a taxonomy and all other role types defined in taxonomy schemas in the DTS.

===All relationships===

They are organized by DTSBase

===All resources defined on any extended link container===

Resources can be accessed sequentially or by providing the elements that makes the resource unique

===The root URLs===

They are the URLs used to start the DTS discovery process

===All XBRL Documents added to the DTS===

This includes all taxonomy schemas, linkbases, extended links and external documents in case there were generic linkbases pointing to any external documents.

===All languages===

During the process of reading labels in label extended link containers the DTSContainer object updates a list of different languages used.

===All Resources===

They are all resources defined in all XBRL Linkbases in the DTS. This is includes but is not limited to Label resources and Reference resources.

Starting with release 2.6.8 some Formula resources are recognized and transformed into specific formula related resources. The implementation of the XBRL Formula specification is planed to be finished fot the 2.7 release.

All specific object resources (Label resources, Reference resources, Formula resources, etc) are derived classes of the XBRLResource class. This means that all properties of a generic resource like attributes, value and children elements are always available for a resource. Specific resource objects facilitate validation and integration with other objects in the API.

===All XBRL Documents loaded in the DTS===

They are all XBRL Taxonomies and XBRL Linkbases indexed by the document absolute URI. The user can access any of the documents by its key value or he can retrieve an iterator over all objects of a specific type.

===Registered processors===

This is the set of registered processors that performs XBRL Validation. Once a processor is instantiated for a DTS it is registered for that DTS so it is always used and not created again. A processor can be obtained by its name. The Processor name is a static proprerty of all XBRLPlugInProcessors.

===Etc...===

There is much more information than can be obtained from the DTSContainer object. We will continue including more information about that content later.

==Navigation==
[[Main Page]] | [[XBRL API related discussions]]

Ihr at 16:02, 26 October 2009

2009-10-26T16:02:24Z

← Older revision		Revision as of 16:02, 26 October 2009
Line 1:		Line 1:
	[[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/DTSContainer.html DTSContainer javadoc page]]		[[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/DTSContainer.html DTSContainer javadoc page]]

	===Description===		==Description==

	A DTSContainer object is the placeholder for all other objects in the DTS.		A DTSContainer object is the placeholder for all other objects in the DTS.

	===How to create an instance of a DTSContainer===		==How to create an instance of a DTSContainer==

	There are four ways:		There are four ways:
Line 17:		Line 17:
	* By a call to <tt>mergeDTSs(com.ihr.xbrl.om.DTSContainer[])</tt> method [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/DTSContainer.html#mergeDTSs(com.ihr.xbrl.om.DTSContainer%5b%5d) javadoc link]]. This is another special case that allow the user to merge the result of an array of DTSContainers into a single DTSContainer. Note: the resulting DTSContainer may not be valid in the DTSs to merge contains not compatible elements like a duplicate definition of the same role type.		* By a call to <tt>mergeDTSs(com.ihr.xbrl.om.DTSContainer[])</tt> method [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/DTSContainer.html#mergeDTSs(com.ihr.xbrl.om.DTSContainer%5b%5d) javadoc link]]. This is another special case that allow the user to merge the result of an array of DTSContainers into a single DTSContainer. Note: the resulting DTSContainer may not be valid in the DTSs to merge contains not compatible elements like a duplicate definition of the same role type.

	===Usage===		==Usage==

	Inside an application the user is free to create as many DTSContainer objects he needs. The content of each DTSContainer is completely isolated from the others. Changes in one DTSContainer will not other instances of a DTSContainer.		Inside an application the user is free to create as many DTSContainer objects he needs. The content of each DTSContainer is completely isolated from the others. Changes in one DTSContainer will not other instances of a DTSContainer.
Line 23:		Line 23:
	Each DTSContainer object contains a new instance of the Saxonica processor. It may be interesting in some applications that all DTSContainers created inside the application were ''compatible'' among them (this is, for example, the case when there are multiple different DTSs for which XhBtRmL templates exists inside the same Transformation Processor).		Each DTSContainer object contains a new instance of the Saxonica processor. It may be interesting in some applications that all DTSContainers created inside the application were ''compatible'' among them (this is, for example, the case when there are multiple different DTSs for which XhBtRmL templates exists inside the same Transformation Processor).

	===What's inside a DTSContainer object===		==What's inside a DTSContainer object==

	The DTSContainer object contains useful information required to work with the DTS. All the information is collected during the DTS Discovery Process (implemented in any of the four overloaded load methods) or during the different validation processes. The API automatically collects the information for you.		The DTSContainer object contains useful information required to work with the DTS. All the information is collected during the DTS Discovery Process (implemented in any of the four overloaded load methods) or during the different validation processes. The API automatically collects the information for you.
Line 29:		Line 29:
	The following is a list of the information collected during the DTS discovery process:		The following is a list of the information collected during the DTS discovery process:

	====All concepts defined====		===All concepts defined===

	This is all XBRL concepts in all discovered XBRL Taxonomies. The user can access a concept using the concept QName by setting the QName namespace to the namespace of the XBRLTaxonomy and the QName local part to the element name as it is defined in the taxonomy and then calling the [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/DTSContainer.html#getConcept(javax.xml.namespace.QName) getConcept(QName)]] method. The returned object is an [[XMLFragment]] that can be casted to an [[XBRLItem]] or an [[XBRLTuple]].		This is all XBRL concepts in all discovered XBRL Taxonomies. The user can access a concept using the concept QName by setting the QName namespace to the namespace of the XBRLTaxonomy and the QName local part to the element name as it is defined in the taxonomy and then calling the [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/DTSContainer.html#getConcept(javax.xml.namespace.QName) getConcept(QName)]] method. The returned object is an [[XMLFragment]] that can be casted to an [[XBRLItem]] or an [[XBRLTuple]].
Line 37:		Line 37:
	The user can also access individual items only iterators [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/DTSContainer.html#getItemDeclarations() getItemDeclarations()]] and tuples only iterators [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/DTSContainer.html#getTupleDeclarations() getTupleDeclarations()]].		The user can also access individual items only iterators [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/DTSContainer.html#getItemDeclarations() getItemDeclarations()]] and tuples only iterators [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/DTSContainer.html#getTupleDeclarations() getTupleDeclarations()]].

	====All role types====		===All role types===

	This includes static role types defined in the XBRL 2.1 specification and that does not require any definition in a taxonomy and all other role types defined in taxonomy schemas in the DTS.		This includes static role types defined in the XBRL 2.1 specification and that does not require any definition in a taxonomy and all other role types defined in taxonomy schemas in the DTS.
Line 43:		Line 43:
	The roles can be accessed by the role URI or sequentially by retrieving a role type iterator.		The roles can be accessed by the role URI or sequentially by retrieving a role type iterator.

	====All arcrole types====		===All arcrole types===

	This includes static arcrole types defined in the XBRL 2.1 specification and that does not require any definition in a taxonomy and all other role types defined in taxonomy schemas in the DTS.		This includes static arcrole types defined in the XBRL 2.1 specification and that does not require any definition in a taxonomy and all other role types defined in taxonomy schemas in the DTS.

	====All relationships====		===All relationships===

	They are organized by DTSBase		They are organized by DTSBase

	====All resources defined on any extended link container====		===All resources defined on any extended link container===

	Resources can be accessed sequentially or by providing the elements that makes the resource unique		Resources can be accessed sequentially or by providing the elements that makes the resource unique

	====The root URLs====		===The root URLs===

	They are the URLs used to start the DTS discovery process		They are the URLs used to start the DTS discovery process

	====All XBRL Documents added to the DTS====		===All XBRL Documents added to the DTS===

	This includes all taxonomy schemas, linkbases, extended links and external documents in case there were generic linkbases pointing to any external documents.		This includes all taxonomy schemas, linkbases, extended links and external documents in case there were generic linkbases pointing to any external documents.

	====All languages====		===All languages===

	During the process of reading labels in label extended link containers the DTSContainer object updates a list of different languages used.		During the process of reading labels in label extended link containers the DTSContainer object updates a list of different languages used.

	====All Resources====		===All Resources===

	They are all resources defined in all XBRL Linkbases in the DTS. This is includes but is not limited to Label resources and Reference resources.		They are all resources defined in all XBRL Linkbases in the DTS. This is includes but is not limited to Label resources and Reference resources.
Line 75:		Line 75:
	All specific object resources (Label resources, Reference resources, Formula resources, etc) are derived classes of the XBRLResource class. This means that all properties of a generic resource like attributes, value and children elements are always available for a resource. Specific resource objects facilitate validation and integration with other objects in the API.		All specific object resources (Label resources, Reference resources, Formula resources, etc) are derived classes of the XBRLResource class. This means that all properties of a generic resource like attributes, value and children elements are always available for a resource. Specific resource objects facilitate validation and integration with other objects in the API.

	====All XBRL Documents loaded in the DTS====		===All XBRL Documents loaded in the DTS===

	They are all XBRL Taxonomies and XBRL Linkbases indexed by the document absolute URI. The user can access any of the documents by its key value or he can retrieve an iterator over all objects of a specific type.		They are all XBRL Taxonomies and XBRL Linkbases indexed by the document absolute URI. The user can access any of the documents by its key value or he can retrieve an iterator over all objects of a specific type.

	====Registered processors====		===Registered processors===

	This is the set of registered processors that performs XBRL Validation. Once a processor is instantiated for a DTS it is registered for that DTS so it is always used and not created again. A processor can be obtained by its name. The Processor name is a static proprerty of all XBRLPlugInProcessors.		This is the set of registered processors that performs XBRL Validation. Once a processor is instantiated for a DTS it is registered for that DTS so it is always used and not created again. A processor can be obtained by its name. The Processor name is a static proprerty of all XBRLPlugInProcessors.

	====Etc...====		===Etc...===

	There is much more information than can be obtained from the DTSContainer object. We will continue including more information about that content later.		There is much more information than can be obtained from the DTSContainer object. We will continue including more information about that content later.

Ihr: /* All concepts defined */

2009-10-26T15:51:24Z

All concepts defined

← Older revision		Revision as of 15:51, 26 October 2009
Line 31:		Line 31:
	====All concepts defined====		====All concepts defined====

	This is all XBRL concepts in all discovered XBRL Taxonomies. The user can access a concept using the concept QName ~~and~~ setting the namespace to the namespace of the XBRLTaxonomy and the local part to the element name as it is defined in the taxonomy.		This is all XBRL concepts in all discovered XBRL Taxonomies. The user can access a concept using the concept QName by setting the QName namespace to the namespace of the XBRLTaxonomy and the QName local part to the element name as it is defined in the taxonomy and then calling the [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/DTSContainer.html#getConcept(javax.xml.namespace.QName) getConcept(QName)]] method. The returned object is an [[XMLFragment]] that can be casted to an [[XBRLItem]] or an [[XBRLTuple]].

	Concepts in the DTS can be accessed sequentially by retrieving a concepts iterator.		Concepts in the DTS can be accessed sequentially by retrieving a concepts iterator [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/DTSContainer.html#getConcepts() getConcepts()]]

			The user can also access individual items only iterators [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/DTSContainer.html#getItemDeclarations() getItemDeclarations()]] and tuples only iterators [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/DTSContainer.html#getTupleDeclarations() getTupleDeclarations()]].

	====All role types====		====All role types====

Ihr: /* All languages */

2009-10-25T19:42:15Z

All languages

← Older revision		Revision as of 19:42, 25 October 2009
Line 64:		Line 64:

	During the process of reading labels in label extended link containers the DTSContainer object updates a list of different languages used.		During the process of reading labels in label extended link containers the DTSContainer object updates a list of different languages used.

			====All Resources====

			They are all resources defined in all XBRL Linkbases in the DTS. This is includes but is not limited to Label resources and Reference resources.

			Starting with release 2.6.8 some Formula resources are recognized and transformed into specific formula related resources. The implementation of the XBRL Formula specification is planed to be finished fot the 2.7 release.

			All specific object resources (Label resources, Reference resources, Formula resources, etc) are derived classes of the XBRLResource class. This means that all properties of a generic resource like attributes, value and children elements are always available for a resource. Specific resource objects facilitate validation and integration with other objects in the API.

			====All XBRL Documents loaded in the DTS====

			They are all XBRL Taxonomies and XBRL Linkbases indexed by the document absolute URI. The user can access any of the documents by its key value or he can retrieve an iterator over all objects of a specific type.

			====Registered processors====

			This is the set of registered processors that performs XBRL Validation. Once a processor is instantiated for a DTS it is registered for that DTS so it is always used and not created again. A processor can be obtained by its name. The Processor name is a static proprerty of all XBRLPlugInProcessors.

	====Etc...====		====Etc...====

Ihr: /* All concepts defined */

2009-10-25T19:27:48Z

All concepts defined

← Older revision		Revision as of 19:27, 25 October 2009
Line 31:		Line 31:
	====All concepts defined====		====All concepts defined====

	This is all concepts in all ~~taxonomy schemas~~. The user can access a concept using the concept QName and setting the namespace to the namespace of the XBRLTaxonomy and the local part to the element name as it is defined in the taxonomy.		This is all XBRL concepts in all discovered XBRL Taxonomies. The user can access a concept using the concept QName and setting the namespace to the namespace of the XBRLTaxonomy and the local part to the element name as it is defined in the taxonomy.

	Concepts in the DTS can be accessed sequentially by retrieving a concepts iterator.		Concepts in the DTS can be accessed sequentially by retrieving a concepts iterator.

Ihr: /* What's inside a DTSContainer object */

2009-10-25T19:25:39Z

What's inside a DTSContainer object

← Older revision		Revision as of 19:25, 25 October 2009
Line 25:		Line 25:
	===What's inside a DTSContainer object===		===What's inside a DTSContainer object===

	The DTSContainer object contains useful information required to work with the DTS. All the information is collected during the DTS Discovery Process (implemented in any of the four overloaded load methods) or during the different validation processes. The ~~collection of~~ the information ~~is automatically done by the API~~.		The DTSContainer object contains useful information required to work with the DTS. All the information is collected during the DTS Discovery Process (implemented in any of the four overloaded load methods) or during the different validation processes. The API automatically collects the information for you.

	The following is a list of the information collected during the DTS discovery process:		The following is a list of the information collected during the DTS discovery process:

Ihr: /* What's inside a DTSContainer object */

2009-10-25T19:24:47Z

What's inside a DTSContainer object

← Older revision		Revision as of 19:24, 25 October 2009
Line 25:		Line 25:
	===What's inside a DTSContainer object===		===What's inside a DTSContainer object===

	The DTSContainer object contains useful information required to work with the DTS. All the information is collected during the DTS Discovery ~~process~~ or during the different validation processes. The collection of the information is automatically done by the API.		The DTSContainer object contains useful information required to work with the DTS. All the information is collected during the DTS Discovery Process (implemented in any of the four overloaded load methods) or during the different validation processes. The collection of the information is automatically done by the API.

	The following is a list of the information collected during the DTS discovery process:		The following is a list of the information collected during the DTS discovery process:

Ihr: /* What's inside a DTSContainer object */

2009-10-25T19:23:45Z

What's inside a DTSContainer object

← Older revision		Revision as of 19:23, 25 October 2009
Line 25:		Line 25:
	===What's inside a DTSContainer object===		===What's inside a DTSContainer object===

	The DTSContainer object contains ~~a lot of~~ useful information required to work with the DTS.		The DTSContainer object contains useful information required to work with the DTS. All the information is collected during the DTS Discovery process or during the different validation processes. The collection of the information is automatically done by the API.

			The following is a list of the information collected during the DTS discovery process:

	====All concepts defined====		====All concepts defined====

Ihr: /* Usage */

2009-10-25T19:21:22Z

Usage

← Older revision		Revision as of 19:21, 25 October 2009
Line 19:		Line 19:
	===Usage===		===Usage===

	Inside an application the user is free to create as many DTSContainer objects ~~as necessary~~. The content of each ~~one of~~ the ~~DTSContainers will be separated~~. Changes in one DTSContainer will not ~~affect the others~~. Each DTSContainer object contains a new instance of the Saxonica processor. It may be interesting in some applications that all DTSContainers created inside the application were ''compatible'' among them (this is for example the case when there are multiple different DTSs for which XhBtRmL templates exists inside the same Transformation Processor).		Inside an application the user is free to create as many DTSContainer objects he needs. The content of each DTSContainer is completely isolated from the others. Changes in one DTSContainer will not other instances of a DTSContainer.

			Each DTSContainer object contains a new instance of the Saxonica processor. It may be interesting in some applications that all DTSContainers created inside the application were ''compatible'' among them (this is, for example, the case when there are multiple different DTSs for which XhBtRmL templates exists inside the same Transformation Processor).

	===What's inside a DTSContainer object===		===What's inside a DTSContainer object===

Ihr: /* Navigation */

2009-08-23T19:01:55Z

Navigation

← Older revision		Revision as of 19:01, 23 August 2009
Line 65:		Line 65:
	There is much more information than can be obtained from the DTSContainer object. We will continue including more information about that content later.		There is much more information than can be obtained from the DTSContainer object. We will continue including more information about that content later.

	===Navigation===		==Navigation==
	[[Main Page]] \| [[XBRL API related discussions]]		[[Main Page]] \| [[XBRL API related discussions]]