RelationshipManipulation.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 » RelationshipManipulation.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.
#-----------------------------------------------------------------------------


"""
Relationship manipulation API

  The framework supplies a default implementation for this API.

  CVS information

    $Id: RelationshipManipulation.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.KeyValueCoding import KeyValueCodingInterface

class RelationshipManipulationInterface(KeyValueCodingInterface):
  """
  The RelationshipManipulation interface defines all methods needed to
  manipulates relationships defined in a Model (see Model, Entity,
  Relationship and ClassDescription).

  Its behaviour is similar to KeyValueCoding except that it does only handle
  keys mapped to relationships in the receivers' class descriptions.
  
  Implemented by: mix-in class RelationshipManipulation
  """
    
  def addObjectToBothSidesOfRelationshipWithKey(self, anObject, aKey):
    """
    Adds object to the corresponding relationship, and adds 'self'
    to 'anObject' 's inverse relationship, if it exists.

    Raises TypeError if 'aKey' cannot be found among the relationships of the
    receivers' class description.
    """

  def addObjectToPropertyWithKey(self, anObject, aKey):
    """
    Depending on the relationship, the method performs the foowing steps:

      toOne relationship --  simply sets the property using
      KeyValueCoding.takeValueForKey
      
      toMany relationships -- tries to add 'anObject' with method
      'addTo<Key>', or directly access the underlying set using
      KeyValueCoding.valueForKey(), adds 'anObject' to that set and sets it
      back in 'anObject' with 'KeyValueCoding.takeValueForKey()'.
    """

  def removeObjectFromBothSidesOfRelationshipWithKey(self, anObject, aKey):
    """

    Simply returns if anObject is None ('n issues a log at warning level)
    """

  def removeObjectFromPropertyWithKey(self, anObject, aKey):
    """
    Depending on the relationship, the method performs the following steps:

      toOne relationship --  simply removes the property using
      'KeyValueCoding.takeValueForKey(null)'
      
      toMany relationships -- tries to remove 'anObject' with method
      'addTo<Key>', or directly access the underlying set using
      'KeyValueCoding.valueForKey()', removes 'anObject' to that set and
      sets it back in 'anObject' with 'KeyValueCoding.takeValueForKey()'.

    Method raise 'ValueError' if relationship 'aKey' cannot be found, or
    if 'anObject' is not set for that key.
    """

  def classDescription(self):
    """
    Returns the class description for the receiver.
    This is the only method for which RelationshipManipulation does not define
    any default implementation ; it is usually implemented by objects
    implementing the DatabaseObject interface, such as CustomObject
    subclasses
    """
  
www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.