core/results/results.py

   1 # Copyright 2015 Intel Corporation.
   2 #
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at
   6 #
   7 #   http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 # See the License for the specific language governing permissions and
  13 # limitations under the License.
  14 """IResult interface definition.
  15 """
  16
  17 class IResults(object):
  18     """Abstract class defining an interface for gathering results
  19     """
  20     def print_results(self):
  21         """Prints gathered results to screen.
  22         """
  23         raise NotImplementedError("This class does not implement the" \
  24                                   " \"print_results\" function.")
  25
  26     def get_results(self):
  27         """Returns gathered results as a list of dictionaries.
  28
  29         Each list element represents one record of data.
  30
  31         :return: Results dictionary
  32             - key: Column name
  33             - value: Column value.
  34         """
  35         raise NotImplementedError("This class does not implement the" \
  36                                   " \"get_results\" function.")