Copyright © 2017 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 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 1.0 Specification [VARIABLES]. It defines syntax for filters that condition upon features of XBRL concept declarations, including the name, the period-type, the balance, the data type and the substitution group.
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.5.1 Typographic conventions
1.5.1.1 Definition notation
1.5.1.2 Footnote notation
1.5.1.3 Element and attribute notation
1.5.1.4 Error code notation
1.5.2 Formatting conventions
1.6 Namespaces and namespace prefixes
1.7 XPath usage
2 Syntax
2.1 Concept name filter
2.2 Concept period-type filter
2.3 Concept balance filter
2.4 Concept custom-attribute filter
2.5 Concept data-type filter
2.6 Concept substitution-group filter
A Normative schema
A.1 concept-filter-1.1.xsd
B References
C Intellectual property status (non-normative)
D Acknowledgements (non-normative)
E Document history (non-normative)
1 Namespaces and namespace prefixes
1 A normative example
2 A non-normative example
3 An example of poor usage
4 Concept name filters
5 Concept period-type filters
6 Concept balance filters
7 Concept custom-attribute filters
8 Concept data-type filters
9 Concept substitution-group filters
concept balance filter
concept custom attribute
concept custom-attribute filter
concept data-type filter
concept name filter
concept period-type filter
concept substitution-group filter
Publication URL
This specification is an extension to the XBRL Variables 1.0 Specification [VARIABLES]. It defines XML syntax [XML] for filters that condition upon features of XBRL concept declarations, including:
All of the filters defined in this specification can cover the concept aspect.
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 input XBRL instance. 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.
Comments which are informative, but not essential to the understanding of the point at hand, are provided in footnotes. All footnotes are non-normative.
When referring to a specific element, it will be identified by
its namespace prefix and local name. For example, the root
element for a specification container element would be referred to as
<variable:generalVariable> .
Attributes are also identified by their local name and, where
appropriate, their namespace prefix. Attributes are
distinguished from elements by prefixing them by an
@
symbol. Thus,
@id
refers to the attribute with the name id.
When referring to any attribute, so long as it has a specific
namespace, the local name is replaced by an asterisk (
*).
Thus, the notation @xml:* specifies any attribute
in the namespace
http://www.w3.org/XML/1998/namespace.
The following highlighting is used for normative technical material in this document:
Text of the normative example.
The following highlighting is used for non-normative examples in this document:
Text of the helpful example.
Next paragraph of the helpful example.
Example 3 shows the formatting for non-normative examples of poor, discouraged or disallowed usage.
The example itself.
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 |
|---|---|
cf |
http://xbrl.org/PWD/2017-01-11/filter/concept-1.1 |
xbrlcfe |
http://xbrl.org/PWD/2017-01-11/filter/concept-1.1/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.
A concept name filter is declared by a <cf:conceptName>
element.
The syntax for the
<cf:conceptName> element
is defined by the normative schema supplied with this specification.
The concept name filter matches facts based upon the names of their concepts.
The XPath expression implied by a concept name filter contains
one term for each of its child <cf:concept> elements,
where those terms are combined using the XPath or operator.
Each term in the implied XPath expression has one of two forms.
If the <cf:concept> element contains a
<cf:qnameExpression> element, then the
term is:
(fn:node-name(.) = #qnameExpression)
where #qnameExpression is the XPath expression contained by the
cf:qnameExpression element.
If the <cf:concept> element contains a <cf:qname> element,
then the term is:
(fn:node-name(.) eq fn:QName(#namespace,#name))
where #namespace is the namespace for the
QName specified as the content of the
<cf:qname> element and #name is the local
name for the QName specified as the content of the
<cf:qname> element.
| Filter1 | Selection criteria |
|---|---|
|
<cf:conceptName>
<cf:concept> </cf:conceptName><cf:qname> </cf:concept>eg:assets </cf:qname> |
The concept name must be eg:assets |
|
<cf:conceptName>
<cf:concept> <cf:qname> </cf:concept>eg:assets </cf:qname><cf:concept> </cf:conceptName><cf:qnameExpression> </cf:concept>fn:QName('http://example.com/','eg:liabilities') </cf:qnameExpression> |
The concept name must be either eg:assets
or eg:liabilities
|
|
<cf:conceptName>
<cf:concept> </cf:conceptName><cf:qnameExpression> </cf:concept>fn:node-name($eg:a) </cf:qnameExpression> |
The concept name must be the same as the concept name
of the node accessed by the XPath variable reference
$a.
|
1. XLink attributes have been omitted.
A concept period-type filter is declared by a <cf:conceptPeriodType>
element.
The syntax for the
<cf:conceptPeriodType> element
is defined by the normative schema supplied with this specification.
The concept period-type filter can be used to match facts
based on whether they report values for duration-type or
instant-type concepts, as determined by the
@xbrli:periodType attribute.
The XPath expression implied by a concept period-type filter is:
xfi:concept-period-type(fn:node-name(.)) eq '#periodType'
where #periodType is the value of the @periodType attribute
on the concept period-type filter.
A concept balance filter is declared by a <cf:conceptBalance>
element.
The syntax for the <cf:conceptBalance>
element is defined by the normative schema supplied with this specification.
The concept period-type filter can be used to match facts based on
whether they have an
@xbrli:balance attribute
and, if they have that attribute, whether it has a value of
debit or credit.
The XPath expression implied by a concept balance filter is:
if ('#balance' eq 'none')
then (xfi:concept-balance(fn:node-name(.)) eq '')
else (xfi:concept-balance(fn:node-name(.)) eq '#balance')
where #balance is the value of the @balance attribute
on the concept balance filter.
| Filter1 | Selection criteria |
|---|---|
|
<cf:conceptBalance balance="credit"/>
|
The fact's concept must be classified as a credit balance concept |
|
<cf:conceptBalance balance="debit"/>
|
The fact's concept must be classified as a debit balance concept |
|
<cf:conceptBalance balance="none"/>
|
The fact's concept must not be classified as a credit or debit balance concept |
1. XLink attributes have been omitted.
A concept custom-attribute filter is declared by a <cf:conceptCustomAttribute>
element.
The syntax for the <cf:conceptCustomAttribute>
element is defined by the normative schema supplied with this specification.
The concept custom-attribute filter can be used to match facts based on the existence or value of a custom attribute in each concept's declaration. A concept custom attribute is an attribute on a concept declaration that is not in the XML Schema namespace [XML SCHEMA STRUCTURES] or in the XBRL namespace [XBRL 2.1].
If the @value attribute is provided and
if the <cf:attribute> element contains a
<cf:qnameExpression> element, then the implied XPath
expression is:
xfi:concept-custom-attribute(fn:node-name(.),#qnameExpression) eq #value
where #qnameExpression is the XPath expression contained by
the <cf:qnameExpression> element.
If the @value attribute is provided and
if the <cf:attribute> element contains a <cf:qname>
element, then the implied XPath expression is:
xfi:concept-custom-attribute(fn:node-name(.),fn:QName(#namespace,#name)) eq #value
where #namespace is the namespace for the QName specified as
the content of the <cf:qname> element and #name is the local
name for the QName specified as the content of the
<cf:qname> element.
The required value for the custom attribute is supplied by the
XPath expression in the @value attribute on the concept custom
attribute filter.
If the @value attribute is not provided and
if the <cf:attribute> element contains a
<cf:qnameExpression> element, then the implied XPath
expression is:
xfi:concept-custom-attribute(fn:node-name(.),#qnameExpression)
where #qnameExpression is the XPath expression contained by
the <cf:qnameExpression> element.
If the @value attribute is not provided and
if the <cf:attribute> element contains a <cf:qname>
element, then the implied XPath expression is:
xfi:concept-custom-attribute(fn:node-name(.),fn:QName(#namespace,#name))
where #namespace is the namespace for the QName specified as
the content of the <cf:qname> element and #name is the local
name for the QName specified as the content of the
<cf:qname> element.
| Filter1 | Selection criteria |
|---|---|
|
<cf:conceptCustomAttribute>
<cf:attribute> </cf:conceptCustomAttribute><cf:qname> </cf:attribute>eg:custom </cf:qname> |
The fact's concept must have an @eg:custom attribute on it. |
|
<cf:conceptCustomAttribute value="'confidential'">
<cf:attribute> </cf:conceptCustomAttribute><cf:qname> </cf:attribute>eg:custom </cf:qname> |
The fact's concept must have an @eg:custom attribute on it
with string content: confidential. Note that it is necessary
to enclose the value in its own quotes to indicate that it is a string.
|
|
<cf:conceptCustomAttribute value="fn:false()">
<cf:attribute> </cf:conceptCustomAttribute><cf:qnameExpression> </cf:attribute>fn:QName('http://example.com/','custom') </cf:qnameExpression> |
The fact's concept must have an @eg:custom attribute on it
with boolean content: false. |
1. XLink attributes have been omitted.
A concept data-type filter is declared by a <cf:conceptDataType>
element.
The syntax for the <cf:conceptDataType>
element is defined by the normative schema supplied with this specification.
The concept data-type filter can be used to match facts based upon its XML Schema data type (See [XML SCHEMA DATATYPES] and [XML SCHEMA STRUCTURES]).
If the <cf:type> element contains a
<cf:qnameExpression> element and
the @strict attribute on the <cf:conceptDataType> element
equals true, then the implied XPath expression is:
xfi:concept-data-type(fn:node-name(.)) eq #qnameExpression
where #qnameExpression is the XPath expression
contained by the <cf:qnameExpression> element.
If the <cf:type> element contains a
<cf:qnameExpression> element and
the @strict attribute on the <cf:conceptDataType> element
equals false, then the implied XPath expression is:
xfi:concept-data-type-derived-from(
fn:node-name(.),
#qnameExpression
)
where #qnameExpression is the XPath expression
contained by the <cf:qnameExpression> element.
If the <cf:type> element contains a <cf:qname>
element and the @strict attribute on the <cf:conceptDataType> element
equals true, then the implied XPath expression is:
xfi:concept-data-type(fn:node-name(.)) eq fn:QName(#namespace,#name))
where #namespace is the namespace for the QName specified as
the content of the <cf:qname> element and #name is the local
name for the QName specified as the content of the
<cf:qname> element.
If the <cf:type> element contains a <cf:qname>
element and the @strict attribute on the <cf:conceptDataType> element
equals false, then the implied XPath expression is:
xfi:concept-data-type-derived-from(
fn:node-name(.),
fn:QName(#namespace,#name)
)
where #namespace is the namespace for the QName specified as
the content of the <cf:qname> element and #name is the local
name for the QName specified as the content of the
<cf:qname> element.
| Filter1 | Selection criteria |
|---|---|
|
<cf:conceptDataType strict="true">
<cf:type> </cf:conceptDataType><cf:qname> </cf:type>xbrli:monetaryItemType </cf:qname> |
The data type of the fact's concept must be @xbrli:monetaryItemType. |
|
<cf:conceptDataType strict="false">
<cf:type> </cf:conceptDataType><cf:qname> </cf:type>xbrli:pureItemType </cf:qname> |
The data type of the fact's concept must be a restriction of @xbrli:pureItemType. |
|
<cf:conceptDataType strict="false">
<cf:type> </cf:conceptDataType><cf:qnameExpression> </cf:type>xfi:concept-data-type(fn:node-name($eg:otherVariable)) </cf:qnameExpression> |
Assuming that the custom function eg:concept-data-type returns the
QName of the XML Schema data type of the argument fact's concept then the
filter requires that a fact's concept has a data type that is a restriction of
the data type of the fact that the variable eg:otherVariable has
evaluated to.
|
1. XLink attributes have been omitted.
A concept substitution-group filter is declared by a <cf:conceptSubstitutionGroup>
element.
The syntax for the <cf:conceptSubstitutionGroup>
element is defined by the normative schema supplied with this specification.
The concept substitution-group filter can be used to match facts based on its XML Schema substitution group (See [XML SCHEMA STRUCTURES]).
If the <cf:substitutionGroup> element contains a
<cf:qnameExpression> element and
the @strict attribute on the <cf:conceptSubstitutionGroup> element
equals true, then the implied XPath expression is:
#qnameExpression eq (xfi:concept-substitutions(fn:node-name(.))[1])
where #qnameExpression is the XPath expression
contained by the <cf:qnameExpression> element.
If the <cf:substitutionGroup> element contains a
<cf:qnameExpression> element and
the @strict attribute on the <cf:conceptSubstitutionGroup> element
equals false, then the implied XPath expression is:
some $ancestor in xfi:concept-substitutions(node-name(.)) satisfies (#qnameExpression eq $ancestor)
where #qnameExpression is the XPath expression
contained by the <cf:qnameExpression> element.
If the <cf:substitutionGroup> element contains a <cf:qname>
element and the @strict attribute on the <cf:conceptSubstitutionGroup> element
equals true, then the implied XPath expression is:
fn:QName(#namespace,#name) eq (xfi:concept-substitutions(fn:node-name(.))[1])
where #namespace is the namespace for the QName specified as
the content of the <cf:qname> element and #name is the local
name for the QName specified as the content of the
<cf:qname> element.
If the <cf:substitutionGroup> element contains a <cf:qname>
element and the @strict attribute on the <cf:conceptSubstitutionGroup> element
equals false, then the implied XPath expression is:
some $ancestor in xfi:concept-substitutions(node-name(.)) satisfies (fn:QName(#namespace,#name) eq $ancestor)
where #namespace is the namespace for the QName specified as
the content of the <cf:qname> element and #name is the local
name for the QName specified as the content of the
<cf:qname> element.
| Filter1 | Selection criteria |
|---|---|
|
<cf:conceptSubstitutionGroup strict="true">
<cf:substitutionGroup> </cf:conceptSubstitutionGroup><cf:qname> </cf:substitutionGroup>xbrli:item </cf:qname> |
The fact's concept must specify the <xbrli:item> element in
its @substitutionGroup attribute. It is not
sufficient for the fact's concept to specify some element that is,
itself, in the substitution group for the <xbrli:item> element.
|
|
<cf:conceptSubstitutionGroup strict="false">
<cf:substitutionGroup> </cf:conceptSubstitutionGroup><cf:qname> </cf:substitutionGroup>xbrli:item </cf:qname> |
The fact's concept must be an XBRL item. |
|
<cf:conceptSubstitutionGroup strict="false">
<cf:substitutionGroup> </cf:conceptSubstitutionGroup><cf:qname> </cf:substitutionGroup>xbrli:tuple </cf:qname> |
The fact must be an XBRL tuple. |
|
<cf:conceptSubstitutionGroup strict="true">
<cf:substitutionGroup> </cf:conceptSubstitutionGroup><cf:qnameExpression> </cf:substitutionGroup>fn:QName('http://example.com/','eg:customItem') </cf:qnameExpression> |
The fact's concept must identify the <eg:customItem> in
its @substitutionGroup attribute.
|
1. XLink attributes have been omitted.
This section contains XML files that form part of this specification. Each document has a standard Publication URL, at which the normative copy of the document is published. A non-normative copy of each document is included in this appendix for convenience.
All references to these documents made for the purposes of DTS Discovery MUST resolve to the Publication URL, after applying XML Base processing (where applicable) and resolving any relative URLs.
It should be noted that the path component of a URL is case-sensitive, and so must match exactly. Further, alternative hosts and schemes that happen to resolve to the same location are not considered equivalent and may not be used. See [URI] for more details on URL equivalence.
The requirement to reference documents by Publication URL does not prevent processors from substituting local copies of the documents for performance or other reasons.
The Publication URL for this schema is http://www.xbrl.org/PWD/2017-01-11/concept-filter-1.1.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).