DatabaseObject.py :  » Database » Modeling-Framework » Modeling-0.9 » Modeling » interfaces » Python Open Source

Home
Python Open Source
1.3.1.2 Python
2.Ajax
3.Aspect Oriented
4.Blog
5.Build
6.Business Application
7.Chart Report
8.Content Management Systems
9.Cryptographic
10.Database
11.Development
12.Editor
13.Email
14.ERP
15.Game 2D 3D
16.GIS
17.GUI
18.IDE
19.Installer
20.IRC
21.Issue Tracker
22.Language Interface
23.Log
24.Math
25.Media Sound Audio
26.Mobile
27.Network
28.Parser
29.PDF
30.Project Management
31.RSS
32.Search
33.Security
34.Template Engines
35.Test
36.UML
37.USB Serial
38.Web Frameworks
39.Web Server
40.Web Services
41.Web Unit
42.Wiki
43.Windows
44.XML
Python Open Source » Database » Modeling Framework 
Modeling Framework » Modeling 0.9 » Modeling » interfaces » DatabaseObject.py
# -*- coding: iso-8859-1 -*-
#-----------------------------------------------------------------------------
# Modeling Framework: an Object-Relational Bridge for python
#
# Copyright (c) 2001-2004 Sbastien Bigaret <sbigaret@users.sourceforge.net>
# All rights reserved.
#
# This file is part of the Modeling Framework.
#
# This code is distributed under a "3-clause BSD"-style license;
# see the LICENSE file for details.
#-----------------------------------------------------------------------------


"""
DatabaseObject interface

  CVS information

    $Id: DatabaseObject.py 932 2004-07-20 06:21:57Z sbigaret $
  
"""

__version__='$Revision: 932 $'[11:-2]

try:
  from Interface import Base
except:
  class Base:
    pass

from Modeling.interfaces.Validation import ValidationInterface
from Modeling.interfaces.KeyValueCoding import KeyValueCodingInterface
from Modeling.interfaces.RelationshipManipulation import 
     import RelationshipManipulationInterface
from Modeling.interfaces.Faulting import FaultingInterface

class DatabaseObjectInterface(FaultingInterface,
                              KeyValueCodingInterface,
                              RelationshipManipulationInterface,
                              ValidationInterface):
  """
  
  """
  def awakeFromFetch(self, anEditingContext):
    """
    'EditingContext' sends this message to every object fetched and
    registered in it.
    See 'EditingContext.objectsWithFetchSpecification()'

    'CustomObject' 's implementation calls 'awakeObjectFromFetch()' on the
    underlying 'ClassDescription'.

    Override this method if you want to make additional initialization after
    an object has been fetched and registered within an 'EditingContext'.
    In that case, it is your responsability to make sure that
    'CustomObject' 's method is called before proceeding.
    """
    
  def awakeFromInsertion(self, anEditingContext):
    """
    'EditingContext' sends this message to every object inserted in it.
    See 'EditingContext.insertObject()' and
    'EditingContext.insertObjectWithGlobalID()'

    'CustomObject' 's implementation calls 'awakeObjectFromInsertion()' on the
    underlying 'ClassDescription'.

    Override this method if you want to make additional initialization after
    an object has been inserted into an 'EditingContext'. In that case,
    it is your responsability to make sure that 'CustomObject' 's method is
    called before proceeding.
    """
    
  def allPropertyKeys(self):
    "attributesKeys + toOne/toManyRelationshipKeys"
    
  def attributeKeys(self):
    "See ClassDescription"
  
  def classDescription(self):
    "Returns the ClassDescription assigned to the receiver"

  def classDescriptionForDestinationKey(self, aKey):
    "Returns the ClassDescription assigned to the receiver"

  def clearProperties(self):
    """
    Clears all of the object's properties.

    This is used to break circular reference / for garbage collection 'n co,
    e.g. when an EditingContext is finalized and about to be garbage-collected
    
    See also: EditingContext.invalidatesObjectsWhenFinalized() for details
    """
    
  def deleteRuleForRelationshipKey(self, aKey):
    "See ClassDescription"
    raise 'Unimplemented'
  
  def entityName(self):
    """
    Returns the corresponding entity's name.
    Note that derived objects **must** override this.
    As a reminder this method raises 'MethodShouldBeOverridden'
    """
  
  def editingContext(self):
    ""
  
  def inverseForRelationshipKey(self, aKey):
    """
    Returns the name of the relationship pointing back to current entity, or
    None if it does not exists.

    Note: can be overriden in subclasses if the default behaviour would not
          return the correct answer.
    """

  def isToManyKey(self, aKey):
    """
    Tells whether the receiver's classDescription has a toMany relationship
    'aKey'
    """

  def propagateDeleteWithEditingContext(self, editingContext):
    "XXXX"
    
  def snapshot(self):
    """
    Returns a snapshot for the current object...
    ... NullValue vs. None ...
    Returned value: dictionary
    """
  
  def toManyRelationshipKeys(self):
    "See ClassDescription"
    
  def toOneRelationshipKeys(self):
    "See ClassDescription"
    
  def updateFromSnapshot(aSnapshotDictionary):
    "Updates the values from the supplied snapshot"
    
  def willChange(self):
    """
    XXXXX

    Transparently calls 'willRead'
    """
    
www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.