offapi/com/sun/star/sheet/DataPilotSourceDimension.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: DataPilotSourceDimension.idl,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_sheet_DataPilotSourceDimension_idl__
  32 #define __com_sun_star_sheet_DataPilotSourceDimension_idl__
  33
  34 #ifndef __com_sun_star_container_XNamed_idl__
  35 #include <com/sun/star/container/XNamed.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_sheet_XHierarchiesSupplier_idl__
  39 #include <com/sun/star/sheet/XHierarchiesSupplier.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_util_XCloneable_idl__
  43 #include <com/sun/star/util/XCloneable.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_beans_XPropertySet_idl__
  47 #include <com/sun/star/beans/XPropertySet.idl>
  48 #endif
  49
  50 #ifndef __com_sun_star_sheet_DataPilotFieldOrientation_idl__
  51 #include <com/sun/star/sheet/DataPilotFieldOrientation.idl>
  52 #endif
  53
  54 #ifndef __com_sun_star_sheet_GeneralFunction_idl__
  55 #include <com/sun/star/sheet/GeneralFunction.idl>
  56 #endif
  57
  58 #ifndef __com_sun_star_sheet_TableFilterField_idl__
  59 #include <com/sun/star/sheet/TableFilterField.idl>
  60 #endif
  61
  62 //=============================================================================
  63
  64  module com {  module sun {  module star {  module sheet {
  65
  66 //=============================================================================
  67
  68 /** represents a dimension in a data pilot source.
  69
  70     <p>A dimension is equivalent to a column of a cell range in a spreadsheet
  71     used for a data pilot field.</p>
  72
  73     <p>In more complex data sources, a dimension may contain several
  74     hierarchies, which consolidate items of a complex data type, called
  75     levels.</p>
  76
  77     <p>Example: In a database, a column contains date values. This column
  78     will be a dimension of the data pilot source. One hierarchy may contain
  79     the 3 levels year, month, day. Another hierarchy may contain the 2 levels
  80     year and week number.</p>
  81
  82     @see com::sun::star::sheet::DataPilotSource
  83     @see com::sun::star::sheet::DataPilotTable
  84  */
  85 published service DataPilotSourceDimension
  86 {
  87     //-------------------------------------------------------------------------
  88
  89     /** provides access to the name of the dimension, i.e. used in
  90         collections.
  91      */
  92     interface com::sun::star::container::XNamed;
  93
  94     //-------------------------------------------------------------------------
  95
  96     /** provides access to the collection of hierarchies of this dimension.
  97      */
  98     interface com::sun::star::sheet::XHierarchiesSupplier;
  99
 100     //-------------------------------------------------------------------------
 101
 102     /** supports duplicating the dimension.
 103
 104         <p>A dimension may be used several times in a data pilot table,
 105         i.e. as row field and data field.</p>
 106      */
 107     interface com::sun::star::util::XCloneable;
 108
 109     //-------------------------------------------------------------------------
 110
 111 //!published service PropertySet
 112     /** provides access to the properties.
 113      */
 114     interface com::sun::star::beans::XPropertySet;
 115
 116     //=========================================================================
 117
 118     /** returns the name of the dimension from which this dimension was
 119         cloned, or <NULL/> if it was not cloned.
 120      */
 121     [readonly, property] com::sun::star::container::XNamed Original;
 122
 123     //-------------------------------------------------------------------------
 124
 125     /** contains <TRUE/> if this is the dimension used to layout the
 126         different data dimensions.
 127      */
 128     [readonly, property] boolean IsDataLayoutDimension;
 129
 130     //-------------------------------------------------------------------------
 131
 132     /** specifies where the dimension is used.
 133      */
 134     [property] com::sun::star::sheet::DataPilotFieldOrientation Orientation;
 135
 136     //-------------------------------------------------------------------------
 137
 138     /** specifies the position of the dimension within its orientation.
 139      */
 140     [property] long Position;
 141
 142     //-------------------------------------------------------------------------
 143
 144     /** specifies how data are aggregated.
 145      */
 146     [property] com::sun::star::sheet::GeneralFunction Function;
 147
 148     //-------------------------------------------------------------------------
 149
 150     /** specifies which hierarchy of the dimension is used.
 151
 152         @see com::sun::star::sheet::DataPilotSourceHierarchies
 153      */
 154     [property] long UsedHierarchy;
 155
 156     //-------------------------------------------------------------------------
 157
 158     /** specifies which values are used.
 159      */
 160     [property] sequence< com::sun::star::sheet::TableFilterField > Filter;
 161
 162 };
 163
 164 //=============================================================================
 165
 166 }; }; }; };
 167
 168 #endif
 169