conffwk.schema.Cache Class Reference

Inheritance diagram for conffwk.schema.Cache:

Collaboration diagram for conffwk.schema.Cache:

Public Member Functions
	__init__ (self, conffwk, all=True)
	update (self, conffwk)
	update_dal (self, conffwk)
	__getitem__ (self, key)
	__str__ (self)

Public Attributes
dict	data = {}
	all = all

Detailed Description

Defines a cache for all known schemas at a certain time.

Definition at line 327 of file schema.py.

Constructor & Destructor Documentation

__init__()

conffwk.schema.Cache.__init__	(		self,
			conffwk,
			all = True )

Initializes the cache with information from the Configuration
object.

This method will browse for all declared classes in the Configuration
object given as input and will setup the schema for all known classes.
After this you can still update the cache using the update() method.

Keyword parameters:

conffwk -- The conffwk.Configuration object to use as base for the
current cache.

all -- A boolean indicating if I should store all the attributes and
relations from a certain class or just the ones directly associated
with a class.

Definition at line 331 of file schema.py.

    def __init__(self, conffwk, all=True):
        """Initializes the cache with information from the Configuration
        object.
 
        This method will browse for all declared classes in the Configuration
        object given as input and will setup the schema for all known classes.
        After this you can still update the cache using the update() method.
 
        Keyword parameters:
 
        conffwk -- The conffwk.Configuration object to use as base for the
        current cache.
 
        all -- A boolean indicating if I should store all the attributes and
        relations from a certain class or just the ones directly associated
        with a class.
        """
        self.data = {}
        self.all = all
        self.update(conffwk)
 

Member Function Documentation

__getitem__()

conffwk.schema.Cache.__getitem__	(		self,
			key )

Gets the description of a certain class.

Definition at line 385 of file schema.py.

    def __getitem__(self, key):
        """Gets the description of a certain class."""
        return self.data[key]
 

__str__()

conffwk.schema.Cache.__str__

(

self

)

Prints a nice display of myself

Definition at line 389 of file schema.py.

    def __str__(self):
        """Prints a nice display of myself"""
        return '%s: %d classes loaded' % \
            (self.__class__.__name__, len(self.data)) + '\n' + \
            str(list(self.data.keys()))

update()

conffwk.schema.Cache.update	(		self,
			conffwk )

Updates this cache with information from the Configuration object.

This method will add new classes not yet know to this cache. Classes
with existing names will not be added. No warning is generated (this
should be done by the OKS layer in any case.

Definition at line 352 of file schema.py.

    def update(self, conffwk):
        """Updates this cache with information from the Configuration object.
 
        This method will add new classes not yet know to this cache. Classes
        with existing names will not be added. No warning is generated (this
        should be done by the OKS layer in any case.
        """
        for k in conffwk.classes():
            if k in list(self.data.keys()):
                continue
            self.data[k] = {}
            self.data[k]['attribute'] = conffwk.attributes(k, self.all)
            self.data[k]['relation'] = conffwk.relations(k, self.all)
            self.data[k]['superclass'] = conffwk.superclasses(k, self.all)
            self.data[k]['subclass'] = conffwk.subclasses(k, self.all)
            map_coercion(k, self.data[k])
 

update_dal()

conffwk.schema.Cache.update_dal	(		self,
			conffwk )

Updates this cache with information for DAL.

This method will add new DAL classes not yet know to this cache.
Classes with existing DAL representations will not be touched.

Definition at line 369 of file schema.py.

    def update_dal(self, conffwk):
        """Updates this cache with information for DAL.
 
        This method will add new DAL classes not yet know to this cache.
        Classes with existing DAL representations will not be touched.
        """
        from .dal import generate
 
        # generate
        klasses = generate(conffwk, [self.data[k]['dal'] for k
                                    in list(self.data.keys())
                                    if 'dal' in self.data[k]])
        # associate
        for k in klasses:
            self.data[k.pyclassName()]['dal'] = k
 

Member Data Documentation

all

conffwk.schema.Cache.all = all

Definition at line 349 of file schema.py.

data

conffwk.schema.Cache.data = {}

Definition at line 348 of file schema.py.

---

The documentation for this class was generated from the following file:

• /github/workspace/dunedaq/sourcecode/conffwk/python/conffwk/schema.py