Package gavo :: Package rscdef :: Module column :: Class ParamBase

Class ParamBase

                   object --+                
                            |                
 base.structure.StructureBase --+            
                                |            
                   object --+   |            
                            |   |            
           base.common.Parser --+            
                                |            
base.structure.ParseableStructure --+        
                                    |        
             base.structure.Structure --+    
                                        |    
                           object --+   |    
                                    |   |    
                  base.meta.MetaMixin --+    
                                        |    
                               ColumnBase --+
                                            |
                                           ParamBase

Known Subclasses:

A basic parameter.

This is the base for both Param and InputKey.

Nested Classes
Inherited from `base.structure.StructureBase`: `__metaclass__`, `name_`

Instance Methods

__repr__(self)
repr(x)

source code

expand(self, value)
hands up macro expansion requests to a parent, if there is one and it can handle expansions.

source code

completeElement(self, ctx)

source code

onElementComplete(self)

source code

getStringValue(self)
returns a string serialisation of the value.

source code

set(self, val)
sets this parameter's value.

source code

clearProperty(self, name)

source code

getProperty(self, name, default=<Undefined>)

source code

hasProperty(self, name)

source code

setProperty(self, name, value)

source code

Inherited from ColumnBase: asInfoDict, getDDL, getDisplayHintAsString, getLabel, isEnumerated, isIndexed, isPrimary, onParentComplete, setMetaParent, validate, validateValue

Inherited from base.structure.Structure: __provides__, callCompletedCallbacks, 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.MetaMixin: addMeta, buildRepr, copyMetaFrom, delMeta, getAllMetaPairs, getMeta, getMetaKeys, getMetaParent, isEmpty, iterMeta, keys, makeOriginal, setMeta, traverse

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
	nullLiteral = `''` hash(x)
	unprocessedTypes = `set(['file', 'raw'])`
	attrSeq = `[<gavo.base.meta.MetaAttribute object>, <gavo.rscdef...`
	managedAttrs = `{'content_': <gavo.base.structure.DataContent o...`
Inherited from `ColumnBase`: `restrictedMode` Inherited from `base.structure.Structure`: `__implemented__` Inherited from `base.structure.StructureBase`: `completedCallbacks`

Properties
	content_
	value returns a typed value for the parameter.
Inherited from `object`: `__class__`

Method Details

repr(self)
(Representation operator)

source code

repr(x)

Overrides: object.__repr__: (inherited documentation)

returns a string serialisation of the value.

This is what would reproduce the value if embedded in an XML serialisation of the param.

set(self, val)

source code

sets this parameter's value.

val can be a python value, or string literal. In the second case, this string literal will be preserved in string serializations of this param.

If val is an invalid value for this item, a ValidationError is raised and the item's value will be Undefined.

clearProperty(self, name)

source code

Overrides: ColumnBase.clearProperty

getProperty(self, name, default=<Undefined>)

source code

Overrides: ColumnBase.getProperty

hasProperty(self, name)

source code

Overrides: ColumnBase.hasProperty

setProperty(self, name, value)

source code

Overrides: ColumnBase.setProperty

Class Variable Details

attrSeq

Value:

[<gavo.base.meta.MetaAttribute object>,
 <gavo.rscdef.column.ParamNameAttribute object>,
 <gavo.rscdef.column.TypeNameAttribute object>,
 <gavo.base.attrdef.UnicodeAttribute object>,
 <gavo.base.attrdef.UnicodeAttribute object>,
 <gavo.base.attrdef.NWUnicodeAttribute object>,
 <gavo.rscdef.column.TableManagedAttribute object>,
 <gavo.base.parsecontext.IdAttribute object>,
...

managedAttrs

Value:

{'content_': <gavo.base.structure.DataContent object>,
 'description': <gavo.base.attrdef.NWUnicodeAttribute object>,
 'displayHint': <gavo.rscdef.column.DisplayHintAttribute object>,
 'dmRoles': <gavo.rscdef.column.DMRolesAttribute object>,
 'fixup': <gavo.base.attrdef.UnicodeAttribute object>,
 'id': <gavo.base.parsecontext.IdAttribute object>,
 'meta': <gavo.base.meta.MetaAttribute object>,
 'meta_': <gavo.base.meta.MetaAttribute object>,
...

Property Details

content_

Get Method:: __get_content(self)
Set Method:: __set_content(self, val)

value

returns a typed value for the parameter.

Unset items give None here.

Get Method:: unreachable.value(self) - returns a typed value for the parameter.

Class ParamBase

__repr__(self) (Representation operator)

completeElement(self, ctx)

onElementComplete(self)

getStringValue(self)

set(self, val)

clearProperty(self, name)

getProperty(self, name, default=<Undefined>)

hasProperty(self, name)

setProperty(self, name, value)

attrSeq

managedAttrs

content_

value

repr(self)
(Representation operator)