offapi/com/sun/star/report/Calculation.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: Calculation.idl,v $
  10  * $Revision: 1.3 $
  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 #ifndef __com_sun_star_report_Calculation_idl__
  31 #define __com_sun_star_report_Calculation_idl__
  32
  33
  34 //=============================================================================
  35
  36  module com {  module sun {  module star {  module report {
  37
  38 //=============================================================================
  39
  40 /** Specifies how to calculate a value.
  41     @see XFormattedField
  42  */
  43 constants Calculation
  44 {
  45     //-------------------------------------------------------------------------
  46
  47     /** returns the average of a field.
  48      */
  49     const short NONE = 0;
  50
  51     /** returns the average of a field.
  52      */
  53     const short AVERAGE = 1;
  54
  55     /** returns the correlation of two fields.
  56      */
  57     const short CORRELATION = 2;
  58
  59     /** counts the number of values, from the field.
  60     */
  61     const short COUNT = 3;
  62
  63     /** returns the measure of the linear relation between paired variables.
  64     */
  65     const short COVARIANCE = 4;
  66
  67     /** returns the number of none repeating values, from the field.
  68     */
  69     const short DISTINCTCOUNT = 5;
  70
  71     /** returns the largest value from the field.
  72     */
  73     const short MAXIMUM = 6;
  74
  75     /** returns the middle value in a sequence of numeric values.
  76     */
  77     const short MEDIAN = 7;
  78
  79     /** returns the smallest value from the field.
  80     */
  81     const short MINIMUM = 8;
  82
  83     /** returns the most frequently returning value from the field.
  84     */
  85     const short MODE = 9;
  86
  87     /** returns the Nth largest value from the field.
  88     */
  89     const short NTHLARGEST = 10;
  90
  91     /** returns the Nth most commonly occurring value from the field.
  92     */
  93     const short NTHMOSTFREQUENT = 11;
  94
  95     /** returns the Nth smallest value from the field.
  96     */
  97     const short NTHSMALLEST = 12;
  98
  99     /** returns as a percentage of the grand total summary.
 100     */
 101     const short PERCENTAGE = 13;
 102
 103     /** returns the value for a specified percentile in a Number or Currency field.
 104     */
 105     const short PERCENTILE = 14;
 106
 107     /** returns how much each value in the field deviate from the mean or average value for that field.
 108     */
 109     const short POPSTANDARDDEVIATION = 15;
 110
 111     /** returns the square of the standard deviation.
 112     */
 113     const short POPVARIANCE = 16;
 114
 115     /** returns the sample standard deviation for the field.
 116     */
 117     const short SAMPLESTANDARDDEVIATION = 17;
 118
 119     /** returns the sample variance for the field.
 120     */
 121     const short SAMPLEVARIANCE = 18;
 122
 123     /** returns the total of all the values for the field.
 124     */
 125     const short SUM = 19;
 126
 127     /** returns the weighted average for the field.
 128     */
 129     const short WEIGHTEDAVG = 20;
 130 };
 131
 132 //=============================================================================
 133
 134 }; }; }; };
 135
 136 /*=============================================================================
 137
 138 =============================================================================*/
 139 #endif