Database structure

flask_app.database.PreDocRepr

Bases: DynamicEmbeddedDocument

Source code in flask_app/database.py

class PreDocRepr(DynamicEmbeddedDocument):
    _id = ObjectIdField()
    ranking_type = StringField(default="")

flask_app.database.DocRepr

Bases: DynamicDocument

Source code in flask_app/database.py

class DocRepr(DynamicDocument):
    meta = {
        'collection': 'documents'
    }
    _id = ObjectIdField()

flask_app.database.Ranking

Bases: DynamicEmbeddedDocument

Source code in flask_app/database.py

class Ranking(DynamicEmbeddedDocument):
    _id = ObjectIdField()
    docs = ListField()
    ranking_type = StringField(default="")

flask_app.database.QueryRepr

Bases: Document

Source code in flask_app/database.py

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

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

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

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

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

class Experiment(Document):
    meta = {
        'collection': 'experiments'
    }
    _id = ObjectIdField()
    _exp_id = StringField(required=True, db_field="_exp_id")
    _description = StringField(default="")
    tasks = ListField()

flask_app.database.Interaction

Bases: EmbeddedDocument

Source code in flask_app/database.py

class Interaction(EmbeddedDocument):
    doc_id = StringField(default="")
    shortlisted = StringField(default="")

    view = StringField(default="0")
    timestamps = ListField()

    view_factual = StringField(default="0")
    view_factual_timestamps = ListField()

    view_counterfactual = StringField(default="0")
    view_counterfactual_timestamps = ListField()

    view_image = StringField(default="0")
    view_image_timestamps = ListField()

    view_text = StringField(default="0")
    view_text_timestamps = ListField()

    view_image_text = StringField(default="0")
    view_image_text_timestamps = ListField()

flask_app.database.InteractionCompare

Bases: EmbeddedDocument

Source code in flask_app/database.py

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

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

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()
    form_submission = DictField()

flask_app.database.User

Bases: DynamicDocument

Source code in flask_app/database.py

class User(DynamicDocument):
    meta = {
        'collection': 'users'
    }
    _id = ObjectIdField()
    _user_id = StringField(required=True)
    _attention_check = StringField(default="")
    _reload_attention_check = StringField(default="")
    tasks_visited = EmbeddedDocumentListField(TaskVisited)
    exit_form = DictField()

flask_app.database.create_collections()

Source code in flask_app/database.py

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()