Package gavo :: Package svcs :: Module core :: Class Core
[frames] | no frames]

Class Core

source code

                   object --+            
                            |            
 base.structure.StructureBase --+        
                                |        
                   object --+   |        
                            |   |        
           base.common.Parser --+        
                                |        
base.structure.ParseableStructure --+    
                                    |    
             base.structure.Structure --+
                                        |
                                       Core
Known Subclasses:

A definition of the "active" part of a service.

A core will receive input from a renderer in the form of a ``svcs.CoreArgs`` (see `Core Args`_). A core will return a table or perhaps directly data as discussed in `DaCHS' Service Interface`_ .

The abstract core element will never occur in resource descriptors. See `Cores Available`_ for concrete cores. Use the names of the concrete cores in RDs.

Nested Classes

Inherited from base.structure.StructureBase: __metaclass__

Instance Methods
 
__init__(self, parent, **kwargs)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
__repr__(self)
repr(x)
source code
 
__str__(self)
str(x)
source code
 
completeElement(self, ctx) source code
 
initialize(self)
override to configure the custom core before use.
source code
 
adaptForRenderer(self, renderer)
returns a core object tailored for renderer.
source code
 
run(self, service, inputData, queryMeta) source code
 
makeUserDoc(self) source code
 
clearProperty(self, name) source code
 
getFullId(self) source code
 
getProperty(self, name, default=<Undefined>) source code
 
hasProperty(self, name) source code
 
setProperty(self, name, value) source code

Inherited from base.structure.Structure: __provides__, callCompletedCallbacks, finishElement, onElementComplete, validate

Inherited from base.structure.ParseableStructure: end_, feed, feedFrom, feedObject, getAttribute, iterEvents, start_, value_

Inherited from base.structure.StructureBase: __providedBy__, adopt, breakCircles, change, copy, getAttributes, getCopyableAttributes, getSourcePosition, iterChildren, setPosition

Inherited from base.common.Parser: feedEvent

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

Class Methods

Inherited from base.structure.StructureBase: fromStructure

Class Variables
  name_ = 'core'
a sentinel for all kinds of undefined values.
  inputTableXML = None
hash(x)
  outputTableXML = None
hash(x)
  attrSeq = [<gavo.base.parsecontext.IdAttribute object>, <gavo....
  managedAttrs = {'id': <gavo.base.parsecontext.IdAttribute obje...

Inherited from base.structure.Structure: __implemented__

Inherited from base.structure.StructureBase: completedCallbacks

Properties
  rd

Inherited from object: __class__

Method Details

__init__(self, parent, **kwargs)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

__repr__(self)
(Representation operator)

source code 

repr(x)

Overrides: object.__repr__
(inherited documentation)

__str__(self)
(Informal representation operator)

source code 

str(x)

Overrides: object.__str__
(inherited documentation)

completeElement(self, ctx)

source code 
Overrides: base.structure.Structure.completeElement

initialize(self)

source code 

override to configure the custom core before use.

This is typically where you pull input or output tables from the RD in customCores. Actual DaCHS code should use completeElement as usual.


Class Variable Details

attrSeq

Value:
[<gavo.base.parsecontext.IdAttribute object>,
 <gavo.base.complexattrs.StructAttribute object>,
 <gavo.base.parsecontext.OriginalAttribute object>,
 <gavo.base.complexattrs.StructAttribute object>,
 <gavo.base.complexattrs.PropertyAttribute object>,
 <gavo.rscdef.common.RDAttribute object>]

managedAttrs

Value:
{'id': <gavo.base.parsecontext.IdAttribute object>,
 'inputTable': <gavo.base.complexattrs.StructAttribute object>,
 'original': <gavo.base.parsecontext.OriginalAttribute object>,
 'outputTable': <gavo.base.complexattrs.StructAttribute object>,
 'properties': <gavo.base.complexattrs.PropertyAttribute object>,
 'property': <gavo.base.complexattrs.PropertyAttribute object>,
 'rd': <gavo.rscdef.common.RDAttribute object>}

Property Details

rd

Get Method:
unreachable._getRD(self)