Source code for hyperstream.models.meta_data

# The MIT License (MIT)
# Copyright (c) 2014-2017 University of Bristol
# 
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
# 
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
# 
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
# DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
# OR OTHER DEALINGS IN THE SOFTWARE.

from mongoengine import Document, StringField


class MetaDataModel(Document):
    tag = StringField(required=False, min_length=1, max_length=512)
    data = StringField(required=False, min_length=1, max_length=512)
    parent = StringField(required=False, min_length=1, max_length=512)

    @property
    def identifier(self):
        if self.parent == "root":
            return "{}_{}".format(self.tag, self.data)
        else:
            return "{}.{}_{}".format(self.parent, self.tag, self.data)

    meta = {
        'collection': 'meta_data',
        'indexes': [{'fields': ['tag', 'data', 'parent'], 'unique': True}],
        'ordering': ['parent', 'tag', 'data']
    }

    def to_dict(self):
        d = self.to_mongo().to_dict()
        del d['_id']
        d['data'] = str(d['data'])
        d['identifier'] = self.identifier
        return d