Skip to content

Schemas

Schema of a Lemma

If we look at LemmaData as a single JSON object, it looks like this:

lemma: {
    id: int 
    nama: str
    konsep: [
        {
            id: int
            keterangan: str
            tertib: *int
            golongan: {
                id: str
                nama: str
                keterangan: str
            }
            cakupan: [
                *{
                    cakupan: {
                        id: int
                        nama: str
                        keterangan: *str
                    }
                } ...
            ]
            kata_asing: [
                *{
                    kata_asing: {
                        id: int
                        nama: str
                        bahasa: str
                    }
                } ...
            ]
        } ...
    ]
}
where * at the beginning of the type represents optional values and [{} ...] represents a list of objects.

CakupanData

Bases: FromPeeweeDatabase

Object and JSONable representation of models.Cakupan

keys value type
id int
nama str
keterangan str (optional)
Source code in samudra/schemas.py 
85
86
87
88
89
90
91
92
93
94
95
96
97
class CakupanData(FromPeeweeDatabase):
    """Object and JSONable representation of [models.Cakupan][samudra.models.core.cakupan.Cakupan]

    | keys  | value type    |
    | :---: | :---:         |
    | id    | int |
    | nama  | str |
    | keterangan | str (optional) |
    """

    id: int
    nama: str
    keterangan: Optional[str]

FromPeeweeDatabase

Bases: BaseModel

The base class of all the schemas which enables the inheriting objects to be able to understand and validate peewee Models

Source code in samudra/schemas.py 
62
63
64
65
66
67
class FromPeeweeDatabase(BaseModel):
    """The base class of all the schemas which enables the inheriting objects to be able to understand and validate [peewee Models][samudra.models.base.BaseDataTable]"""

    class Config:
        orm_mode = True
        getter_dict = _PeeweeGetterDict

GolonganKataData

Bases: FromPeeweeDatabase

Object and JSONable representation of models.GolonganKata

keys value type
id str
nama str
keterangan str
Source code in samudra/schemas.py 
70
71
72
73
74
75
76
77
78
79
80
81
82
class GolonganKataData(FromPeeweeDatabase):
    """Object and JSONable representation of [models.GolonganKata][samudra.models.core.konsep.GolonganKata]

    | keys  | value type    |
    | :---: | :---:         |
    | id    | str |
    | nama  | str |
    | keterangan | str |
    """

    id: str
    nama: str
    keterangan: str

KataAsingData

Bases: FromPeeweeDatabase

Object and JSONable representation of models.KataAsing

keys value type
id int
nama str
bahasa str
Source code in samudra/schemas.py 
114
115
116
117
118
119
120
121
122
123
124
125
126
class KataAsingData(FromPeeweeDatabase):
    """Object and JSONable representation of [models.KataAsing][samudra.models.core.kata_asing.KataAsing]

    | keys  | value type    |
    | :---: | :---:         |
    | id    | int |
    | nama  | str |
    | bahasa | str |
    """

    id: int
    nama: str
    bahasa: str

KonsepData

Bases: FromPeeweeDatabase

Object and JSONable representation of models.Konsep.

Important

Because of the way the models have been set up, to get a single cakupan from konsep (Self) would be like so: 

first_cakupan: CakupanData = Self.cakupan[0].cakupan
It would seem like we are selecting cakupan twice but in fact we are first selecting a list of intermediate tables defined by models.BaseAttachmentDataTable. We then index into it (or iterate to get all) to reveal a data from models.Cakupan table. The same can be said to find kata_asing.

## Schema of a Lemma gives a clearer picture of the data structure.

keys value type
id int
keterangan str
tertib int (Optional)
golongan GolonganKataData
cakupan List[KonsepToCakupanConnector]
kata_asing List[KonsepToKataAsingConnector]
Source code in samudra/schemas.py 
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
class KonsepData(FromPeeweeDatabase):
    """Object and JSONable representation of [models.Konsep][samudra.models.core.konsep.Konsep].

    !!! important
        Because of the way the models have been set up, to get a single `cakupan` from `konsep` (Self) would be like so:
        ```python
        first_cakupan: CakupanData = Self.cakupan[0].cakupan
        ```
        It would seem like we are selecting `cakupan` twice but in fact we are first selecting a list of intermediate tables defined by [models.BaseAttachmentDataTable][samudra.models.base.BaseAttachmentDataTable].
        We then index into it (or iterate to get all) to reveal a data from [models.Cakupan][samudra.models.core.cakupan.Cakupan] table.
        The same can be said to find `kata_asing`.

        [## Schema of a Lemma][samudra.schemas--schema-of-a-lemma] gives a clearer picture of the data structure.

    | keys  | value type    |
    | :---: | :---:         |
    | id    | int |
    | keterangan  | str |
    | tertib | int (Optional) |
    | golongan  | [GolonganKataData][samudra.schemas.GolonganKataData] |
    | cakupan    | List[[KonsepToCakupanConnector][samudra.schemas.KonsepToCakupanConnector]] |
    | kata_asing    | List[[KonsepToKataAsingConnector][samudra.schemas.KonsepToKataAsingConnector]] |
    """

    id: int
    golongan: GolonganKataData
    keterangan: str
    tertib: Optional[int]
    cakupan: List[Optional[KonsepToCakupanConnector]]
    kata_asing: List[Optional[KataAsingData]]

KonsepToCakupanConnector

Bases: FromPeeweeDatabase

Object and JSONable representation of models.CakupanXKonsep with the exception that it is a one way connection.

Note

The connection has to be set up one way to avoid circular dependencies

keys value type
cakupan CakupanData
Source code in samudra/schemas.py 
100
101
102
103
104
105
106
107
108
109
110
111
class KonsepToCakupanConnector(FromPeeweeDatabase):
    """Object and JSONable representation of [models.CakupanXKonsep][samudra.models.core.cakupan.CakupanXKonsep] with the exception that it is a one way connection.

    !!! note
        The connection has to be set up one way to avoid circular dependencies

    | keys  | value type    |
    | :---: | :---:         |
    | cakupan    | [CakupanData][samudra.schemas.CakupanData] |
    """

    cakupan: CakupanData

KonsepToKataAsingConnector

Bases: FromPeeweeDatabase

Object and JSONable representation of models.KataAsingXKonsep with the exception that it is a one way connection.

Note

The connection has to be set up one way to avoid circular dependencies

keys value type
kata_asing KataAsingData
Source code in samudra/schemas.py 
129
130
131
132
133
134
135
136
137
138
139
140
class KonsepToKataAsingConnector(FromPeeweeDatabase):
    """Object and JSONable representation of [models.KataAsingXKonsep][samudra.models.core.kata_asing.KataAsingXKonsep] with the exception that it is a one way connection.

    !!! note
        The connection has to be set up one way to avoid circular dependencies

    | keys  | value type    |
    | :---: | :---:         |
    | kata_asing    | [KataAsingData][samudra.schemas.KataAsingData] |
    """

    kata_asing: KataAsingData

LemmaData

Bases: FromPeeweeDatabase

Object and JSONable representation of models.Lemma

keys value type
id int
nama str
konsep List[KonsepData]
Source code in samudra/schemas.py 
175
176
177
178
179
180
181
182
183
184
185
186
187
class LemmaData(FromPeeweeDatabase):
    """Object and JSONable representation of [models.Lemma][samudra.models.core.lemma.Lemma]

    | keys  | value type    |
    | :---: | :---:         |
    | id    | int |
    | nama  | str |
    | konsep    | List[[KonsepData][samudra.schemas.KonsepData]] |
    """

    id: int
    nama: str
    konsep: List[KonsepData]