annotate TEisotools-1.0/commons/core/checker/AbstractChecker.py @ 6:20ec0d14798e draft

Uploaded
author urgi-team
date Wed, 20 Jul 2016 05:00:24 -0400 (2016-07-20)
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
1 # Copyright INRA (Institut National de la Recherche Agronomique)
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
2 # http://www.inra.fr
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
3 # http://urgi.versailles.inra.fr
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
4 #
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
5 # This software is governed by the CeCILL license under French law and
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
6 # abiding by the rules of distribution of free software. You can use,
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
7 # modify and/ or redistribute the software under the terms of the CeCILL
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
8 # license as circulated by CEA, CNRS and INRIA at the following URL
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
9 # "http://www.cecill.info".
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
10 #
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
11 # As a counterpart to the access to the source code and rights to copy,
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
12 # modify and redistribute granted by the license, users are provided only
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
13 # with a limited warranty and the software's author, the holder of the
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
14 # economic rights, and the successive licensors have only limited
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
15 # liability.
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
16 #
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
17 # In this respect, the user's attention is drawn to the risks associated
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
18 # with loading, using, modifying and/or developing or reproducing the
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
19 # software by the user in light of its specific status of free software,
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
20 # that may mean that it is complicated to manipulate, and that also
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
21 # therefore means that it is reserved for developers and experienced
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
22 # professionals having in-depth computer knowledge. Users are therefore
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
23 # encouraged to load and test the software's suitability as regards their
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
24 # requirements in conditions enabling the security of their systems and/or
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
25 # data to be ensured and, more generally, to use and operate it in the
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
26 # same conditions as regards security.
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
27 #
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
28 # The fact that you are presently reading this means that you have had
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
29 # knowledge of the CeCILL license and that you accept its terms.
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
30
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
31
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
32 from commons.core.checker.IChecker import IChecker
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
33 from commons.core.LoggerFactory import LoggerFactory
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
34
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
35
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
36 ## Enable a Logger in your Checker.
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
37 #
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
38 # Subclasses of AbstractChecker have a already a logger enabled (referenced by self._log attribute). Subclasses also already implements IChecker.
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
39 # All you have to do is to call __init__() method in your own constructor.
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
40 class AbstractChecker( IChecker ):
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
41
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
42 ## Constructor
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
43 #
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
44 # @param logFileName name of log file where logger outputs
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
45 #
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
46 def __init__(self, logFileName):
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
47 self._log = LoggerFactory.createLogger(logFileName)
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
48
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
49
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
50 ## Set (change) default logger
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
51 #
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
52 # @param logger a new logger
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
53 #
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
54 def setLogger(self, logger):
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
55 self._log = logger
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
56
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
57
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
58 ## Return the logger instance
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
59 #
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
60 def getLogger(self):
20ec0d14798e Uploaded
urgi-team
parents:
diff changeset
61 return self._log