XBRLTaxonomy - Revision history

Ihr: /* Working with global XML Schema objects */

2009-08-11T16:55:28Z

Working with global XML Schema objects

@@ Line 155: / Line 155: @@
 ===Working with global XML Schema objects===
 ===Navigation===
 [[Main Page]] | [[XBRL API related discussions]]

Ihr: /* Working with external and embedded linkbases */

2009-08-11T14:49:34Z

Working with external and embedded linkbases

← Older revision		Revision as of 14:49, 11 August 2009
Line 145:		Line 145:

	===Working with external and embedded linkbases===		===Working with external and embedded linkbases===

			XBRL Linkbases are containers of extended links. For more information about this topic visit the wiki page about the [[XBRLLinkbase]] document object. An XBRL Taxonomy may contain either references to external linkbases or embeded linkbases. Applications working with the content of an XBRL Taxonomy can explore and change all linkbases that are referenced or embedded in an XBRL Taxonomy using simple API calls.

			====Read access====
			A call to the method [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLTaxonomy.html#getLinkbases() getLinkbases()]] returns an iterator over all linkbases that are embedded or referenced from this taxonomy schema. The iterator returns objects of the type [[XBRLLinkbase]]. An embedded linkbase can be easily diferenciated from a referenced linkbase because the parent of an embedded linkbase is always an XBRL Taxonomy schema and the parent object of a referenced linkbase (external to the taxonomy) is the same referenced linkbase.

			====Write access====
			The user can call the method [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLTaxonomy.html#addLinkbase(com.ihr.xbrl.om.exLinks.XBRLLinkbase) addLinkbase(XBRLLinkbase newLinkase)]] in order to add an embedded or external linkbase to an XBRL Taxonomy. The user can call the method [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLTaxonomy.html#removeLinkbase(com.ihr.xbrl.om.exLinks.XBRLLinkbase) removeLinkbase(XBRLLinkbase linkbase)]] in order to remove an existing external or embedded linkbase from this XBRL Taxonomy. Note the user must explicitly call addLinkbase and removeLinkbase methods in order to create the DTS structure they want.

	===Working with global XML Schema objects===		===Working with global XML Schema objects===

Ihr: /* Navigation */

2009-08-11T14:10:46Z

Navigation

← Older revision		Revision as of 14:10, 11 August 2009
Line 143:		Line 143:
	====Write access====		====Write access====
	The method [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLTaxonomy.html#addImport(com.ihr.xbrl.om.taxonomy.XBRLImport) addImport(XBRLImport import)]] adds a new import to the current taxonomy schema. The method [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLTaxonomy.html#removeImport(com.ihr.xbrl.om.taxonomy.XBRLImport) removeImport(XBRLImport import)]] removes an import from the list of imported schemas on the current taxonomy. The [[XBRLImport]] class already takes care of calling addImport and removeImport in the parent object during calls to the [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLImport.html#setParent(com.ihr.xbrl.om.taxonomy.XBRLTaxonomy) setParent(XBRLTaxonomy parent)]] method so there should be no need to call this methods directly from client code.		The method [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLTaxonomy.html#addImport(com.ihr.xbrl.om.taxonomy.XBRLImport) addImport(XBRLImport import)]] adds a new import to the current taxonomy schema. The method [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLTaxonomy.html#removeImport(com.ihr.xbrl.om.taxonomy.XBRLImport) removeImport(XBRLImport import)]] removes an import from the list of imported schemas on the current taxonomy. The [[XBRLImport]] class already takes care of calling addImport and removeImport in the parent object during calls to the [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLImport.html#setParent(com.ihr.xbrl.om.taxonomy.XBRLTaxonomy) setParent(XBRLTaxonomy parent)]] method so there should be no need to call this methods directly from client code.

			===Working with external and embedded linkbases===

			===Working with global XML Schema objects===

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

Ihr: /* Description */

2009-08-11T14:09:27Z

Description

← Older revision		Revision as of 14:09, 11 August 2009
Line 8:		Line 8:
	* all XBRL arcrole types locally defined, and		* all XBRL arcrole types locally defined, and
	* all references to imported XBRL Taxonomies, and		* all references to imported XBRL Taxonomies, and
	* all references to external ~~XBRL Linkbases,~~ and		* all references to external and embedded XBRL Linkbases, and
	* all embedded XBRL Linkbases, and
	* all other XML Schema related constructions like global groups, global type declarations, global attribute groups, global attribute declarations and global element declarations that are not XBRL concepts.		* all other XML Schema related constructions like global groups, global type declarations, global attribute groups, global attribute declarations and global element declarations that are not XBRL concepts.

Ihr: /* Write access */

2009-08-11T14:08:43Z

Write access

← Older revision		Revision as of 14:08, 11 August 2009
Line 144:		Line 144:
	====Write access====		====Write access====
	The method [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLTaxonomy.html#addImport(com.ihr.xbrl.om.taxonomy.XBRLImport) addImport(XBRLImport import)]] adds a new import to the current taxonomy schema. The method [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLTaxonomy.html#removeImport(com.ihr.xbrl.om.taxonomy.XBRLImport) removeImport(XBRLImport import)]] removes an import from the list of imported schemas on the current taxonomy. The [[XBRLImport]] class already takes care of calling addImport and removeImport in the parent object during calls to the [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLImport.html#setParent(com.ihr.xbrl.om.taxonomy.XBRLTaxonomy) setParent(XBRLTaxonomy parent)]] method so there should be no need to call this methods directly from client code.		The method [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLTaxonomy.html#addImport(com.ihr.xbrl.om.taxonomy.XBRLImport) addImport(XBRLImport import)]] adds a new import to the current taxonomy schema. The method [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLTaxonomy.html#removeImport(com.ihr.xbrl.om.taxonomy.XBRLImport) removeImport(XBRLImport import)]] removes an import from the list of imported schemas on the current taxonomy. The [[XBRLImport]] class already takes care of calling addImport and removeImport in the parent object during calls to the [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLImport.html#setParent(com.ihr.xbrl.om.taxonomy.XBRLTaxonomy) setParent(XBRLTaxonomy parent)]] method so there should be no need to call this methods directly from client code.

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

Ihr: /* Write access */

2009-08-11T12:54:55Z

Write access

← Older revision		Revision as of 12:54, 11 August 2009
Line 143:		Line 143:

	====Write access====		====Write access====
	The method [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLTaxonomy.html#addImport(com.ihr.xbrl.om.taxonomy.XBRLImport) addImport(XBRLImport import)]] adds a new import to the current taxonomy schema. The method [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLTaxonomy.html#removeImport(com.ihr.xbrl.om.taxonomy.XBRLImport) removeImport(XBRLImport import)]] removes an import from the list of imported schemas on the current taxonomy. The ~~class~~ [[XBRLImport]] already takes care of calling addImport and removeImport in the parent object during calls to the [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLImport.html#setParent(com.ihr.xbrl.om.taxonomy.XBRLTaxonomy) setParent(XBRLTaxonomy parent)]] method so there should be no need to call this methods directly from client code.		The method [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLTaxonomy.html#addImport(com.ihr.xbrl.om.taxonomy.XBRLImport) addImport(XBRLImport import)]] adds a new import to the current taxonomy schema. The method [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLTaxonomy.html#removeImport(com.ihr.xbrl.om.taxonomy.XBRLImport) removeImport(XBRLImport import)]] removes an import from the list of imported schemas on the current taxonomy. The [[XBRLImport]] class already takes care of calling addImport and removeImport in the parent object during calls to the [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLImport.html#setParent(com.ihr.xbrl.om.taxonomy.XBRLTaxonomy) setParent(XBRLTaxonomy parent)]] method so there should be no need to call this methods directly from client code.

Ihr: /* Write access */

2009-08-11T12:54:03Z

Write access

← Older revision		Revision as of 12:54, 11 August 2009
Line 143:		Line 143:

	====Write access====		====Write access====
	The method [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLTaxonomy.html#addImport(com.ihr.xbrl.om.taxonomy.XBRLImport) addImport(XBRLImport import)]] adds a new import to the current taxonomy schema. The method [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLTaxonomy.html#removeImport(com.ihr.xbrl.om.taxonomy.XBRLImport) removeImport(XBRLImport import)]] removes an import from the list of imported schemas on the current taxonomy. The class XBRLImport already takes care of calling addImport and removeImport in the parent object during calls to the [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLImport.html#setParent(com.ihr.xbrl.om.taxonomy.XBRLTaxonomy) setParent(XBRLTaxonomy parent)]] method so there should be no need to call this methods directly from client code.		The method [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLTaxonomy.html#addImport(com.ihr.xbrl.om.taxonomy.XBRLImport) addImport(XBRLImport import)]] adds a new import to the current taxonomy schema. The method [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLTaxonomy.html#removeImport(com.ihr.xbrl.om.taxonomy.XBRLImport) removeImport(XBRLImport import)]] removes an import from the list of imported schemas on the current taxonomy. The class [[XBRLImport]] already takes care of calling addImport and removeImport in the parent object during calls to the [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLImport.html#setParent(com.ihr.xbrl.om.taxonomy.XBRLTaxonomy) setParent(XBRLTaxonomy parent)]] method so there should be no need to call this methods directly from client code.

Ihr: /* Write access */

2009-08-11T12:53:13Z

Write access

← Older revision		Revision as of 12:53, 11 August 2009
Line 133:		Line 133:
	====Write access====		====Write access====
	The method [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLTaxonomy.html#addArcroleType(com.ihr.xbrl.om.taxonomy.XBRLArcroleType) addArcroleType(XBRLArcroleType newArcrole)]] adds a new arcrole type to the taxonomy. The method [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLTaxonomy.html#removeArcroleType(com.ihr.xbrl.om.taxonomy.XBRLArcroleType) removeArcroleType(XBRLArcroleType arcroleType)]] removes an existing arcrole from the taxonomy. Both methods are automatically called by the [[XBRLArcroleType]] class when it is necessary so there should be no need to call this methods manually from XBRL applications.		The method [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLTaxonomy.html#addArcroleType(com.ihr.xbrl.om.taxonomy.XBRLArcroleType) addArcroleType(XBRLArcroleType newArcrole)]] adds a new arcrole type to the taxonomy. The method [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLTaxonomy.html#removeArcroleType(com.ihr.xbrl.om.taxonomy.XBRLArcroleType) removeArcroleType(XBRLArcroleType arcroleType)]] removes an existing arcrole from the taxonomy. Both methods are automatically called by the [[XBRLArcroleType]] class when it is necessary so there should be no need to call this methods manually from XBRL applications.

			===Working with Imported Taxonomies===
			An XBRL Taxonomy (which is an XML Schema) can reference other XBRL Taxonomies (that, in turn are other XML Schemas) using the XML Schema <xsd:import namespace="..." schemaLocation="..."/> statement. This facilitates that all required pieces to make a taxonomy meaningful are always read together. For example; global type definitions can be all defined in separate smaller XML Schemas so they can be reused from one taxonomy version to the next one if there are no changes in the business model that is behind the type definition.

			The XBRL API allows the user to get access to the imported schemas of a taxonomy schema and to add and remove imported schemas manually. The surrounding class that represents imports is [[XBRLImport]]. That class automatically takes care of consistency.

			====Read access====
			The method [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLTaxonomy.html#getImports() getImports()]] returns an iterator over all [[XBRLImport]] objects of this taxonomy schema. The method [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLTaxonomy.html#getImport(java.net.URI) getImport(String namespaceURI)]] returns the imported schema that corresponds to the namespace indicated in the parameter or null if the taxonomy schema for that namespace is not found.

			====Write access====
			The method [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLTaxonomy.html#addImport(com.ihr.xbrl.om.taxonomy.XBRLImport) addImport(XBRLImport import)]] adds a new import to the current taxonomy schema. The method [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLTaxonomy.html#removeImport(com.ihr.xbrl.om.taxonomy.XBRLImport) removeImport(XBRLImport import)]] removes an import from the list of imported schemas on the current taxonomy. The class XBRLImport already takes care of calling addImport and removeImport in the parent object during calls to the [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLImport.html#setParent(com.ihr.xbrl.om.taxonomy.XBRLTaxonomy) setParent(XBRLTaxonomy parent)]] method so there should be no need to call this methods directly from client code.

Ihr: /* How to create an instance of an XBRLTaxonomy object */

2009-08-11T12:27:44Z

How to create an instance of an XBRLTaxonomy object

← Older revision		Revision as of 12:27, 11 August 2009
Line 18:		Line 18:
	* If the user have just created a new empty [[DTSContainer]] object and the purpose is to read the content of an XBRL taxonomy (and the whole referenced DTS) then the simplest way is to use one of the load methods in the [[DTSContainer]] object passing the document URI of the XBRL taxonomy. The returned object is an XBRLTaxonomy that can be casted to an XBRLTaxonomy.		* If the user have just created a new empty [[DTSContainer]] object and the purpose is to read the content of an XBRL taxonomy (and the whole referenced DTS) then the simplest way is to use one of the load methods in the [[DTSContainer]] object passing the document URI of the XBRL taxonomy. The returned object is an XBRLTaxonomy that can be casted to an XBRLTaxonomy.

	* If the user has already loaded a DTS (from another taxonomy file or an XBRL report) and the purpose is to create a new XBRLTaxonomy (in order to create a taxonomy extension) then, the user can use any of the available [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLTaxonomy.html#constructor_summary constructors]. The most commonly used constructor is [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLTaxonomy.html#XBRLTaxonomy(com.ihr.xbrl.om.DTSContainer) XBRLTaxonomy(com.ihr.xbrl.om.DTSContainer)] that accepts the current DTSContainer as a parameter and allows the user to start adding concepts programatically.		* If the user has already loaded a DTS (from another taxonomy file or an XBRL report) and the purpose is to create a new XBRLTaxonomy (in order to create a taxonomy extension) then, the user can use any of the available [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLTaxonomy.html#constructor_summary constructors]]. The most commonly used constructor is [[http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/taxonomy/XBRLTaxonomy.html#XBRLTaxonomy(com.ihr.xbrl.om.DTSContainer) XBRLTaxonomy(com.ihr.xbrl.om.DTSContainer)]] that accepts the current DTSContainer as a parameter and allows the user to start adding concepts programatically.

	Creation of a XBRLTaxonomy object from a local file name:		Creation of a XBRLTaxonomy object from a local file name:
Line 63:		Line 63:
	}		}
	</syntaxhighlight>		</syntaxhighlight>

	===The Namespace===		===The Namespace===

Ihr: /* Description */

2009-08-11T12:25:43Z

Description

← Older revision		Revision as of 12:25, 11 August 2009
Line 10:		Line 10:
	* all references to external XBRL Linkbases, and		* all references to external XBRL Linkbases, and
	* all embedded XBRL Linkbases, and		* all embedded XBRL Linkbases, and
	* all other XML Schema related constructions like groups, type declarations, global attribute groups, global attribute declarations and element declarations that are not XBRL concepts.		* all other XML Schema related constructions like global groups, global type declarations, global attribute groups, global attribute declarations and global element declarations that are not XBRL concepts.

	===How to create an instance of an XBRLTaxonomy object===		===How to create an instance of an XBRLTaxonomy object===