interface.py

Go to the documentation of this file.

""" Conditions Database interface definition. """
from abc import ABCMeta, abstractmethod
from datetime import datetime
 
 
 
# Package metadata
__author__    = "Tom Vrancken"
__email__     = "dev@tomvrancken.nl"
__copyright__ = "TU/e ST2019"
__credits__   = ["Juan van der Heijden", "Georgios Azis"]
__version__   = "1.0"
__status__    = "Prototype"
 
 
_ABC = ABCMeta('ABC', (object,), {'__slots__': ()})  # Compatible with python 2 AND 3
 
 
class APIInterface(_ABC): # For Python 3 we could/should use 'metaclass=ABCMeta'
 
    
    @abstractmethod
    def list_detectors(self, parent_id=None):
        pass
 
    
    @abstractmethod
    def get_detector(self, detector_id):
        pass
 
    
    @abstractmethod
    def add_detector(self, name, parent_id=None):
        pass
 
    
    @abstractmethod
    def remove_detector(self, detector_id):
        pass
 
    
    @abstractmethod
    def add_condition(self, detector_id, name, tag, values, type=None,
                      collected_at=datetime.now(), valid_since=datetime.now(),
                      valid_until=datetime.max):
        pass
 
    
    @abstractmethod
    def get_conditions(self, detector_id):
        pass
 
    
    @abstractmethod
    def get_conditions_by_name(self, detector_id, name):
        pass
 
    
    @abstractmethod
    def get_conditions_by_tag(self, detector_id, tag):
        pass
 
    
    @abstractmethod
    def get_conditions_by_name_and_validity(self, detector_id, name, start_date, end_date=None):
        pass
 
    
    @abstractmethod
    def get_condition_by_name_and_tag(self, detector_id, name, tag):
        pass
 
    
    @abstractmethod
    def get_condition_by_name_and_collection_date(self, detector_id, name, collected_at):
        pass
 
    
    @abstractmethod
    def update_condition_by_name_and_tag(self, detector_id, name, tag,
                                         type=None, valid_since=None, valid_until=None):
        pass