Modeling.Entity

Package Modeling :: Module Entity

[show private | hide private]

Module Modeling.Entity

... describe me please I feel alone...

$Id: Entity.py,v 1.24 2004/07/20 06:21:37 sbigaret Exp $

Classes
`Entity`	Describes an entity An entity defines a class and its corresponding persistence schema.

Function Summary
	`externalNameForInternalName(aName, separatorString, useAllCaps)` Turns an entity name into a valid name for database schema.
	`nameForExternalName(aName, separatorString, initialCaps)` Inverse function of externalNameForInternalName()
	`primaryKeyForGlobalID(aGlobalID)` Returns the primaryKey used when 'aGlobalID' was initialized, or None if 'aGlobalID' is not a KeyGlobalID.

Function Details

externalNameForInternalName(aName, separatorString='_', useAllCaps=1)

Turns an entity name into a valid name for database schema.

With the default parameters, 'address' becomes 'ADDRESS', 'firstName' becomes 'FIRST_NAME', and 'db2Id' becomes 'DB2_ID'

Default separatorString is '_'.

If 'useAllCaps' is set to 1, 'firstName' becomes 'first_name'

nameForExternalName(aName, separatorString='_', initialCaps=0)

Inverse function of externalNameForInternalName()

Example: 'FIRST_NAME' becomes 'firstName', 'DB2_ID' becomes 'db2Id' and 'ENTITY_NAME' becomes 'EntityName' when initialCaps is set to '1'.

primaryKeyForGlobalID(aGlobalID)

Returns the primaryKey used when 'aGlobalID' was initialized, or None if 'aGlobalID' is not a KeyGlobalID. The return value is a dictionary mapping the primary key's component(s) with its (their) respective value.

See also: KeyGlobalID.__init__(), KeyGlobalID.keyValues()

Generated by Epydoc 2.1 on Sat Mar 4 13:36:25 2006

http://epydoc.sf.net