#!/usr/bin/python
# -*- coding: utf-8 -*-
"""Keywords linked to citations."""
from peewee import CharField
from ..rest.orm import CherryPyAPI
from .utils import unicode_type
[docs]class Keywords(CherryPyAPI):
"""
Keywords Model.
Attributes:
+-------------------+-------------------------------------+
| Name | Description |
+===================+=====================================+
| citation | Link to the Citation model |
+-------------------+-------------------------------------+
| keyword | keyword in the citation |
+-------------------+-------------------------------------+
| encoding | encoding of the keyword |
+-------------------+-------------------------------------+
"""
keyword = CharField(default='')
encoding = CharField(default='UTF8')
[docs] def to_hash(self, **flags):
"""Convert the object to a hash."""
obj = super(Keywords, self).to_hash(**flags)
obj['_id'] = int(self.id) if self.id is not None else obj['_id']
obj['keyword'] = unicode_type(self.keyword)
obj['encoding'] = str(self.encoding)
return obj
[docs] def from_hash(self, obj):
"""Convert the hash to the object."""
super(Keywords, self).from_hash(obj)
self._set_only_if('_id', obj, 'id', lambda: int(obj['_id']))
self._set_only_if('keyword', obj, 'keyword',
lambda: unicode_type(obj['keyword']))
self._set_only_if('encoding', obj, 'encoding',
lambda: str(obj['encoding']))
[docs] @classmethod
def where_clause(cls, kwargs):
"""Where clause for the various elements."""
where_clause = super(Keywords, cls).where_clause(kwargs)
return cls._where_attr_clause(where_clause, kwargs, ['keyword', 'encoding'])