Package omero :: Package util :: Module cleanse :: Class Cleanser
[hide private]
[frames] | no frames]

Class Cleanser

source code


Keeps file cleansing state and performs OMERO database reconciliation of files within an OMERO binary repository.

Instance Methods [hide private]
 
__init__(self, query_service, object_type)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
cleanse(self, root)
Begins a cleansing operation from a given OMERO binary repository root directory.
source code
 
query_or_defer(self, path)
Adds a given path to the list of deferred paths.
source code
 
do_cleanse(self)
Actually performs the reconciliation check against OMERO and removes relevant files.
source code
 
finalize(self)
Takes the final set of deferred paths and performs a reconciliation check against OMERO for them.
source code
 
__str__(self)
str(x)
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

Class Variables [hide private]
  QUERY_THRESHOLD = 25
  PYRAMID_FILE = "_pyramid"
  PYRAMID_LOCK = ".pyr_lock"
  PYRAMID_TEMP = ".tmp"
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, query_service, object_type)
(Constructor)

source code 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__
(inherited documentation)

cleanse(self, root)

source code 

Begins a cleansing operation from a given OMERO binary repository root directory. /OMERO/Files or /OMERO/Pixels for instance.

query_or_defer(self, path)

source code 

Adds a given path to the list of deferred paths. If the number of deferred paths has reached the QUERY_THRESHOLD (to reduce database hits) a reconciliation check will happen against OMERO.

finalize(self)

source code 

Takes the final set of deferred paths and performs a reconciliation check against OMERO for them. This method's purpose is basically to catch the final set of paths in the deferred path list and/or perform any cleanup.

__str__(self)
(Informal representation operator)

source code 

str(x)

Overrides: object.__str__
(inherited documentation)