Filter Axis 1.0

Public Working Draft 19 October 2011

This version:: <http://www.xbrl.org/Specification/filter-axis/PWD-2011-10-19/filter-axis-PWD-2011-10-19.html>
Editors:: Herm Fischer, Mark V Systems <fischer@markv.com>; Victor Morilla, Banco de España <victor.morilla@bde.es>
Contributors:: Geoff Shuetrim, Galexy Pty. <geoff@galexy.com>; Bartosz Ochocki, BRAG <bartosz.ochocki@br-ag.eu>; Masatomo Goto, Fujitsu Ltd. <mg@jp.fujitsu.com>; Roland Hommes, RHOCON <roland@rhocon.nl>; Hugh Wallis, Standard Dimensions <hugh@standarddimensions.com>

Status

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 rendering-feedback@xbrl.org, and to submit notification of any relevant patent rights of which they are aware and provide supporting documentation.

Abstract

This document specifies semantics and syntax constraints for filter axes. Filter axes provide an implementation of open axes, as defined in the table specification, based on the use of filters.

1 Introduction

This document specifies semantics and syntax constraints for filter axes. Filter axes provide an implementation of open axes, as defined in the table specification, based on the use of filters.

2 Definitions

The figure below provides a model of the filter axis.

Figure 1: Filter Axis Model

A filter axis is an implementation of open axes expressed in terms of variable filters. Those variable filters are associated to the axis through axis-filter relationships.

3 Coordinate ordering

I have some doubts in this part. We could define an optional order using an order attribute that represents an XPath expression in the context of the aspect value. In order to do this we should:

Check that a node for the aspect value is defined in formulae. If not, define it.
Consider adding an ascendant / descendent order attribute.
If we define an order, we should define collations!

4 Aspect Constraints

A fact corresponds to a coordinate of a filter axis if it satisfies every filter associated to the axis, for that subset of the facts that satisfy or correspond with any preceding axes of the same axis type, and that satisfy the z-axis and all other fixed coordinates for the cell being rendered.

The aspects covered by a filter axis are the aspects covered by its filters . (The concept of aspect-covering as noted in the variables specification applies to implicit filtering for binding facts to variables of a variable set, and in this specification applies to designating the aspects covered by an axis, for determination of axis aspect coverage conflicts.)

An axis filter cannot be associated to filters that do not cover an aspect.

Error code xbrltfae:axisFilterCoversNoAspects MUST be thrown if the processing software encounters a filter in a filter axis that covers no aspects.

5 Headers

Headers of the filter axis are represented by the set of XLink resources in a generic linkbase. They can be associated to generic labels or messages, and generic references. These labels, messages, and references SHOULD be used as labels and references of the headers by a rendering engine. Labels, messages, and references are used in the normal manner of such linkbases, ignoring the link role labels and references.

Usually a filter axis provides a dynamically determined set of columns for which a static label association does not make sense, but instead a message may be associated. Then a typed dimension could use the message’s formatting capabilities. The message context item is bound to one (or more) facts that meet the filter constraints. Thus the message could provide a desired label for a dimension qname value, a typed dimension contents, or period coordinate.

6 Syntax

A filter Axis is represented by a <xtable:filterAxis> element with one or more <variable:filter> resources related by axis filter arc relationships.

The <filterAxis> may have @value XPath expressions. The context item for each XPath expression is the fact bound to coordinates of each axis, or the selection Axis result when applicable (when bound to coordinates of a cell). XPath expressions may refer to parameters and selection Axes by name, when in effect. The filterAxis may also specify a @format transform, @scale, and @negate, which apply to the fact value to be displayed, after result of any @value expression if present.

Appendix A Intellectual property status (non-normative)

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).

Appendix B Acknowledgements (non-normative)

This document could not have been written without the contributions of many people.

Appendix C Document history (non-normative)

Date	Author	Details
01 October 2011	Herm Fischer	Initial draft
11 October 2011	Hugh Wallis	Prepare for DPWD

Appendix D Errata corrections in this document

This appendix contains a list of the errata corrections that have been incorporated into this document. This represents all those errata corrections that have been approved by the XBRL International Rendering Working Group up to and including 19 October 2011.

No errata have been incorporated into this document.