Copyright © 2007, 2008, 2011, 2013, XBRL International Inc., All Rights Reserved.
Circulation of this Recommendation is unrestricted. This document is normative. Recipients are invited to submit comments to formula-feedback@xbrl.org, and to submit notification of any relevant patent rights of which they are aware and provide supporting documentation.
This specification is an extension to the XBRL Variables Specification [VARIABLES]. It defines syntax for filters that condition upon matching the value of an aspect of a fact to the same aspect of other facts.
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 Concept matching filter
2.2 Location matching filter
2.3 Unit matching filter
2.4 Entity-identifier matching filter
2.5 Period matching filter
2.6 Dimension matching filter
2.7 Complete-segment matching filter
2.8 Non-XDT-segment matching filter
2.9 Complete-scenario matching filter
2.10 Non-XDT-scenario matching 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 Implied XPath expressions for match filters
complete-scenario matching filter
complete-segment matching filter
concept matching filter
dimension matching filter
entity-identifier matching filter
location matching filter
matched fact
matched variable
non-XDT scenario matching filter
non-XDT segment matching filter
period matching filter
unit matching filter
This specification is an extension to the XBRL Variables Specification [VARIABLES]. It defines XML syntax [XML] for filters that condition upon matching the value of an aspect of a fact to the same aspect of other facts.
A matched fact is the fact with the aspect that is being matched against.
Matched facts are accessed via references to fact variables that have evaluated to them.
The matched variable is the variable that has evaluated to the matched fact.
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], and the XBRL Variables Specification [VARIABLES]. 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 |
|---|---|
mf |
http://xbrl.org/2008/filter/match |
xbrlmfe |
http://xbrl.org/2008/filter/match/error |
eg |
http://example.com/ |
fn |
http://www.w3.org/2005/xpath-functions |
link |
http://www.xbrl.org/2003/linkbase |
xbrli |
http://www.xbrl.org/2003/instance |
xfi |
http://www.xbrl.org/2008/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 |
gen |
http://xbrl.org/2008/generic |
variable |
http://xbrl.org/2008/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.
Each filter specifies a variable whose QName is provided by the @variable
attribute. This variable MAY be bound to a single fact or a sequence
of facts. If it is not, then the
filter matches no facts. (E.g., if the sequence is empty, contains any atomic values such as
a fallback value, or any non-fact nodes, it matches no facts.)
The XPath expressions implied by each kind of matching filter is
obtained by modifying the
aspect test for the
aspect that can be covered by the filter.
The necessary modifications involve
replacing the variable reference $a with a reference to the fact
being filtered and by replacing the variable reference $b with
a reference to the variable whose QName is provided by the @variable
attribute on the matching filter. Additional coding
is required to check the sequence of the referenced variable
for non-fact items and facts that have different values for the aspect covered by the filter.
Each filter may optionally specify the boolean attribute @matchAny to indicate the desired
matching behaviour for cases where the variable referenced by the @variable attribute binds
to a sequence that contains more than a single fact.
If the attribute @matchAny is not provided or has a value of 'false', then for the filtering
to succeed, the fact to be matched MUST match the appropriate aspect for ALL facts
bound to the variable defined by the variable.
The error code xbrlmfe:inconsistentMatchedVariableSequence MUST
be thrown if the sequence contains any two facts that have a different value for the
aspect covered by the filter.
If the attribute @matchAny has a value of 'true', then for the filtering to succeed, the
fact to be matched MUST match the appropriate aspect for one or more facts bound
to the variable defined by the variable.
In cases where the variable defined by the @variable attribute binds to a single fact,
or to a sequence that contains a single fact, the behaviour of the filter is identical regardless of
the implied or specified value of the @matchAny attribute.
A match filter that can cover the
concept aspect,
where the attribute @matchAny has the value 'false', or is not specified,
implies the XPath expression:
every $i in ($#variable) satisfies (namespace-uri(.) eq namespace-uri($i)) and (local-name(.) eq local-name($i))
A match filter that can cover the
concept aspect,
where the attribute @matchAny has the value 'true', implies the XPath expression:
some $i in ($#variable) satisfies (namespace-uri(.) eq namespace-uri($i)) and (local-name(.) eq local-name($i))
(in addition to code checking for non-fact items and mismatched facts in #variable)
A concept matching filter is declared by a <mf:matchConcept>
element.
The syntax for the
<mf:matchConcept>
element is defined by the normative schema supplied with this specification.
The concept matching filter can be used to select facts that report values for the same concept.
This filter can cover the concept aspect.
A location matching filter is declared by a <mf:matchLocation>
element.
The syntax for the
<mf:matchLocation>
element is defined by the normative schema supplied with this specification.
The location matching filter can be used to select facts that have the same parent element.
This filter can cover the location aspect.
A unit matching filter is declared by a <mf:matchUnit>
element.
The syntax for the
<mf:matchUnit>
element is defined by the normative schema supplied with this specification.
The unit matching filter can be used to select facts that have the same unit.
This filter can cover the unit aspect.
A entity-identifier matching filter is declared by a <mf:matchEntityIdentifier>
element.
The syntax for the
<mf:matchEntityIdentifier>
element is defined by the normative schema supplied with this specification.
The entity-identifier matching filter can be used to select facts with the same entity identifier.
This filter can cover the entity-identifier aspect.
A period matching filter is declared by a <mf:matchPeriod>
element.
The syntax for the
<mf:matchPeriod>
element is defined by the normative schema supplied with this specification.
The period matching filter can be used to select facts that have the same period.
This filter can cover the period aspect.
A dimension matching filter is declared by a <mf:matchDimension>
element.
The syntax for the
<mf:matchDimension>
element is defined by the normative schema supplied with this specification.
The dimension matching filter can be used to select facts that have the same value for a specified XBRL Dimension [DIMENSIONS].
This filter can cover a dimension aspect.
The QName of the dimension in the XPath expression implied by a
dimension matching filter is given by the
@dimension attribute on the dimension matching filter.
A complete-segment matching filter is declared by a <mf:matchSegment>
element.
The syntax for the
<mf:matchSegment>
element is defined by the normative schema supplied with this specification.
The complete-segment matching filter can be used to select facts that have the same segment, where the content of the segment is not interpreted based on the XBRL Dimensions Specification [DIMENSIONS].
This filter can cover the complete-segment aspect.
A non-XDT segment matching filter is declared by a <mf:matchNonXDTSegment>
element.
The syntax for the
<mf:matchNonXDTSegment>
element is defined by the normative schema supplied with this specification.
The non-XDT segment matching filter can be used to select facts that have the same segment, after excluding any XBRL Dimensions Specification [DIMENSIONS] content from the comparison.
This filter can cover the non-XDT segment aspect.
A complete-scenario matching filter is declared by a <mf:matchScenario>
element.
The syntax for the
<mf:matchScenario>
element is defined by the normative schema supplied with this specification.
The complete-scenario matching filter can be used to select facts that have the same scenario, where the content of the scenario is not interpreted based on the XBRL Dimensions Specification [DIMENSIONS].
This filter can cover the complete scenario aspect.
A non-XDT scenario matching filter is declared by a <mf:matchNonXDTScenario>
element.
The syntax for the
<mf:matchNonXDTScenario>
element is defined by the normative schema supplied with this specification.
The non-XDT scenario matching filter can be used to select facts that have the same scenario, after excluding any XBRL Dimensions Specification [DIMENSIONS] content from the comparison.
This filter can cover the non-XDT scenario aspect.
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/2008/ - 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/2013/match-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 |
|---|---|---|
| 07 November 2007 | Geoff Shuetrim |
First internal working draft created, drawing on the filters defined in the second public working draft to support implicit filtering. |
| 19 November 2007 | Geoff Shuetrim |
Added in the missing unit matching filter to support the specification of implicit filtering. |
| 26 November 2007 | Jim Richards |
Added reference for Dimensions Specification. Made some chnages to some definitions so that the concept being defined was at the beginning of the definition. Finally, fixed some minor grammatical errors. |
| 27 November 2007 | Geoff Shuetrim |
Changed the definitions of the implied XPath expressions to leverage the new aspect test definitions in the Variables Specification [VARIABLES]. |
| 31 January 2008 | Geoff Shuetrim |
Standardised the format of the hyperlinks to the normative schema. Made the match.model and dimension.match.model data types have mixed content as suggested by Masatomo Goto. |
| 01 February 2008 | Geoff Shuetrim |
Fixed the implied XPath expression for the match filter covering the concept aspect as suggested by Masatomo Goto. The arguments to the functions were not copied correctly from a previously defined match filter. |
| 13 March 2008 | Geoff Shuetrim |
Changed period to unit in the explanation of the unit matching filter as suggested by CompSci Resources. |
| 27 August 2008 | Geoff Shuetrim |
Collapsed the segment dimension and scenario dimension aspects into the one dimension aspect in line with changes to the dimensional aspect model. |
| 17 November 2008 | Geoff Shuetrim |
Made the |
| 06 October 2011 | Herm Fischer |
Clarified behavior when the @variable is bound to non-fact(s) or to facts that are not consistent in the value of the covered aspect. This change was suggested by David North. |
| 12 September 2013 | David Bell |
Addition of the |
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 10 March 2011. 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.