Home       Trees       Indices       Help   
GAVO DaCHS
Package gavo :: Package rscdef :: Module dddef :: Class DataDescriptor
[frames] | no frames]

Class DataDescriptor

source code

                   object --+            
                            |            
 base.structure.StructureBase --+        
                                |        
                   object --+   |        
                            |   |        
           base.common.Parser --+        
                                |        
base.structure.ParseableStructure --+    
                                    |    
             base.structure.Structure --+
                                        |
                       object --+       |
                                |       |
              base.meta.MetaMixin --+   |
                                    |   |
          base.meta.ComputedMetaMixin --+
                                        |
                           object --+   |
                                    |   |
                  common.IVOMetaMixin --+
                                        |
                           object --+   |
                                    |   |
        tabledef.PublishableDataMixin --+
                                        |
                                       DataDescriptor

A description of how to process data from a given set of sources.

Data descriptors bring together a grammar, a source specification and "makes", each giving a table and a rowmaker to feed the table from the grammar output.

They are the "executable" parts of a resource descriptor. Their ids are used as arguments to gavoimp for partial imports.

Nested Classes

Inherited from base.structure.StructureBase: __metaclass__

Instance Methods
 
__repr__(self)
repr(x)		 source code
 
validate(self) source code
 
onElementComplete(self) source code
 
iterSources(self, connection=None) source code
 
__iter__(self) source code
 
iterTableDefs(self)
iterates over the definitions of all the tables built by this DD.		 source code
 
getTableDefById(self, id) source code
 
getTableDefWithRole(self, role) source code
 
getPrimary(self)
returns the "primary" table definition in the data descriptor.		 source code
 
copyShallowly(self)
returns a shallow copy of self.		 source code
 
getURL(self, rendName, absolute=True) 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, completeElement, finishElement

Inherited from base.structure.ParseableStructure: __init__, 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 base.meta.ComputedMetaMixin: getMetaKeys

Inherited from base.meta.MetaMixin: addMeta, buildRepr, copyMetaFrom, delMeta, getAllMetaPairs, getMeta, getMetaParent, isEmpty, iterMeta, keys, makeOriginal, setMeta, setMetaParent, traverse

Inherited from tabledef.PublishableDataMixin: getPublicationsForSet

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

Class Methods

Inherited from base.structure.StructureBase: fromStructure

Class Variables
  name_ = 'data'
hash(x)
  resType = 'data'
hash(x)
  metaModel = 'title(1), creationDate(1), description(1),subject...
  attrSeq = [<gavo.base.meta.MetaAttribute object>, <gavo.base.c...
  managedAttrs = {'auto': <gavo.base.attrdef.BooleanAttribute ob...

Inherited from base.structure.Structure: __implemented__

Inherited from base.structure.StructureBase: completedCallbacks

Properties
  parent
  rd

Inherited from object: __class__

Method Details

__repr__(self)
(Representation operator)

source code 

repr(x)

Overrides: object.__repr__
(inherited documentation)

validate(self)

source code 
Overrides: base.structure.Structure.validate

onElementComplete(self)

source code 
Overrides: base.structure.Structure.onElementComplete

iterTableDefs(self)

source code 

iterates over the definitions of all the tables built by this DD.

This will not include system tables.

getPrimary(self)

source code 

returns the "primary" table definition in the data descriptor.

"primary" means the only table in a one-table dd, the table with the role "primary" if there are more. If no matching table is found, a StructureError is raised.

copyShallowly(self)

source code 

returns a shallow copy of self.

Sources are not copied.


Class Variable Details

metaModel

Value:
'title(1), creationDate(1), description(1),subject, referenceURL(1)'

attrSeq

Value:
[<gavo.base.meta.MetaAttribute object>,
 <gavo.base.complexattrs.StructAttribute object>,
 <gavo.base.complexattrs.MultiStructAttribute object>,
 <gavo.base.complexattrs.StructListAttribute object>,
 <gavo.base.complexattrs.StructListAttribute object>,
 <gavo.base.complexattrs.StructListAttribute object>,
 <gavo.rscdef.common.ColumnListAttribute object>,
 <gavo.base.complexattrs.PropertyAttribute object>,
...

managedAttrs

Value:
{'auto': <gavo.base.attrdef.BooleanAttribute object>,
 'binaryGrammar': <gavo.base.complexattrs.MultiStructAttribute object>\
,
 'cdfHeaderGrammar': <gavo.base.complexattrs.MultiStructAttribute obje\
ct>,
 'columnGrammar': <gavo.base.complexattrs.MultiStructAttribute object>\
,
 'contextGrammar': <gavo.base.complexattrs.MultiStructAttribute object\
...

Property Details

parent

Get Method:
_getParent(self)
Set Method:
_setParent(self, value)

rd

Get Method:
unreachable._getRD(self)

   Home       Trees       Indices       Help   
GAVO DaCHS
Generated by Epydoc 3.0.1 on Thu May 2 07:29:09 2019 http://epydoc.sourceforge.net