Skip to content

Database structure

flask_app.database.PreDocRepr

Bases: DynamicEmbeddedDocument

Source code in flask_app/database.py 
39
40
41
class PreDocRepr(DynamicEmbeddedDocument):
    _id = ObjectIdField()
    ranking_type = StringField(default="")

flask_app.database.DocRepr

Bases: DynamicDocument

Source code in flask_app/database.py 
32
33
34
35
36
class DocRepr(DynamicDocument):
    meta = {
        'collection': 'documents'
    }
    _id = ObjectIdField()

flask_app.database.Ranking

Bases: DynamicEmbeddedDocument

Source code in flask_app/database.py 
44
45
46
47
class Ranking(DynamicEmbeddedDocument):
    _id = ObjectIdField()
    docs = ListField()
    ranking_type = StringField(default="")

flask_app.database.QueryRepr

Bases: Document

Source code in flask_app/database.py 
50
51
52
53
54
55
56
class QueryRepr(Document):
    meta = {
        'collection': 'queries'
    }
    _id = ObjectIdField()
    title = StringField(default="")
    text = StringField(default="")

flask_app.database.Data

Bases: Document

Source code in flask_app/database.py 
59
60
61
62
63
64
65
class Data(Document):
    meta = {
        'collection': 'dataset'
    }
    _id = ObjectIdField()
    query = StringField(default="")
    rankings = EmbeddedDocumentListField(Ranking)

flask_app.database.Task

Bases: DynamicDocument

Source code in flask_app/database.py 
68
69
70
71
72
73
74
75
class Task(DynamicDocument):
    meta = {
        'collection': 'tasks'
    }
    _id = ObjectIdField()
    data = StringField(default="")
    ranking_type = StringField(default="")
    setting = StringField(default="")

flask_app.database.TaskCompare

Bases: DynamicDocument

Source code in flask_app/database.py 
78
79
80
81
82
83
84
85
86
class TaskCompare(DynamicDocument):
    meta = {
        'collection': 'tasks_compare'
    }
    _id = ObjectIdField()
    data = StringField(default="")
    ranking_type_1 = StringField(default="")
    ranking_type_2 = StringField(default="")
    setting = StringField(default="")

flask_app.database.TaskScore

Bases: DynamicDocument

Source code in flask_app/database.py 
89
90
91
92
93
94
95
96
class TaskScore(DynamicDocument):
    meta = {
        'collection': 'tasks_score'
    }
    _id = ObjectIdField()
    data = StringField(default="")
    index = StringField(default="")
    setting = StringField(default="")

flask_app.database.Experiment

Bases: Document

Source code in flask_app/database.py 
 99
100
101
102
103
104
105
106
class Experiment(Document):
    meta = {
        'collection': 'experiments'
    }
    _id = ObjectIdField()
    _exp_id = StringField(required=True)
    _description = StringField(default="")
    tasks = ListField()

flask_app.database.Interaction

Bases: EmbeddedDocument

Source code in flask_app/database.py 
109
110
111
112
113
class Interaction(EmbeddedDocument):
    doc_id = StringField(default="")
    n_views = StringField(default="")
    timestamps = ListField()
    shortlisted = StringField(default="")

flask_app.database.InteractionCompare

Bases: EmbeddedDocument

Source code in flask_app/database.py 
116
117
118
119
class InteractionCompare(EmbeddedDocument):
    ranking_type_1 = StringField(default="")
    ranking_type_2 = StringField(default="")
    selected_ranking = StringField(default="")

flask_app.database.InteractionScore

Bases: EmbeddedDocument

Source code in flask_app/database.py 
122
123
124
125
class InteractionScore(EmbeddedDocument):
    doc = StringField(default="")
    query = StringField(default="")
    score = StringField(default="")

flask_app.database.TaskVisited

Bases: EmbeddedDocument

Source code in flask_app/database.py 
128
129
130
131
132
133
134
class TaskVisited(EmbeddedDocument):
    task = StringField(required=True)
    exp = StringField(required=True)
    interaction_compare = EmbeddedDocumentField(InteractionCompare, default=InteractionCompare())
    interaction_score = EmbeddedDocumentField(InteractionScore, default=InteractionScore())
    interactions = EmbeddedDocumentListField(Interaction)
    order_checkbox = ListField()

flask_app.database.User

Bases: DynamicDocument

Source code in flask_app/database.py 
137
138
139
140
141
142
143
144
class User(DynamicDocument):
    meta = {
        'collection': 'users'
    }
    _id = ObjectIdField()
    _user_id = StringField(required=True)
    _attention_check = StringField(default="")
    tasks_visited = EmbeddedDocumentListField(TaskVisited)

flask_app.database.create_collections()

Source code in flask_app/database.py 
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
def create_collections():
    db = get_db()

    if 'users' not in db.list_collection_names():
        dummy_document = User(_user_id="dummy--")
        dummy_document.save()
        User.objects().delete()
    if 'dataset' not in db.list_collection_names():
        dummy_document = Data()
        dummy_document.save()
        Data.objects().delete()
    if 'documents' not in db.list_collection_names():
        dummy_document = DocRepr()
        dummy_document.save()
        DocRepr.objects().delete()
    if 'queries' not in db.list_collection_names():
        dummy_document = QueryRepr()
        dummy_document.save()
        QueryRepr.objects().delete()
    if 'tasks_compare' not in db.list_collection_names():
        dummy_document = TaskCompare()
        dummy_document.save()
        TaskCompare.objects().delete()
    if 'tasks' not in db.list_collection_names():
        dummy_document = Task()
        dummy_document.save()
        Task.objects().delete()
    if 'tasks_score' not in db.list_collection_names():
        dummy_document = TaskScore()
        dummy_document.save()
        TaskScore.objects().delete()
    if 'experiment' not in db.list_collection_names():
        dummy_document = Experiment(_exp_id="dummy--")
        dummy_document.save()
        Experiment.objects().delete()