XBRLInstance - Revision history

Ihr at 09:49, 10 August 2009

2009-08-10T09:49:34Z

← Older revision		Revision as of 09:49, 10 August 2009
Line 11:		Line 11:
	===How to create an instance of an XBRLInstance object===		===How to create an instance of an XBRLInstance object===

	There are several ways depending on what ~~you~~ are ~~doing~~:		There are several ways depending on what the user needs are:

	* If the user have just created a new empty [[DTSContainer]] object and the purpose is to read the content of an XBRL report (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 report. The returned object is an XBRLDocument that can be casted to an XBRLInstance.		* If the user have just created a new empty [[DTSContainer]] object and the purpose is to read the content of an XBRL report (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 report. The returned object is an XBRLDocument that can be casted to an XBRLInstance.

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

2009-06-28T17:27:02Z

How to create an instance of an XBRLInstance object

← Older revision		Revision as of 17:27, 28 June 2009
Line 17:		Line 17:
	* If the user has already loaded a DTS (from a taxonomy file) and the purpose is to create a new XBRLInstance (in order to populate it with facts) then the user can use any of the available [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/instance/XBRLInstance.html#constructor_summary constructors]. The most commonly used constructor is [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/instance/XBRLInstance.html#XBRLInstance(com.ihr.xbrl.om.DTSContainer) XBRLInstance(com.ihr.xbrl.om.DTSContainer)] that accepts the current DTSContainer as a parameter and allows the user to start adding facts programatically.		* If the user has already loaded a DTS (from a taxonomy file) and the purpose is to create a new XBRLInstance (in order to populate it with facts) then the user can use any of the available [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/instance/XBRLInstance.html#constructor_summary constructors]. The most commonly used constructor is [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/instance/XBRLInstance.html#XBRLInstance(com.ihr.xbrl.om.DTSContainer) XBRLInstance(com.ihr.xbrl.om.DTSContainer)] that accepts the current DTSContainer as a parameter and allows the user to start adding facts programatically.

	Creation of a XBRLInstance object from a local file name: ~~[[File:SampleReadInstance.java]]~~		Creation of a XBRLInstance object from a local file name:
	<syntaxhighlight lang="java">		<syntaxhighlight lang="java">
	/**		/**

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

2009-06-28T17:25:55Z

How to create an instance of an XBRLInstance object

← Older revision		Revision as of 17:25, 28 June 2009
Line 17:		Line 17:
	* If the user has already loaded a DTS (from a taxonomy file) and the purpose is to create a new XBRLInstance (in order to populate it with facts) then the user can use any of the available [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/instance/XBRLInstance.html#constructor_summary constructors]. The most commonly used constructor is [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/instance/XBRLInstance.html#XBRLInstance(com.ihr.xbrl.om.DTSContainer) XBRLInstance(com.ihr.xbrl.om.DTSContainer)] that accepts the current DTSContainer as a parameter and allows the user to start adding facts programatically.		* If the user has already loaded a DTS (from a taxonomy file) and the purpose is to create a new XBRLInstance (in order to populate it with facts) then the user can use any of the available [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/instance/XBRLInstance.html#constructor_summary constructors]. The most commonly used constructor is [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/instance/XBRLInstance.html#XBRLInstance(com.ihr.xbrl.om.DTSContainer) XBRLInstance(com.ihr.xbrl.om.DTSContainer)] that accepts the current DTSContainer as a parameter and allows the user to start adding facts programatically.

	Creation of a XBRLInstance object from a local file name:		Creation of a XBRLInstance object from a local file name: [[File:SampleReadInstance.java]]
	<syntaxhighlight lang="java">		<syntaxhighlight lang="java">
	/**		/**

Ihr: /* Working with units */

2009-06-28T12:42:56Z

Working with units

← Older revision		Revision as of 12:42, 28 June 2009
Line 154:		Line 154:

	===Working with units===		===Working with units===

			This section describes the relationships between XBRL units and the instance document. For more information about the unit object visit the [[XBRLUnit]] page.

			====Adding new====

			Under normal circumstances the user should not care about manually adding units to the XBRLInstance. They are added automatically when new numeric facts are created. If for any reason there is a need to add units manually the method that can be used for this purpose is [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/instance/XBRLInstance.html#addUnit(com.ihr.xbrl.om.instance.XBRLUnit) addUnit(com.ihr.xbrl.om.instance.XBRLUnit)].

			====Read access====

			Normally the unit is obtained from a numeric fact item using the [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/instance/XBRLFactNumeric.html#getUnit() getUnit()] method of the [[XBRLFactNumeric]] object.

			Looking at the units that exists in the instance document can be implemented in several ways:

			* All units are indexed by the unit id. The method [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/instance/XBRLInstance.html#getUnitById(java.lang.String) getUnitById(java.lang.String)] returns a specific unit if you know the id in advance.

			* The method [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/instance/XBRLInstance.html#getUnits() getUnits()] returns an iterator over all units in the instance.

			====Creating new====

			Creating new units is an independent operation of the instance where the unit will be serialized. Read the [[XBRLUnit]] page in order to get more information about how to create a new Unit.

			====Removing====

			The method [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/instance/XBRLInstance.html#delUnit(com.ihr.xbrl.om.instance.XBRLUnit) delUnit(com.ihr.xbrl.om.instance.XBRLUnit)] can be used to delete a unit and all associated facts in an instance. Although the use of this method is discouraged as the units are automatically deleted when they are no longer referenced from numeric facts.

	===Working with footnotes===		===Working with footnotes===

Ihr: /* Working with contexts */

2009-06-28T12:34:09Z

Working with contexts

← Older revision		Revision as of 12:34, 28 June 2009
Line 130:		Line 130:

	This section describes the relationships between the context and the instance document. For more information about the context object visit the [[XBRLContext]] page.		This section describes the relationships between the context and the instance document. For more information about the context object visit the [[XBRLContext]] page.

			====Adding new====

	Under normal circumstances the user should not care about manually adding contexts to the XBRLInstance. They are added automatically when new facts are created. If for any reason there is a need to add contexts manually the method that can be used for this purpose is [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/instance/XBRLInstance.html#addContext(com.ihr.xbrl.om.instance.XBRLContext) addContext(com.ihr.xbrl.om.instance.XBRLContext)].		Under normal circumstances the user should not care about manually adding contexts to the XBRLInstance. They are added automatically when new facts are created. If for any reason there is a need to add contexts manually the method that can be used for this purpose is [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/instance/XBRLInstance.html#addContext(com.ihr.xbrl.om.instance.XBRLContext) addContext(com.ihr.xbrl.om.instance.XBRLContext)].

			====Read access====

	Normally the context is obtained from a fact item using the [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/instance/XBRLFactItem.html#getContext() getContext()] method of the [[XBRLFactItem]] object.		Normally the context is obtained from a fact item using the [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/instance/XBRLFactItem.html#getContext() getContext()] method of the [[XBRLFactItem]] object.

	~~====Read access====~~

	Looking at the contexts that exists in the instance document can be implemented in several ways:		Looking at the contexts that exists in the instance document can be implemented in several ways:

Ihr: /* Working with contexts */

2009-06-28T12:32:45Z

Working with contexts

← Older revision		Revision as of 12:32, 28 June 2009
Line 128:		Line 128:

	===Working with contexts===		===Working with contexts===

			This section describes the relationships between the context and the instance document. For more information about the context object visit the [[XBRLContext]] page.

	Under normal circumstances the user should not care about manually adding contexts to the XBRLInstance. They are added automatically when new facts are created. If for any reason there is a need to add contexts manually the method that can be used for this purpose is [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/instance/XBRLInstance.html#addContext(com.ihr.xbrl.om.instance.XBRLContext) addContext(com.ihr.xbrl.om.instance.XBRLContext)].		Under normal circumstances the user should not care about manually adding contexts to the XBRLInstance. They are added automatically when new facts are created. If for any reason there is a need to add contexts manually the method that can be used for this purpose is [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/instance/XBRLInstance.html#addContext(com.ihr.xbrl.om.instance.XBRLContext) addContext(com.ihr.xbrl.om.instance.XBRLContext)].

	Normally the context is obtained from a fact item using the [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/instance/XBRLFactItem.html#getContext() getContext()] method of the [[XBRLFactItem]] object.		Normally the context is obtained from a fact item using the [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/instance/XBRLFactItem.html#getContext() getContext()] method of the [[XBRLFactItem]] object.

			====Read access====

	Looking at the contexts that exists in the instance document can be implemented in several ways:		Looking at the contexts that exists in the instance document can be implemented in several ways:
Line 138:		Line 142:

	* The method [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/instance/XBRLInstance.html#getContexts() getContexts()] returns an iterator over all contexts in the instance.		* The method [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/instance/XBRLInstance.html#getContexts() getContexts()] returns an iterator over all contexts in the instance.

			====Creating new====

			Creating new contexts is an independent operation of the instance where the context will be serialized. Read the [[XBRLContext]] page in order to get more information about how to create a new Context.

			====Removing====

	The method [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/instance/XBRLInstance.html#delContext(com.ihr.xbrl.om.instance.XBRLContext) delContext(com.ihr.xbrl.om.instance.XBRLContext)] can be used to delete a context and all associated facts in an instance. Although the use of this method is discouraged as the contexts are automatically deleted when they are no longer referenced from facts.		The method [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/instance/XBRLInstance.html#delContext(com.ihr.xbrl.om.instance.XBRLContext) delContext(com.ihr.xbrl.om.instance.XBRLContext)] can be used to delete a context and all associated facts in an instance. Although the use of this method is discouraged as the contexts are automatically deleted when they are no longer referenced from facts.

Ihr: /* Working with facts */

2009-06-28T00:53:13Z

Working with facts

← Older revision		Revision as of 00:53, 28 June 2009
Line 68:		Line 68:
	</syntaxhighlight>		</syntaxhighlight>

	====Creating new ~~facts~~====		====Creating new====

	Creating a fact is a very simple task. The user just need to call the apropriate constructor depending on the type of fact to be created. The final fact types that the user can directly create are:		Creating a fact is a very simple task. The user just need to call the apropriate constructor depending on the type of fact to be created. The final fact types that the user can directly create are:
Line 106:		Line 106:
	</syntaxhighlight>		</syntaxhighlight>

	====Removing ~~facts~~====		====Removing====

	There are several ways to remove a fact from an XBRLInstance:		There are several ways to remove a fact from an XBRLInstance:

Ihr: /* Removing facts */

2009-06-28T00:51:13Z

Removing facts

← Older revision		Revision as of 00:51, 28 June 2009
Line 108:		Line 108:
	====Removing facts====		====Removing facts====

	~~Facts can be removed~~ from ~~the instance document using~~ the [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/instance/XBRLInstance.html#remove(com.ihr.xbrl.om.instance.XBRLFact) remove(com.ihr.xbrl.om.instance.XBRLFact)] method. This method is part of the [[XBRLFactsList]] interface so it is documented there.		There are several ways to remove a fact from an XBRLInstance:
			* By invoking the [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/instance/XBRLInstance.html#remove(com.ihr.xbrl.om.instance.XBRLFact) remove(com.ihr.xbrl.om.instance.XBRLFact)] method. This method is part of the [[XBRLFactsList]] interface so it is documented there.
			* By invoking the [[XBRLFact]] [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/instance/XBRLFact.html#clear() clear()] method.
			* By setting the fact parent to null [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/instance/XBRLFact.html#setParent(com.ihr.xbrl.om.instance.XBRLFactsList) setParent(com.ihr.xbrl.om.instance.XBRLFactsList)]

	===Managing the elements that compose the DTS===		===Managing the elements that compose the DTS===

Ihr: /* Removing facts */

2009-06-27T20:36:33Z

Removing facts

← Older revision		Revision as of 20:36, 27 June 2009
Line 106:		Line 106:
	</syntaxhighlight>		</syntaxhighlight>

	====~~Deleting~~ facts====		====Removing facts====

			Facts can be removed from the instance document using the [http://www.reportingstandard.com/apidoc/com/ihr/xbrl/om/instance/XBRLInstance.html#remove(com.ihr.xbrl.om.instance.XBRLFact) remove(com.ihr.xbrl.om.instance.XBRLFact)] method. This method is part of the [[XBRLFactsList]] interface so it is documented there.

	===Managing the elements that compose the DTS===		===Managing the elements that compose the DTS===

Ihr: /* Working with facts */

2009-06-27T20:33:11Z

Working with facts

← Older revision		Revision as of 20:33, 27 June 2009
Line 105:		Line 105:
	fA.setValue(new StringValue("test"));		fA.setValue(new StringValue("test"));
	</syntaxhighlight>		</syntaxhighlight>

			====Deleting facts====

	===Managing the elements that compose the DTS===		===Managing the elements that compose the DTS===