File: Statistics.java

package info (click to toggle)
ngs-sdk 1.3.0-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 8,236 kB
  • ctags: 4,917
  • sloc: cpp: 20,310; perl: 6,833; java: 5,054; python: 1,674; makefile: 674; xml: 233; sh: 70
file content (95 lines) | stat: -rw-r--r-- 3,025 bytes parent folder | download | duplicates (7)
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
/*===========================================================================
*
*                            PUBLIC DOMAIN NOTICE
*               National Center for Biotechnology Information
*
*  This software/database is a "United States Government Work" under the
*  terms of the United States Copyright Act.  It was written as part of
*  the author's official duties as a United States Government employee and
*  thus cannot be copyrighted.  This software/database is freely available
*  to the public for use. The National Library of Medicine and the U.S.
*  Government have not placed any restriction on its use or reproduction.
*
*  Although all reasonable efforts have been taken to ensure the accuracy
*  and reliability of the software and data, the NLM and the U.S.
*  Government do not and cannot warrant the performance or results that
*  may be obtained by using this software or data. The NLM and the U.S.
*  Government disclaim all warranties, express or implied, including
*  warranties of performance, merchantability or fitness for any particular
*  purpose.
*
*  Please cite the author in any work or product based on this material.
*
* ===========================================================================
*
*/

package ngs;


/**
 * Statistical data container
 */
public interface Statistics
{

    /**
     * ValueType
     */
    static int none = 0;
    static int string = 1;
    static int int64 = 2;
    static int uint64 = 3;
    static int real = 4;
    
    /**
     * getValueType
     * @param path is hierarchical path to value node
     * @return one of { none, string, int64, uint64, real }
     */
    int getValueType ( String path );
    
    /**
     * getAsString
     * @param path is hierarchical path to value node
     * @return textual representation of value
     * @throws ErrorMsg if path not found or value cannot be converted
     */
    String getAsString ( String path )
        throws ErrorMsg;

    /**
     * getAsI64
     * @param path is hierarchical path to value node
     * @return a signed 64-bit integer
     * @throws ErrorMsg if path not found or value cannot be converted
     */
    long getAsI64 ( String path )
        throws ErrorMsg;
            
    /**
     * getAsU64
     * @param path is hierarchical path to value node
     * @return a non-negative 64-bit integer
     * @throws ErrorMsg if path not found or value cannot be converted
     */
    long getAsU64 ( String path )
        throws ErrorMsg;
        
    /**
     * getAsDouble
     * @param path is hierarchical path to value node
     * @return a 64-bit floating point
     * @throws ErrorMsg if path not found or value cannot be converted
     */
    double getAsDouble ( String path )
        throws ErrorMsg;
            
    /**
     * nextPath
     * advance to next path in container
     * @param path is null or empty to request first path, or a valid path string
     * @return null if no more paths, or a valid path string
     */
    String nextPath ( String path );
}