references._pike

Go to the documentation of this file.

/* Copyright (C) 2000-2004  Thomas Bopp, Thorsten Hampel, Ludger Merkens
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 * 
 * $Id: references.pike,v 1.1 2008/03/31 13:39:57 exodusd Exp $
 */
#include <macros.h>
#include <exception.h>
#include <database.h>
class references {
public:





 mapping mReferences;

 void   require_save(string|void a, string|void b);
int       get_object_class();
object     get_environment();
string      get_identifier();

/**
 * Initialize the reference storage.
 *  
 */
private:
 void init_references()
{
    mReferences = ([ ]);
}

public:


/**
 * Add a reference to this object. The reference functionality is
 * maintained by the server itself and shouldnt be called by other code.
 *  
 * @param object ref - the reference.
 * @see remove_reference
 */
void add_reference(object ref)
{
    mReferences[ref] = 1;
    require_save(STORE_REFS);
}

/**
 * Remove a reference from this object. The function is for internal use.
 * The references are maintained by the server itself.
 *  
 * @param object ref - a reference to remove.
 * @see add_reference
 */
void remove_reference(object ref)
{
    if ( CALLER->get_object_id() != ref->get_object_id() )
      THROW("Removing reference by non-referencing object ("+
       CALLER->get_object_id()+":"+ref->get_object_id()+
       ")", E_ACCESS);
    m_delete(mReferences, ref);
    require_save(STORE_REFS);
}

/**
 * Get the mapping of references. The mapping is in the form
 * ([ ref:1 ]) - a mapping is used for faster lookup.
 *  
 * @see add_reference
 */
mapping get_references()
{
    return copy_value(mReferences);
}

/**
 * Get the array of all referencing objects.
 *  
 * @see add_reference
 */
array get_referencing()
{
  return indices(mReferences);
}


/**
 * Store the references in the database. Database calls this function.
 *  
 * @return refereces.
private:
 * @see restore_references
 */
mixed
private:
store_references() 
{
    if (CALLER != _Database ) THROW("Caller is not Database !", E_ACCESS);
    return ([ "References": mReferences, ]);
}

public:

/**
 * The object is loaded and its references restored by the database.
 *  
 * @param mixed data - the reference data.
private:
 * @see store_references
 */
private:
void restore_references(mixed data)
{
    if (CALLER != _Database ) THROW("Caller is not Database !", E_ACCESS);
    mReferences = data["References"];
}

public:


};