1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_report_Calculation_idl__
28#define __com_sun_star_report_Calculation_idl__
29
30
31//=============================================================================
32
33 module com {  module sun {  module star {  module report {
34
35//=============================================================================
36
37/** Specifies how to calculate a value.
38    @see XFormattedField
39 */
40published constants Calculation
41{
42    //-------------------------------------------------------------------------
43
44    /** returns the average of a field.
45     */
46    const short NONE = 0;
47
48    /** returns the average of a field.
49     */
50    const short AVERAGE = 1;
51
52    /** returns the correlation of two fields.
53     */
54    const short CORRELATION = 2;
55
56    /** counts the number of values, from the field.
57    */
58    const short COUNT = 3;
59
60    /** returns the measure of the linear relation between paired variables.
61    */
62    const short COVARIANCE = 4;
63
64    /** returns the number of none repeating values, from the field.
65    */
66    const short DISTINCTCOUNT = 5;
67
68    /** returns the largest value from the field.
69    */
70    const short MAXIMUM = 6;
71
72    /** returns the middle value in a sequence of numeric values.
73    */
74    const short MEDIAN = 7;
75
76    /** returns the smallest value from the field.
77    */
78    const short MINIMUM = 8;
79
80    /** returns the most frequently returning value from the field.
81    */
82    const short MODE = 9;
83
84    /** returns the Nth largest value from the field.
85    */
86    const short NTHLARGEST = 10;
87
88    /** returns the Nth most commonly occurring value from the field.
89    */
90    const short NTHMOSTFREQUENT = 11;
91
92    /** returns the Nth smallest value from the field.
93    */
94    const short NTHSMALLEST = 12;
95
96    /** returns as a percentage of the grand total summary.
97    */
98    const short PERCENTAGE = 13;
99
100    /** returns the value for a specified percentile in a Number or Currency field.
101    */
102    const short PERCENTILE = 14;
103
104    /** returns how much each value in the field deviate from the mean or average value for that field.
105    */
106    const short POPSTANDARDDEVIATION = 15;
107
108    /** returns the square of the standard deviation.
109    */
110    const short POPVARIANCE = 16;
111
112    /** returns the sample standard deviation for the field.
113    */
114    const short SAMPLESTANDARDDEVIATION = 17;
115
116    /** returns the sample variance for the field.
117    */
118    const short SAMPLEVARIANCE = 18;
119
120    /** returns the total of all the values for the field.
121    */
122    const short SUM = 19;
123
124    /** returns the weighted average for the field.
125    */
126    const short WEIGHTEDAVG = 20;
127};
128
129//=============================================================================
130
131}; }; }; };
132
133/*=============================================================================
134
135=============================================================================*/
136#endif
137