1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir#ifndef __com_sun_star_sheet_DataPilotSourceDimension_idl__ 25cdf0e10cSrcweir#define __com_sun_star_sheet_DataPilotSourceDimension_idl__ 26cdf0e10cSrcweir 27cdf0e10cSrcweir#ifndef __com_sun_star_container_XNamed_idl__ 28cdf0e10cSrcweir#include <com/sun/star/container/XNamed.idl> 29cdf0e10cSrcweir#endif 30cdf0e10cSrcweir 31cdf0e10cSrcweir#ifndef __com_sun_star_sheet_XHierarchiesSupplier_idl__ 32cdf0e10cSrcweir#include <com/sun/star/sheet/XHierarchiesSupplier.idl> 33cdf0e10cSrcweir#endif 34cdf0e10cSrcweir 35cdf0e10cSrcweir#ifndef __com_sun_star_util_XCloneable_idl__ 36cdf0e10cSrcweir#include <com/sun/star/util/XCloneable.idl> 37cdf0e10cSrcweir#endif 38cdf0e10cSrcweir 39cdf0e10cSrcweir#ifndef __com_sun_star_beans_XPropertySet_idl__ 40cdf0e10cSrcweir#include <com/sun/star/beans/XPropertySet.idl> 41cdf0e10cSrcweir#endif 42cdf0e10cSrcweir 43cdf0e10cSrcweir#ifndef __com_sun_star_sheet_DataPilotFieldOrientation_idl__ 44cdf0e10cSrcweir#include <com/sun/star/sheet/DataPilotFieldOrientation.idl> 45cdf0e10cSrcweir#endif 46cdf0e10cSrcweir 47cdf0e10cSrcweir#ifndef __com_sun_star_sheet_GeneralFunction_idl__ 48cdf0e10cSrcweir#include <com/sun/star/sheet/GeneralFunction.idl> 49cdf0e10cSrcweir#endif 50cdf0e10cSrcweir 51cdf0e10cSrcweir#ifndef __com_sun_star_sheet_TableFilterField_idl__ 52cdf0e10cSrcweir#include <com/sun/star/sheet/TableFilterField.idl> 53cdf0e10cSrcweir#endif 54cdf0e10cSrcweir 55cdf0e10cSrcweir//============================================================================= 56cdf0e10cSrcweir 57cdf0e10cSrcweir module com { module sun { module star { module sheet { 58cdf0e10cSrcweir 59cdf0e10cSrcweir//============================================================================= 60cdf0e10cSrcweir 61cdf0e10cSrcweir/** represents a dimension in a data pilot source. 62cdf0e10cSrcweir 63cdf0e10cSrcweir <p>A dimension is equivalent to a column of a cell range in a spreadsheet 64cdf0e10cSrcweir used for a data pilot field.</p> 65cdf0e10cSrcweir 66cdf0e10cSrcweir <p>In more complex data sources, a dimension may contain several 67cdf0e10cSrcweir hierarchies, which consolidate items of a complex data type, called 68cdf0e10cSrcweir levels.</p> 69cdf0e10cSrcweir 70cdf0e10cSrcweir <p>Example: In a database, a column contains date values. This column 71cdf0e10cSrcweir will be a dimension of the data pilot source. One hierarchy may contain 72cdf0e10cSrcweir the 3 levels year, month, day. Another hierarchy may contain the 2 levels 73cdf0e10cSrcweir year and week number.</p> 74cdf0e10cSrcweir 75cdf0e10cSrcweir @see com::sun::star::sheet::DataPilotSource 76cdf0e10cSrcweir @see com::sun::star::sheet::DataPilotTable 77cdf0e10cSrcweir */ 78cdf0e10cSrcweirpublished service DataPilotSourceDimension 79cdf0e10cSrcweir{ 80cdf0e10cSrcweir //------------------------------------------------------------------------- 81cdf0e10cSrcweir 82cdf0e10cSrcweir /** provides access to the name of the dimension, i.e. used in 83cdf0e10cSrcweir collections. 84cdf0e10cSrcweir */ 85cdf0e10cSrcweir interface com::sun::star::container::XNamed; 86cdf0e10cSrcweir 87cdf0e10cSrcweir //------------------------------------------------------------------------- 88cdf0e10cSrcweir 89cdf0e10cSrcweir /** provides access to the collection of hierarchies of this dimension. 90cdf0e10cSrcweir */ 91cdf0e10cSrcweir interface com::sun::star::sheet::XHierarchiesSupplier; 92cdf0e10cSrcweir 93cdf0e10cSrcweir //------------------------------------------------------------------------- 94cdf0e10cSrcweir 95cdf0e10cSrcweir /** supports duplicating the dimension. 96cdf0e10cSrcweir 97cdf0e10cSrcweir <p>A dimension may be used several times in a data pilot table, 98cdf0e10cSrcweir i.e. as row field and data field.</p> 99cdf0e10cSrcweir */ 100cdf0e10cSrcweir interface com::sun::star::util::XCloneable; 101cdf0e10cSrcweir 102cdf0e10cSrcweir //------------------------------------------------------------------------- 103cdf0e10cSrcweir 104cdf0e10cSrcweir//!published service PropertySet 105cdf0e10cSrcweir /** provides access to the properties. 106cdf0e10cSrcweir */ 107cdf0e10cSrcweir interface com::sun::star::beans::XPropertySet; 108cdf0e10cSrcweir 109cdf0e10cSrcweir //========================================================================= 110cdf0e10cSrcweir 111cdf0e10cSrcweir /** returns the name of the dimension from which this dimension was 112cdf0e10cSrcweir cloned, or <NULL/> if it was not cloned. 113cdf0e10cSrcweir */ 114cdf0e10cSrcweir [readonly, property] com::sun::star::container::XNamed Original; 115cdf0e10cSrcweir 116cdf0e10cSrcweir //------------------------------------------------------------------------- 117cdf0e10cSrcweir 118cdf0e10cSrcweir /** contains <TRUE/> if this is the dimension used to layout the 119cdf0e10cSrcweir different data dimensions. 120cdf0e10cSrcweir */ 121cdf0e10cSrcweir [readonly, property] boolean IsDataLayoutDimension; 122cdf0e10cSrcweir 123cdf0e10cSrcweir //------------------------------------------------------------------------- 124cdf0e10cSrcweir 125cdf0e10cSrcweir /** specifies where the dimension is used. 126cdf0e10cSrcweir */ 127cdf0e10cSrcweir [property] com::sun::star::sheet::DataPilotFieldOrientation Orientation; 128cdf0e10cSrcweir 129cdf0e10cSrcweir //------------------------------------------------------------------------- 130cdf0e10cSrcweir 131cdf0e10cSrcweir /** specifies the position of the dimension within its orientation. 132cdf0e10cSrcweir */ 133cdf0e10cSrcweir [property] long Position; 134cdf0e10cSrcweir 135cdf0e10cSrcweir //------------------------------------------------------------------------- 136cdf0e10cSrcweir 137cdf0e10cSrcweir /** specifies how data are aggregated. 138cdf0e10cSrcweir */ 139cdf0e10cSrcweir [property] com::sun::star::sheet::GeneralFunction Function; 140cdf0e10cSrcweir 141cdf0e10cSrcweir //------------------------------------------------------------------------- 142cdf0e10cSrcweir 143cdf0e10cSrcweir /** specifies which hierarchy of the dimension is used. 144cdf0e10cSrcweir 145cdf0e10cSrcweir @see com::sun::star::sheet::DataPilotSourceHierarchies 146cdf0e10cSrcweir */ 147cdf0e10cSrcweir [property] long UsedHierarchy; 148cdf0e10cSrcweir 149cdf0e10cSrcweir //------------------------------------------------------------------------- 150cdf0e10cSrcweir 151cdf0e10cSrcweir /** specifies which values are used. 152cdf0e10cSrcweir */ 153cdf0e10cSrcweir [property] sequence< com::sun::star::sheet::TableFilterField > Filter; 154cdf0e10cSrcweir 155cdf0e10cSrcweir //------------------------------------------------------------------------- 156cdf0e10cSrcweir 157cdf0e10cSrcweir /** contains flags that control the usage of the dimension. 158cdf0e10cSrcweir 159cdf0e10cSrcweir @see com::sun::star::sheet::DimensionFlags 160cdf0e10cSrcweir */ 161cdf0e10cSrcweir [readonly, property, optional] long Flags; 162cdf0e10cSrcweir 163cdf0e10cSrcweir}; 164cdf0e10cSrcweir 165cdf0e10cSrcweir//============================================================================= 166cdf0e10cSrcweir 167cdf0e10cSrcweir}; }; }; }; 168cdf0e10cSrcweir 169cdf0e10cSrcweir#endif 170cdf0e10cSrcweir 171