GenericsUtil/KBaseGenerics.spec at master · kbaseapps/GenericsUtil · GitHub

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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
module KBaseGenerics{

    typedef int boolean;
    typedef string data_type;
    typedef string oterm_ref;
    typedef string object_ref;

    /*
    scalar_type can be one of:
        object_ref
        oterm_ref
        int
        float
        boolean
        string

    @optional object_ref oterm_ref int_value float_value string_value boolean_value
    */
    typedef structure{
        data_type   scalar_type;

        object_ref  object_ref;
        oterm_ref   oterm_ref;
        int         int_value;
        float       float_value;
        boolean     boolean_value;
        string      string_value;
    } Value;

    /*
    @optional object_refs oterm_refs int_values float_values string_values boolean_values
    */
    typedef structure{
        data_type   scalar_type;

        list<object_ref>  object_refs;
        list<oterm_ref>   oterm_refs;
        list<int>         int_values;
        list<float>       float_values;
        list<boolean>     boolean_values;
        list<string>      string_values;
    } Values;

    /*
    @optional oterm_ref oterm_name
    */
    typedef structure{
        string term_name;
        oterm_ref oterm_ref;
        string oterm_name;
    } Term;

    /*
    @optional value_units
    */
    typedef structure{
        Term value_type;
        Term value_units;
        Value value;
    } TypedValue;


    /*
    @optional value_units value_context
    */
    typedef structure{
        Term value_type;
        Term value_units;
        list<TypedValue> value_context;
        Values values;
    } TypedValues;


    typedef structure{
        Term data_type;
        int size;
        list<TypedValues> typed_values;
    } DimensionContext;

    /*
    @optional array_context
    */
    typedef structure{
        string name;
        string description;
        Term data_type;
        list<TypedValue> array_context;

        int n_dimensions;
        list<DimensionContext> dim_context;
        TypedValues typed_values;
    } NDArray;

    /*
    @optional array_context
    */
    typedef structure{
        string name;
        string description;
        Term data_type;
        list<TypedValue> array_context;

        int n_dimensions;
        list<DimensionContext> dim_context;
        list<TypedValues> typed_values;
    } HNDArray;

    /*
    //-----------------
    // Types used for mapping
    //-----------------
    */

    typedef structure{
        string ontology_id;
        string oterm_id;
        string oterm_name;

        string value_scalar_type;
        string value_mapper;

        string value_validator_method;
        string value_validation_pattern;

        float rank_score;
    } OTerm;

    typedef structure{
        string term_name;
        list<OTerm> oterms;
    } M_Term;

    typedef structure{
        M_Term value_type;
        M_Term value_units;
        M_Term value;
    } M_TypedValue;

    typedef structure{
        M_Term value_type;
        M_Term value_units;
        list<TypedValue> value_context;
        list<M_Term> values;
    } M_TypedValues;

    typedef structure{
        M_Term data_type;
        int size;
        list<M_TypedValues> typed_values;
    } M_DimensionContext;

    typedef structure{
        string name;
        string description;
        M_Term data_type;
        list<M_TypedValue> array_context;


        int n_dimensions;
        list<M_DimensionContext> dim_context;
        M_TypedValues typed_values;
    } M_NDArray;

};