xbrlware-ce 1.0.4 → 1.1.0
Sign up to get free protection for your applications and to get access to all the features.
- data/Rakefile.rb +4 -4
- data/Readme.txt +6 -1
- data/ReleaseNotes.txt +22 -5
- data/doc/classes/Edgar/HTMLFeedDownloader.html +8 -8
- data/doc/classes/Edgar/RSSFeedDownloader.html +15 -15
- data/doc/classes/Xbrlware.html +22 -0
- data/doc/classes/Xbrlware/Context.html +104 -74
- data/doc/classes/Xbrlware/Context/Period.html +305 -0
- data/doc/classes/Xbrlware/Entity.html +75 -51
- data/doc/classes/Xbrlware/Identifier.html +17 -17
- data/doc/classes/Xbrlware/Instance.html +165 -137
- data/doc/classes/Xbrlware/Item.html +19 -19
- data/doc/classes/Xbrlware/Linkbase/CalculationLinkbase/Calculation.html +1 -1
- data/doc/classes/Xbrlware/Linkbase/DefinitionLinkbase/Definition.html +2 -2
- data/doc/classes/Xbrlware/Linkbase/Linkbase/Link.html +9 -3
- data/doc/classes/Xbrlware/Linkbase/Linkbase/Link/Arc.html +4 -4
- data/doc/classes/Xbrlware/Linkbase/PresentationLinkbase/Presentation.html +1 -1
- data/doc/classes/Xbrlware/Report.html +352 -0
- data/doc/classes/Xbrlware/Taxonomy.html +48 -48
- data/doc/classes/Xbrlware/TaxonomyDefintion.html +15 -15
- data/doc/classes/Xbrlware/Unit.html +6 -6
- data/doc/classes/Xbrlware/Unit/Divide.html +6 -6
- data/doc/created.rid +1 -1
- data/doc/files/Readme_txt.html +9 -1
- data/doc/files/lib/xbrlware/context_rb.html +1 -1
- data/doc/files/lib/xbrlware/date_util_rb.html +1 -1
- data/doc/files/lib/xbrlware/instance_rb.html +1 -1
- data/doc/files/lib/xbrlware/linkbase/calculation_linkbase_rb.html +1 -1
- data/doc/files/lib/xbrlware/linkbase/definition_linkbase_rb.html +1 -1
- data/doc/files/lib/xbrlware/linkbase/linkbase_rb.html +1 -1
- data/doc/files/lib/xbrlware/linkbase/presentation_linkbase_rb.html +1 -1
- data/doc/files/lib/xbrlware/meta_util_rb.html +1 -1
- data/doc/files/lib/xbrlware/report_rb.html +101 -0
- data/doc/files/lib/xbrlware/taxonomy_rb.html +1 -1
- data/doc/files/lib/xbrlware/version_rb.html +129 -0
- data/doc/fr_class_index.html +2 -0
- data/doc/fr_file_index.html +2 -0
- data/doc/fr_method_index.html +75 -62
- data/example/case_study/buy_strategy.rb +1 -1
- data/example/case_study/c_sell_strategy.rb +1 -1
- data/lib/xbrlware/context.rb +77 -34
- data/lib/xbrlware/date_util.rb +16 -6
- data/lib/xbrlware/instance.rb +35 -28
- data/lib/xbrlware/linkbase/calculation_linkbase.rb +1 -1
- data/lib/xbrlware/linkbase/definition_linkbase.rb +2 -2
- data/lib/xbrlware/linkbase/linkbase.rb +3 -2
- data/lib/xbrlware/linkbase/presentation_linkbase.rb +1 -1
- data/lib/xbrlware/meta_util.rb +5 -0
- data/lib/xbrlware/report.rb +277 -0
- data/lib/xbrlware/taxonomy.rb +13 -10
- data/lib/xbrlware/version.rb +22 -0
- data/test/lib/xbrlware/47_context_test.rb +13 -4
- data/test/lib/xbrlware/date_util_test.rb +10 -2
- data/test/lib/xbrlware/instance_test.rb +19 -0
- data/test/lib/xbrlware/meta_util_test.rb +21 -1
- metadata +10 -4
data/Rakefile.rb
CHANGED
@@ -24,6 +24,7 @@ require 'rake/gempackagetask'
|
|
24
24
|
require 'rake/clean'
|
25
25
|
require 'rake/testtask'
|
26
26
|
require 'rake/rdoctask'
|
27
|
+
require 'xbrlware/version'
|
27
28
|
|
28
29
|
|
29
30
|
LIBDIR = 'lib'
|
@@ -32,8 +33,7 @@ TESTDIR = 'test'
|
|
32
33
|
EXAMPLEDIR = 'example'
|
33
34
|
|
34
35
|
# Configure some constants and built-in tasks
|
35
|
-
|
36
|
-
PKG_VERSION = ENV['REL'] ? ENV['REL'] : CURRENT_VERSION
|
36
|
+
PKG_VERSION = Xbrlware::VERSION
|
37
37
|
|
38
38
|
COMMUNITY_EDITION = 'xbrlware-ce'
|
39
39
|
PKG_NAME = ENV['EDT'] ? ENV['EDT'] : COMMUNITY_EDITION
|
@@ -90,12 +90,12 @@ else
|
|
90
90
|
# Basic information
|
91
91
|
s.name = PKG_NAME
|
92
92
|
s.version = PKG_VERSION
|
93
|
-
s.summary = 'A fast, lightweight framework to parse, extract information from XBRL documents.'
|
93
|
+
s.summary = 'A fast, lightweight framework to parse, extract information from XBRL Instance, Taxonomy and Linkbase documents.'
|
94
94
|
description = s.summary +
|
95
95
|
"\nxbrlware understands structure and relationship among elements of XBRL documents and" +
|
96
96
|
"\ndefines a set of APIs for accessing financial & business facts, meta & other related information"+
|
97
97
|
"\ndefined in XBRL documents."
|
98
|
-
|
98
|
+
|
99
99
|
s.description = description
|
100
100
|
|
101
101
|
# Files and dependencies
|
data/Readme.txt
CHANGED
@@ -12,4 +12,9 @@ Unless required by applicable law or agreed to in writing, software
|
|
12
12
|
distributed under the License is distributed on an "AS IS" BASIS,
|
13
13
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
14
|
See the License for the specific language governing permissions and
|
15
|
-
limitations under the License.
|
15
|
+
limitations under the License.
|
16
|
+
|
17
|
+
Get started Guide
|
18
|
+
==================
|
19
|
+
http://code.google.com/p/xbrlware/wiki/GetStarted
|
20
|
+
|
data/ReleaseNotes.txt
CHANGED
@@ -1,8 +1,25 @@
|
|
1
|
-
bitstat
|
1
|
+
bitstat (http://www.bitstat.com) xbrlware release notes
|
2
|
+
=======================================================
|
2
3
|
|
3
|
-
|
4
|
+
Release 1.1.0
|
5
|
+
Bugs
|
6
|
+
* [xbrlware-ce-dev-4] : entity_details method of instance.rb is specific to US & not applicable to other countries
|
7
|
+
* [xbrlware-ce-dev-5] : When linkbase documents mentioned in taxonomy are not available, ignore them than raising error
|
8
|
+
* [xbrlware-ee] : In reports, should not format entity_details like CIK, Outstanding shares and other entity details as numbers
|
9
|
+
: In reports, provide custom option to format item values
|
10
|
+
: Make HTML reports social friendly ( to share in facebook, myspace etc)
|
11
|
+
Changes
|
12
|
+
* [xbrlware-ce-dev-6] : context.period changed to return Context::Period object. If you are accessing period of
|
13
|
+
context as "context.period", change that to "context.period.value"
|
14
|
+
* [xbrlware-ce-dev-7] : New methods added to period, is_instant?, is_duration? and is_forever?
|
15
|
+
* [xbrlware-ce-dev-8] : Instant and duration period should return Date instead of String
|
16
|
+
Features
|
17
|
+
* [xbrlware-ce-dev-9] : has_scenario? added to context and has_segment? added to context.entity
|
18
|
+
|
19
|
+
Release 1.0.3
|
20
|
+
Bugs
|
21
|
+
* [xbrlware-ce-dev-1] : footnoteLink element may exist without footnote, footnoteArc in instance document.
|
22
|
+
* [xbrlware-ce-dev-2] : error raised when xbrl linkbase document has HTML element  
|
23
|
+
* [xbrlware-ce-dev-3] : file_grep not working as intended when reference linkbase file is present.
|
4
24
|
|
5
|
-
* [xbrlware-ce-dev-1] : footnoteLink element may exist without footnote, footnoteArc in instance document.
|
6
|
-
* [xbrlware-ce-dev-2] : error raised when xbrl linkbase document has HTML element  
|
7
|
-
* [xbrlware-ce-dev-3] : file_grep not working as intended when reference linkbase file is present.
|
8
25
|
|
@@ -81,7 +81,7 @@
|
|
81
81
|
<div id="description">
|
82
82
|
<p>
|
83
83
|
This class defines method to <a
|
84
|
-
href="HTMLFeedDownloader.html#
|
84
|
+
href="HTMLFeedDownloader.html#M000093">download</a> XBRL files from
|
85
85
|
SEC‘s EDGAR filling url. See <a
|
86
86
|
href="http://code.google.com/p/xbrlware/wiki/ReportGeneration">report
|
87
87
|
generation xbrlware wiki</a> for how to use this class.
|
@@ -96,7 +96,7 @@ generation xbrlware wiki</a> for how to use this class.
|
|
96
96
|
<h3 class="section-bar">Methods</h3>
|
97
97
|
|
98
98
|
<div class="name-list">
|
99
|
-
<a href="#
|
99
|
+
<a href="#M000093">download</a>
|
100
100
|
</div>
|
101
101
|
</div>
|
102
102
|
|
@@ -139,11 +139,11 @@ generation xbrlware wiki</a> for how to use this class.
|
|
139
139
|
<div id="methods">
|
140
140
|
<h3 class="section-bar">Public Instance methods</h3>
|
141
141
|
|
142
|
-
<div id="method-
|
143
|
-
<a name="
|
142
|
+
<div id="method-M000093" class="method-detail">
|
143
|
+
<a name="M000093"></a>
|
144
144
|
|
145
145
|
<div class="method-heading">
|
146
|
-
<a href="#
|
146
|
+
<a href="#M000093" class="method-signature">
|
147
147
|
<span class="method-name">download</span><span class="method-args">(url, download_to=File.expand_path(".")+File::SEPARATOR)</span>
|
148
148
|
</a>
|
149
149
|
</div>
|
@@ -151,14 +151,14 @@ generation xbrlware wiki</a> for how to use this class.
|
|
151
151
|
<div class="method-description">
|
152
152
|
<p>
|
153
153
|
Takes url and download_to (where to <a
|
154
|
-
href="HTMLFeedDownloader.html#
|
154
|
+
href="HTMLFeedDownloader.html#M000093">download</a>)
|
155
155
|
</p>
|
156
156
|
<pre>
|
157
157
|
default value for download_to is current_dir
|
158
158
|
</pre>
|
159
159
|
<p><a class="source-toggle" href="#"
|
160
|
-
onclick="toggleCode('
|
161
|
-
<div class="method-source-code" id="
|
160
|
+
onclick="toggleCode('M000093-source');return false;">[Source]</a></p>
|
161
|
+
<div class="method-source-code" id="M000093-source">
|
162
162
|
<pre>
|
163
163
|
<span class="ruby-comment cmt"># File lib/edgar/edgar_data_downloader.rb, line 92</span>
|
164
164
|
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">download</span>(<span class="ruby-identifier">url</span>, <span class="ruby-identifier">download_to</span>=<span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-value str">"."</span>)<span class="ruby-operator">+</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">SEPARATOR</span>)
|
@@ -81,7 +81,7 @@
|
|
81
81
|
<div id="description">
|
82
82
|
<p>
|
83
83
|
This class defines method to <a
|
84
|
-
href="RSSFeedDownloader.html#
|
84
|
+
href="RSSFeedDownloader.html#M000092">download</a> XBRL files from
|
85
85
|
SEC‘s XBRL RSS Feed. See <a
|
86
86
|
href="http://code.google.com/p/xbrlware/wiki/ReportGeneration">report
|
87
87
|
generation xbrlware wiki</a> for how to use this class.
|
@@ -96,8 +96,8 @@ generation xbrlware wiki</a> for how to use this class.
|
|
96
96
|
<h3 class="section-bar">Methods</h3>
|
97
97
|
|
98
98
|
<div class="name-list">
|
99
|
-
<a href="#
|
100
|
-
<a href="#
|
99
|
+
<a href="#M000092">download</a>
|
100
|
+
<a href="#M000091">new</a>
|
101
101
|
</div>
|
102
102
|
</div>
|
103
103
|
|
@@ -139,19 +139,19 @@ generation xbrlware wiki</a> for how to use this class.
|
|
139
139
|
<div id="methods">
|
140
140
|
<h3 class="section-bar">Public Class methods</h3>
|
141
141
|
|
142
|
-
<div id="method-
|
143
|
-
<a name="
|
142
|
+
<div id="method-M000091" class="method-detail">
|
143
|
+
<a name="M000091"></a>
|
144
144
|
|
145
145
|
<div class="method-heading">
|
146
|
-
<a href="#
|
146
|
+
<a href="#M000091" class="method-signature">
|
147
147
|
<span class="method-name">new</span><span class="method-args">(sec_edgar_rss_file=nil)</span>
|
148
148
|
</a>
|
149
149
|
</div>
|
150
150
|
|
151
151
|
<div class="method-description">
|
152
152
|
<p><a class="source-toggle" href="#"
|
153
|
-
onclick="toggleCode('
|
154
|
-
<div class="method-source-code" id="
|
153
|
+
onclick="toggleCode('M000091-source');return false;">[Source]</a></p>
|
154
|
+
<div class="method-source-code" id="M000091-source">
|
155
155
|
<pre>
|
156
156
|
<span class="ruby-comment cmt"># File lib/edgar/edgar_data_downloader.rb, line 29</span>
|
157
157
|
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">sec_edgar_rss_file</span>=<span class="ruby-keyword kw">nil</span>)
|
@@ -165,11 +165,11 @@ generation xbrlware wiki</a> for how to use this class.
|
|
165
165
|
|
166
166
|
<h3 class="section-bar">Public Instance methods</h3>
|
167
167
|
|
168
|
-
<div id="method-
|
169
|
-
<a name="
|
168
|
+
<div id="method-M000092" class="method-detail">
|
169
|
+
<a name="M000092"></a>
|
170
170
|
|
171
171
|
<div class="method-heading">
|
172
|
-
<a href="#
|
172
|
+
<a href="#M000092" class="method-signature">
|
173
173
|
<span class="method-name">download</span><span class="method-args">(limit=100, download_to=File.expand_path(".")+File::SEPARATOR+"edgar_data")</span>
|
174
174
|
</a>
|
175
175
|
</div>
|
@@ -177,16 +177,16 @@ generation xbrlware wiki</a> for how to use this class.
|
|
177
177
|
<div class="method-description">
|
178
178
|
<p>
|
179
179
|
Takes limit (how many entities to <a
|
180
|
-
href="RSSFeedDownloader.html#
|
181
|
-
<a href="RSSFeedDownloader.html#
|
180
|
+
href="RSSFeedDownloader.html#M000092">download</a>), download_to (where to
|
181
|
+
<a href="RSSFeedDownloader.html#M000092">download</a>)
|
182
182
|
</p>
|
183
183
|
<pre>
|
184
184
|
default value for limit is 100
|
185
185
|
default value for download_to is current_dir + "/edgar_data"
|
186
186
|
</pre>
|
187
187
|
<p><a class="source-toggle" href="#"
|
188
|
-
onclick="toggleCode('
|
189
|
-
<div class="method-source-code" id="
|
188
|
+
onclick="toggleCode('M000092-source');return false;">[Source]</a></p>
|
189
|
+
<div class="method-source-code" id="M000092-source">
|
190
190
|
<pre>
|
191
191
|
<span class="ruby-comment cmt"># File lib/edgar/edgar_data_downloader.rb, line 37</span>
|
192
192
|
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">download</span>(<span class="ruby-identifier">limit</span>=<span class="ruby-value">100</span>, <span class="ruby-identifier">download_to</span>=<span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-value str">"."</span>)<span class="ruby-operator">+</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">SEPARATOR</span><span class="ruby-operator">+</span><span class="ruby-value str">"edgar_data"</span>)
|
data/doc/classes/Xbrlware.html
CHANGED
@@ -55,6 +55,10 @@
|
|
55
55
|
<tr class="top-aligned-row">
|
56
56
|
<td><strong>In:</strong></td>
|
57
57
|
<td>
|
58
|
+
<a href="../files/lib/xbrlware/version_rb.html">
|
59
|
+
lib/xbrlware/version.rb
|
60
|
+
</a>
|
61
|
+
<br />
|
58
62
|
<a href="../files/lib/xbrlware/linkbase/definition_linkbase_rb.html">
|
59
63
|
lib/xbrlware/linkbase/definition_linkbase.rb
|
60
64
|
</a>
|
@@ -82,6 +86,10 @@
|
|
82
86
|
<a href="../files/lib/xbrlware/constants_rb.html">
|
83
87
|
lib/xbrlware/constants.rb
|
84
88
|
</a>
|
89
|
+
<br />
|
90
|
+
<a href="../files/lib/xbrlware/report_rb.html">
|
91
|
+
lib/xbrlware/report.rb
|
92
|
+
</a>
|
85
93
|
<br />
|
86
94
|
<a href="../files/lib/xbrlware/instance_rb.html">
|
87
95
|
lib/xbrlware/instance.rb
|
@@ -190,12 +198,26 @@ Class <a href="Xbrlware/Entity.html" class="link">Xbrlware::Entity</a><br />
|
|
190
198
|
Class <a href="Xbrlware/Identifier.html" class="link">Xbrlware::Identifier</a><br />
|
191
199
|
Class <a href="Xbrlware/Instance.html" class="link">Xbrlware::Instance</a><br />
|
192
200
|
Class <a href="Xbrlware/Item.html" class="link">Xbrlware::Item</a><br />
|
201
|
+
Class <a href="Xbrlware/Report.html" class="link">Xbrlware::Report</a><br />
|
193
202
|
Class <a href="Xbrlware/Taxonomy.html" class="link">Xbrlware::Taxonomy</a><br />
|
194
203
|
Class <a href="Xbrlware/TaxonomyDefintion.html" class="link">Xbrlware::TaxonomyDefintion</a><br />
|
195
204
|
Class <a href="Xbrlware/Unit.html" class="link">Xbrlware::Unit</a><br />
|
196
205
|
|
197
206
|
</div>
|
198
207
|
|
208
|
+
<div id="constants-list">
|
209
|
+
<h3 class="section-bar">Constants</h3>
|
210
|
+
|
211
|
+
<div class="name-list">
|
212
|
+
<table summary="Constants">
|
213
|
+
<tr class="top-aligned-row context-row">
|
214
|
+
<td class="context-item-name">VERSION</td>
|
215
|
+
<td>=</td>
|
216
|
+
<td class="context-item-value">"1.1.0"</td>
|
217
|
+
</tr>
|
218
|
+
</table>
|
219
|
+
</div>
|
220
|
+
</div>
|
199
221
|
|
200
222
|
|
201
223
|
|
@@ -94,18 +94,19 @@ instance page on xbrlware wiki</a> for more details.
|
|
94
94
|
<h3 class="section-bar">Methods</h3>
|
95
95
|
|
96
96
|
<div class="name-list">
|
97
|
-
<a href="#
|
98
|
-
<a href="#
|
99
|
-
<a href="#
|
100
|
-
<a href="#
|
101
|
-
<a href="#
|
102
|
-
<a href="#
|
103
|
-
<a href="#
|
104
|
-
<a href="#
|
105
|
-
<a href="#
|
106
|
-
<a href="#
|
107
|
-
<a href="#
|
108
|
-
<a href="#
|
97
|
+
<a href="#M000042">dimensions</a>
|
98
|
+
<a href="#M000046">dimensions_domains</a>
|
99
|
+
<a href="#M000044">domains</a>
|
100
|
+
<a href="#M000037">eql?</a>
|
101
|
+
<a href="#M000041">explicit_dimensions</a>
|
102
|
+
<a href="#M000045">explicit_dimensions_domains</a>
|
103
|
+
<a href="#M000043">explicit_domains</a>
|
104
|
+
<a href="#M000040">has_dimensions?</a>
|
105
|
+
<a href="#M000039">has_explicit_dimensions?</a>
|
106
|
+
<a href="#M000035">has_scenario?</a>
|
107
|
+
<a href="#M000038">hash</a>
|
108
|
+
<a href="#M000034">new</a>
|
109
|
+
<a href="#M000036">to_s</a>
|
109
110
|
</div>
|
110
111
|
</div>
|
111
112
|
|
@@ -116,6 +117,12 @@ instance page on xbrlware wiki</a> for more details.
|
|
116
117
|
|
117
118
|
<div id="section">
|
118
119
|
|
120
|
+
<div id="class-list">
|
121
|
+
<h3 class="section-bar">Classes and Modules</h3>
|
122
|
+
|
123
|
+
Class <a href="Context/Period.html" class="link">Xbrlware::Context::Period</a><br />
|
124
|
+
|
125
|
+
</div>
|
119
126
|
|
120
127
|
<div id="constants-list">
|
121
128
|
<h3 class="section-bar">Constants</h3>
|
@@ -168,25 +175,25 @@ instance page on xbrlware wiki</a> for more details.
|
|
168
175
|
<div id="methods">
|
169
176
|
<h3 class="section-bar">Public Class methods</h3>
|
170
177
|
|
171
|
-
<div id="method-
|
172
|
-
<a name="
|
178
|
+
<div id="method-M000034" class="method-detail">
|
179
|
+
<a name="M000034"></a>
|
173
180
|
|
174
181
|
<div class="method-heading">
|
175
|
-
<a href="#
|
176
|
-
<span class="method-name">new</span><span class="method-args">(id,entity,period, scenario=nil)</span>
|
182
|
+
<a href="#M000034" class="method-signature">
|
183
|
+
<span class="method-name">new</span><span class="method-args">(id, entity, period, scenario=nil)</span>
|
177
184
|
</a>
|
178
185
|
</div>
|
179
186
|
|
180
187
|
<div class="method-description">
|
181
188
|
<p><a class="source-toggle" href="#"
|
182
|
-
onclick="toggleCode('
|
183
|
-
<div class="method-source-code" id="
|
189
|
+
onclick="toggleCode('M000034-source');return false;">[Source]</a></p>
|
190
|
+
<div class="method-source-code" id="M000034-source">
|
184
191
|
<pre>
|
185
|
-
<span class="ruby-comment cmt"># File lib/xbrlware/context.rb, line
|
186
|
-
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">id</span
|
192
|
+
<span class="ruby-comment cmt"># File lib/xbrlware/context.rb, line 59</span>
|
193
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">entity</span>, <span class="ruby-identifier">period</span>, <span class="ruby-identifier">scenario</span>=<span class="ruby-keyword kw">nil</span>)
|
187
194
|
<span class="ruby-ivar">@id</span> = <span class="ruby-identifier">id</span>
|
188
195
|
<span class="ruby-ivar">@entity</span> = <span class="ruby-identifier">entity</span>
|
189
|
-
<span class="ruby-ivar">@period</span> = <span class="ruby-identifier">period</span>
|
196
|
+
<span class="ruby-ivar">@period</span> = <span class="ruby-constant">Period</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">period</span>)
|
190
197
|
<span class="ruby-ivar">@scenario</span>=<span class="ruby-identifier">scenario</span>
|
191
198
|
<span class="ruby-keyword kw">end</span>
|
192
199
|
</pre>
|
@@ -196,8 +203,8 @@ instance page on xbrlware wiki</a> for more details.
|
|
196
203
|
|
197
204
|
<h3 class="section-bar">Public Instance methods</h3>
|
198
205
|
|
199
|
-
<div id="method-
|
200
|
-
<a name="
|
206
|
+
<div id="method-M000042" class="method-detail">
|
207
|
+
<a name="M000042"></a>
|
201
208
|
|
202
209
|
<div class="method-heading">
|
203
210
|
<span class="method-name">dimensions</span><span class="method-args">()</span>
|
@@ -205,13 +212,13 @@ instance page on xbrlware wiki</a> for more details.
|
|
205
212
|
|
206
213
|
<div class="method-description">
|
207
214
|
<p>
|
208
|
-
Alias for <a href="Context.html#
|
215
|
+
Alias for <a href="Context.html#M000041">explicit_dimensions</a>
|
209
216
|
</p>
|
210
217
|
</div>
|
211
218
|
</div>
|
212
219
|
|
213
|
-
<div id="method-
|
214
|
-
<a name="
|
220
|
+
<div id="method-M000046" class="method-detail">
|
221
|
+
<a name="M000046"></a>
|
215
222
|
|
216
223
|
<div class="method-heading">
|
217
224
|
<span class="method-name">dimensions_domains</span><span class="method-args">()</span>
|
@@ -219,13 +226,13 @@ Alias for <a href="Context.html#M000037">explicit_dimensions</a>
|
|
219
226
|
|
220
227
|
<div class="method-description">
|
221
228
|
<p>
|
222
|
-
Alias for <a href="Context.html#
|
229
|
+
Alias for <a href="Context.html#M000045">explicit_dimensions_domains</a>
|
223
230
|
</p>
|
224
231
|
</div>
|
225
232
|
</div>
|
226
233
|
|
227
|
-
<div id="method-
|
228
|
-
<a name="
|
234
|
+
<div id="method-M000044" class="method-detail">
|
235
|
+
<a name="M000044"></a>
|
229
236
|
|
230
237
|
<div class="method-heading">
|
231
238
|
<span class="method-name">domains</span><span class="method-args">(dimensions=[])</span>
|
@@ -233,26 +240,26 @@ Alias for <a href="Context.html#M000041">explicit_dimensions_domains</a>
|
|
233
240
|
|
234
241
|
<div class="method-description">
|
235
242
|
<p>
|
236
|
-
Alias for <a href="Context.html#
|
243
|
+
Alias for <a href="Context.html#M000043">explicit_domains</a>
|
237
244
|
</p>
|
238
245
|
</div>
|
239
246
|
</div>
|
240
247
|
|
241
|
-
<div id="method-
|
242
|
-
<a name="
|
248
|
+
<div id="method-M000037" class="method-detail">
|
249
|
+
<a name="M000037"></a>
|
243
250
|
|
244
251
|
<div class="method-heading">
|
245
|
-
<a href="#
|
252
|
+
<a href="#M000037" class="method-signature">
|
246
253
|
<span class="method-name">eql?</span><span class="method-args">(o)</span>
|
247
254
|
</a>
|
248
255
|
</div>
|
249
256
|
|
250
257
|
<div class="method-description">
|
251
258
|
<p><a class="source-toggle" href="#"
|
252
|
-
onclick="toggleCode('
|
253
|
-
<div class="method-source-code" id="
|
259
|
+
onclick="toggleCode('M000037-source');return false;">[Source]</a></p>
|
260
|
+
<div class="method-source-code" id="M000037-source">
|
254
261
|
<pre>
|
255
|
-
<span class="ruby-comment cmt"># File lib/xbrlware/context.rb, line
|
262
|
+
<span class="ruby-comment cmt"># File lib/xbrlware/context.rb, line 74</span>
|
256
263
|
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">eql?</span>(<span class="ruby-identifier">o</span>)
|
257
264
|
<span class="ruby-identifier">o</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Context</span>) <span class="ruby-operator">&&</span> <span class="ruby-ivar">@id</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">id</span>
|
258
265
|
<span class="ruby-keyword kw">end</span>
|
@@ -261,21 +268,21 @@ Alias for <a href="Context.html#M000039">explicit_domains</a>
|
|
261
268
|
</div>
|
262
269
|
</div>
|
263
270
|
|
264
|
-
<div id="method-
|
265
|
-
<a name="
|
271
|
+
<div id="method-M000041" class="method-detail">
|
272
|
+
<a name="M000041"></a>
|
266
273
|
|
267
274
|
<div class="method-heading">
|
268
|
-
<a href="#
|
275
|
+
<a href="#M000041" class="method-signature">
|
269
276
|
<span class="method-name">explicit_dimensions</span><span class="method-args">()</span>
|
270
277
|
</a>
|
271
278
|
</div>
|
272
279
|
|
273
280
|
<div class="method-description">
|
274
281
|
<p><a class="source-toggle" href="#"
|
275
|
-
onclick="toggleCode('
|
276
|
-
<div class="method-source-code" id="
|
282
|
+
onclick="toggleCode('M000041-source');return false;">[Source]</a></p>
|
283
|
+
<div class="method-source-code" id="M000041-source">
|
277
284
|
<pre>
|
278
|
-
<span class="ruby-comment cmt"># File lib/xbrlware/context.rb, line
|
285
|
+
<span class="ruby-comment cmt"># File lib/xbrlware/context.rb, line 89</span>
|
279
286
|
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">explicit_dimensions</span>
|
280
287
|
<span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@entity</span>.<span class="ruby-identifier">explicit_dimensions</span>
|
281
288
|
<span class="ruby-keyword kw">end</span>
|
@@ -284,21 +291,21 @@ Alias for <a href="Context.html#M000039">explicit_domains</a>
|
|
284
291
|
</div>
|
285
292
|
</div>
|
286
293
|
|
287
|
-
<div id="method-
|
288
|
-
<a name="
|
294
|
+
<div id="method-M000045" class="method-detail">
|
295
|
+
<a name="M000045"></a>
|
289
296
|
|
290
297
|
<div class="method-heading">
|
291
|
-
<a href="#
|
298
|
+
<a href="#M000045" class="method-signature">
|
292
299
|
<span class="method-name">explicit_dimensions_domains</span><span class="method-args">()</span>
|
293
300
|
</a>
|
294
301
|
</div>
|
295
302
|
|
296
303
|
<div class="method-description">
|
297
304
|
<p><a class="source-toggle" href="#"
|
298
|
-
onclick="toggleCode('
|
299
|
-
<div class="method-source-code" id="
|
305
|
+
onclick="toggleCode('M000045-source');return false;">[Source]</a></p>
|
306
|
+
<div class="method-source-code" id="M000045-source">
|
300
307
|
<pre>
|
301
|
-
<span class="ruby-comment cmt"># File lib/xbrlware/context.rb, line
|
308
|
+
<span class="ruby-comment cmt"># File lib/xbrlware/context.rb, line 101</span>
|
302
309
|
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">explicit_dimensions_domains</span>
|
303
310
|
<span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@entity</span>.<span class="ruby-identifier">explicit_dimensions_domains</span>
|
304
311
|
<span class="ruby-keyword kw">end</span>
|
@@ -307,21 +314,21 @@ Alias for <a href="Context.html#M000039">explicit_domains</a>
|
|
307
314
|
</div>
|
308
315
|
</div>
|
309
316
|
|
310
|
-
<div id="method-
|
311
|
-
<a name="
|
317
|
+
<div id="method-M000043" class="method-detail">
|
318
|
+
<a name="M000043"></a>
|
312
319
|
|
313
320
|
<div class="method-heading">
|
314
|
-
<a href="#
|
321
|
+
<a href="#M000043" class="method-signature">
|
315
322
|
<span class="method-name">explicit_domains</span><span class="method-args">(dimensions=[])</span>
|
316
323
|
</a>
|
317
324
|
</div>
|
318
325
|
|
319
326
|
<div class="method-description">
|
320
327
|
<p><a class="source-toggle" href="#"
|
321
|
-
onclick="toggleCode('
|
322
|
-
<div class="method-source-code" id="
|
328
|
+
onclick="toggleCode('M000043-source');return false;">[Source]</a></p>
|
329
|
+
<div class="method-source-code" id="M000043-source">
|
323
330
|
<pre>
|
324
|
-
<span class="ruby-comment cmt"># File lib/xbrlware/context.rb, line
|
331
|
+
<span class="ruby-comment cmt"># File lib/xbrlware/context.rb, line 95</span>
|
325
332
|
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">explicit_domains</span>(<span class="ruby-identifier">dimensions</span>=[])
|
326
333
|
<span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@entity</span>.<span class="ruby-identifier">explicit_domains</span>(<span class="ruby-identifier">dimensions</span>)
|
327
334
|
<span class="ruby-keyword kw">end</span>
|
@@ -330,8 +337,8 @@ Alias for <a href="Context.html#M000039">explicit_domains</a>
|
|
330
337
|
</div>
|
331
338
|
</div>
|
332
339
|
|
333
|
-
<div id="method-
|
334
|
-
<a name="
|
340
|
+
<div id="method-M000040" class="method-detail">
|
341
|
+
<a name="M000040"></a>
|
335
342
|
|
336
343
|
<div class="method-heading">
|
337
344
|
<span class="method-name">has_dimensions?</span><span class="method-args">(dimensions=[])</span>
|
@@ -344,12 +351,36 @@ Alias for has_explicit_dimensions?
|
|
344
351
|
</div>
|
345
352
|
</div>
|
346
353
|
|
354
|
+
<div id="method-M000039" class="method-detail">
|
355
|
+
<a name="M000039"></a>
|
356
|
+
|
357
|
+
<div class="method-heading">
|
358
|
+
<a href="#M000039" class="method-signature">
|
359
|
+
<span class="method-name">has_explicit_dimensions?</span><span class="method-args">(dimensions=[])</span>
|
360
|
+
</a>
|
361
|
+
</div>
|
362
|
+
|
363
|
+
<div class="method-description">
|
364
|
+
<p><a class="source-toggle" href="#"
|
365
|
+
onclick="toggleCode('M000039-source');return false;">[Source]</a></p>
|
366
|
+
<div class="method-source-code" id="M000039-source">
|
367
|
+
<pre>
|
368
|
+
<span class="ruby-comment cmt"># File lib/xbrlware/context.rb, line 82</span>
|
369
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">has_explicit_dimensions?</span>(<span class="ruby-identifier">dimensions</span>=[])
|
370
|
+
<span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@entity</span>.<span class="ruby-identifier">has_explicit_dimensions?</span>(<span class="ruby-identifier">dimensions</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@entity</span>.<span class="ruby-identifier">nil?</span>
|
371
|
+
<span class="ruby-keyword kw">false</span>
|
372
|
+
<span class="ruby-keyword kw">end</span>
|
373
|
+
</pre>
|
374
|
+
</div>
|
375
|
+
</div>
|
376
|
+
</div>
|
377
|
+
|
347
378
|
<div id="method-M000035" class="method-detail">
|
348
379
|
<a name="M000035"></a>
|
349
380
|
|
350
381
|
<div class="method-heading">
|
351
382
|
<a href="#M000035" class="method-signature">
|
352
|
-
<span class="method-name">
|
383
|
+
<span class="method-name">has_scenario?</span><span class="method-args">()</span>
|
353
384
|
</a>
|
354
385
|
</div>
|
355
386
|
|
@@ -358,31 +389,30 @@ Alias for has_explicit_dimensions?
|
|
358
389
|
onclick="toggleCode('M000035-source');return false;">[Source]</a></p>
|
359
390
|
<div class="method-source-code" id="M000035-source">
|
360
391
|
<pre>
|
361
|
-
<span class="ruby-comment cmt"># File lib/xbrlware/context.rb, line
|
362
|
-
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">
|
363
|
-
|
364
|
-
<span class="ruby-keyword kw">false</span>
|
392
|
+
<span class="ruby-comment cmt"># File lib/xbrlware/context.rb, line 66</span>
|
393
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">has_scenario?</span>
|
394
|
+
(<span class="ruby-keyword kw">not</span> <span class="ruby-ivar">@scenario</span>.<span class="ruby-identifier">nil?</span>)
|
365
395
|
<span class="ruby-keyword kw">end</span>
|
366
396
|
</pre>
|
367
397
|
</div>
|
368
398
|
</div>
|
369
399
|
</div>
|
370
400
|
|
371
|
-
<div id="method-
|
372
|
-
<a name="
|
401
|
+
<div id="method-M000038" class="method-detail">
|
402
|
+
<a name="M000038"></a>
|
373
403
|
|
374
404
|
<div class="method-heading">
|
375
|
-
<a href="#
|
405
|
+
<a href="#M000038" class="method-signature">
|
376
406
|
<span class="method-name">hash</span><span class="method-args">()</span>
|
377
407
|
</a>
|
378
408
|
</div>
|
379
409
|
|
380
410
|
<div class="method-description">
|
381
411
|
<p><a class="source-toggle" href="#"
|
382
|
-
onclick="toggleCode('
|
383
|
-
<div class="method-source-code" id="
|
412
|
+
onclick="toggleCode('M000038-source');return false;">[Source]</a></p>
|
413
|
+
<div class="method-source-code" id="M000038-source">
|
384
414
|
<pre>
|
385
|
-
<span class="ruby-comment cmt"># File lib/xbrlware/context.rb, line
|
415
|
+
<span class="ruby-comment cmt"># File lib/xbrlware/context.rb, line 78</span>
|
386
416
|
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">hash</span>
|
387
417
|
<span class="ruby-ivar">@id</span>.<span class="ruby-identifier">hash</span>
|
388
418
|
<span class="ruby-keyword kw">end</span>
|
@@ -391,23 +421,23 @@ Alias for has_explicit_dimensions?
|
|
391
421
|
</div>
|
392
422
|
</div>
|
393
423
|
|
394
|
-
<div id="method-
|
395
|
-
<a name="
|
424
|
+
<div id="method-M000036" class="method-detail">
|
425
|
+
<a name="M000036"></a>
|
396
426
|
|
397
427
|
<div class="method-heading">
|
398
|
-
<a href="#
|
428
|
+
<a href="#M000036" class="method-signature">
|
399
429
|
<span class="method-name">to_s</span><span class="method-args">()</span>
|
400
430
|
</a>
|
401
431
|
</div>
|
402
432
|
|
403
433
|
<div class="method-description">
|
404
434
|
<p><a class="source-toggle" href="#"
|
405
|
-
onclick="toggleCode('
|
406
|
-
<div class="method-source-code" id="
|
435
|
+
onclick="toggleCode('M000036-source');return false;">[Source]</a></p>
|
436
|
+
<div class="method-source-code" id="M000036-source">
|
407
437
|
<pre>
|
408
|
-
<span class="ruby-comment cmt"># File lib/xbrlware/context.rb, line
|
438
|
+
<span class="ruby-comment cmt"># File lib/xbrlware/context.rb, line 70</span>
|
409
439
|
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_s</span>
|
410
|
-
<span class="ruby-value str">"Id ["</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">id</span> <span class="ruby-operator">+</span> <span class="ruby-value str">"], Entity { "</span> <span class="ruby-operator">+</span> <span class="ruby-ivar">@entity</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">+</span> <span class="ruby-value str">" }, period ["</span><span class="ruby-operator">+</span><span class="ruby-identifier">period</span>.<span class="ruby-identifier">to_s</span><span class="ruby-operator">+</span><span class="ruby-value str">"]"</span><span class="ruby-operator">+</span> (<span class="ruby-value str">", scenario ["</span><span class="ruby-operator">+</span><span class="ruby-identifier">scenario</span><span class="ruby-operator">+</span><span class="ruby-value str">"]"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">scenario</span>.<span class="ruby-identifier">nil?</span>).<span class="ruby-identifier">to_s</span>
|
440
|
+
<span class="ruby-value str">"Id ["</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">id</span> <span class="ruby-operator">+</span> <span class="ruby-value str">"], Entity { "</span> <span class="ruby-operator">+</span> <span class="ruby-ivar">@entity</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">+</span> <span class="ruby-value str">" }, period ["</span><span class="ruby-operator">+</span><span class="ruby-identifier">period</span>.<span class="ruby-identifier">to_s</span><span class="ruby-operator">+</span><span class="ruby-value str">"]"</span><span class="ruby-operator">+</span> (<span class="ruby-value str">", scenario ["</span><span class="ruby-operator">+</span><span class="ruby-identifier">scenario</span><span class="ruby-operator">+</span><span class="ruby-value str">"]"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">scenario</span>.<span class="ruby-identifier">nil?</span>).<span class="ruby-identifier">to_s</span>
|
411
441
|
<span class="ruby-keyword kw">end</span>
|
412
442
|
</pre>
|
413
443
|
</div>
|