Copyright ©2007 XBRL International Inc., All Rights Reserved.
Circulation of this Public Working Draft is unrestricted. This document is normative. Other documents may supersede this document. Recipients are invited to submit comments to the authors and contributors, and to submit notification of any relevant patent rights of which they are aware and to provide supporting documentation.
1 Introduction
1.1 Background
1.2 Relationship to other work
1.3 Language independence
1.4 Terminology
1.5 Document conventions (non-normative)
1.6 Namespaces and namespace prefixes
1.7 XPath usage
2 Syntax
2.1 Nil filter
2.2 Value filter
2.3 Precision filter
A Normative schema
B References
C Intellectual property status (non-normative)
D Acknowledgements (non-normative)
E Document history (non-normative)
F Errata corrections in this document
1 Namespaces and namespace prefixes
1 Value filters
2 Precision filters
This specification is an extension to [VARIABLES]. It defines XML syntax [XML] for filters that can condition on criteria relating to fact values when selecting facts from XBRL instances.
In relation to implicit filtering, as defined in the XBRL Variables Specification [VARIABLES], all filters defined in this specification cover the entity aspect of facts.
This specification is a member of a suite of similar specifications that define specific types of criteria that can be used to select facts from XBRL instances. It enhances the fact selection capabilities of the XBRL Variables Specification [VARIABLES].
This specification depends upon the XBRL Specification [XBRL 2.1], the XBRL Variables Specification [VARIABLES] and the XBRL Functions Specification [XBRL FUNCTIONS]. In the event of any conflicts between this specification and the specifications upon which it depends, this specification does not prevail.
The official language of XBRL International's own work products is English and the preferred spelling convention is UK English.
This specification is consistent with the definitions of any of the terms defined in specifications that it depends on.
Documentation conventions follow those set out in the XBRL Variables Specification [VARIABLES].
Namespace prefixes [XML NAMES] will be used
for elements and attributes in
the form ns:name
where ns
is the
namespace prefix and name
is the local name.
Throughout this specification, the mappings
from namespace prefixes to actual namespaces is consistent
with
Table 1.
The prefix column in Table 1 is non normative. The namespace URI column is normative.
Prefix | Namespace URI |
---|---|
vf
|
http://xbrl.org/2007/filter/value
|
vf
|
http://xbrl.org/2007/filter/value
|
xbrlvfe
|
http://xbrl.org/2007/filter/value/error
|
eg
|
http://example.com/
|
fn
|
http://www.w3.org/2006/xpath-functions
|
link
|
http://www.xbrl.org/2003/linkbase
|
xbrli
|
http://www.xbrl.org/2003/instance
|
xfi
|
http://www.xbrl.org/2005/function/instance
|
xbrldi
|
http://xbrl.org/2006/xbrldi
|
xbrldt
|
http://xbrl.org/2005/xbrldt
|
xl
|
http://www.xbrl.org/2003/XLink
|
xlink
|
http://www.w3.org/1999/xlink
|
xs
|
http://www.w3.org/2001/XMLSchema
|
xsi
|
http://www.w3.org/2001/XMLSchema-instance
|
generic
|
http://xbrl.org/2007/generic
|
variable
|
http://xbrl.org/2007/variable
|
iso4217
|
http://www.xbrl.org/2003/iso4217
|
This specification only provides a textual declaration of syntax constraints when those constraints are not expressed by the normative schema supplied with this specification.
Explanations of elements and attributes are only supplied when explanations are not already provided in other specifications.
Unless explicitly stated otherwise, a reference to a specific element MUST be read as a reference to that element or to any element in its substitution group .
A nil filter is declared by an <vf:nil>
element.
The syntax for the <vf:nil>
element is defined by
the normative schema supplied with
this specification.
The nil filter can be used to match facts that are reported as nil.
The XPath expression implied by a nil filter is:
xfi:nil(.)
A value filter is declared by an <vf:value>
element.
The syntax for the <vf:value>
element is defined by
the normative schema supplied with
this specification.
The value filter can be used to match facts based upon constraints on their values.
The XPath expression implied by a value filter is:
.[#test]
where #test
is the value of the @test
attribute
on the value filter.
#test | Implied constraint |
---|---|
. eq 0
|
The value must equal zero |
. gt 0
|
The value must be greater than zero |
. lt 0
|
The value must be less than or equal to zero |
. le 0 or ../@xsi:nil
|
The value must be less than or equal to zero or nil |
. eq 'hello world'
|
The value must be the string value "hello world". |
A precision filter is declared by an <vf:precision>
element.
The syntax for the <vf:precision>
element is defined by
the normative schema supplied with
this specification.
The precision filter can be used to match facts based on
their having a minimum actual or inferred precision, noting that
precision can be inferred from the value of the @decimal
attribute.
The XPath expression implied by a precision filter is:
xfi:precision(.) >= #minimum
where #minimum
is the value of the @minimum
attribute
on the precision filter.
Because the xfi:precision
function throws an
exception when applied to non-numeric facts, this filter will reject
all non-numeric facts. For this reason care should be taken when
using this filter to select facts with a precision that is not greater
than the specified minimum value.
#minimum | Implied constraint |
---|---|
0
|
The fact must be numeric and the inferred precision must be greater than zero |
4
|
The fact must be numeric and the inferred precision must be greater than 4 |
The following is the XML schema provided as part of this specification. This is normative. Non-normative versions (which should be identical to these except for appropriate comments indicating their non-normative status) are also provided as separate files for convenience of users of the specification.
NOTE: (non-normative) Following the schema maintenance policy of XBRL International, it is the intent (but is not guaranteed) that the location of non-normative versions of these schemas on the web will be as follows:
http://www.xbrl.org/2007/
- during the drafting process for
this specification this directory should contain a copy of the
most recent published version of the schema at
http://www.xbrl.org/2007/value-filter.xsd.
This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this paragraph are included on all such copies and derivative works. However, this document itself may not be modified in any way, such as by removing the copyright notice or references to XBRL International or XBRL organizations, except as required to translate it into languages other than English. Members of XBRL International agree to grant certain licenses under the XBRL International Intellectual Property Policy (www.xbrl.org/legal).
This document and the information contained herein is provided on an "AS IS" basis and XBRL INTERNATIONAL DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
The attention of users of this document is directed to the possibility that compliance with or adoption of XBRL International specifications may require use of an invention covered by patent rights. XBRL International shall not be responsible for identifying patents for which a license may be required by any XBRL International specification, or for conducting legal inquiries into the legal validity or scope of those patents that are brought to its attention. XBRL International specifications are prospective and advisory only. Prospective users are responsible for protecting themselves against liability for infringement of patents. XBRL International takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Members of XBRL International agree to grant certain licenses under the XBRL International Intellectual Property Policy (www.xbrl.org/legal).
This document could not have been written without the contributions of many people including the participants in the Formula Working Group.
Date | Author | Details |
---|---|---|
29 May 2007 | Geoff Shuetrim |
First internal working draft created. |
11 June 2007 | Geoff Shuetrim |
Fixed up the value filter implied XPath expression to make it consistent with the syntax of other implied XPath expressions and to eliminate the call to some xfi:value function. Changed spelling of nill to nil. |
24 July 2007 | Hugh Wallis |
Edited for public working draft publication. |
05 November 2007 | Geoff Shuetrim |
Converted the specification to XML format. Added in the definitions and the hyperlinks to the relevant sections of the normative schema. Added comments about simplifications that should be made. Eliminated the not nil filter because it will be redundant when we have the ability to use the not() operator with filters. Added the example for the value filter. Added the example for the precision filter. Added extra explanations in relation to the treatment of non-numeric facts for the precision filter. |
02 December 2007 | Geoff Shuetrim |
Changed the example comparison operators to value comparison operators on the advice of Herm Fischer. |
This appendix contains a list of the errata that have been incorporated into this document. This represents all those errata corrections that have been approved by the XBRL International Formula Working Group up to and including 31 December 2007. Hyperlinks to relevant e-mail threads may only be followed by those who have access to the relevant mailing lists. Access to internal XBRL mailing lists is restricted to members of XBRL International Inc.
No errata have been incorporated into this document.