summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/report/Calculation.idl
blob: 228f7291c0868df00bae9079e13ffade20adea09 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_report_Calculation_idl__
#define __com_sun_star_report_Calculation_idl__


//=============================================================================

 module com {  module sun {  module star {  module report {

//=============================================================================

/** Specifies how to calculate a value.
    @see XFormattedField
 */
constants Calculation
{
    //-------------------------------------------------------------------------

    /** returns the average of a field.
     */
    const short NONE = 0;

    /** returns the average of a field.
     */
    const short AVERAGE = 1;

    /** returns the correlation of two fields.
     */
    const short CORRELATION = 2;

    /** counts the number of values, from the field.
    */
    const short COUNT = 3;

    /** returns the measure of the linear relation between paired variables.
    */
    const short COVARIANCE = 4;

    /** returns the number of none repeating values, from the field.
    */
    const short DISTINCTCOUNT = 5;

    /** returns the largest value from the field.
    */
    const short MAXIMUM = 6;

    /** returns the middle value in a sequence of numeric values.
    */
    const short MEDIAN = 7;

    /** returns the smallest value from the field.
    */
    const short MINIMUM = 8;

    /** returns the most frequently returning value from the field.
    */
    const short MODE = 9;

    /** returns the Nth largest value from the field.
    */
    const short NTHLARGEST = 10;

    /** returns the Nth most commonly occurring value from the field.
    */
    const short NTHMOSTFREQUENT = 11;

    /** returns the Nth smallest value from the field.
    */
    const short NTHSMALLEST = 12;

    /** returns as a percentage of the grand total summary.
    */
    const short PERCENTAGE = 13;

    /** returns the value for a specified percentile in a Number or Currency field.
    */
    const short PERCENTILE = 14;

    /** returns how much each value in the field deviate from the mean or average value for that field.
    */
    const short POPSTANDARDDEVIATION = 15;

    /** returns the square of the standard deviation.
    */
    const short POPVARIANCE = 16;

    /** returns the sample standard deviation for the field.
    */
    const short SAMPLESTANDARDDEVIATION = 17;

    /** returns the sample variance for the field.
    */
    const short SAMPLEVARIANCE = 18;

    /** returns the total of all the values for the field.
    */
    const short SUM = 19;

    /** returns the weighted average for the field.
    */
    const short WEIGHTEDAVG = 20;
};

//=============================================================================

}; }; }; };

/*=============================================================================

=============================================================================*/
#endif