Oid.h

/* 
   EyeDB Object Database Management System
   Copyright (C) 1994-2008 SYSRA
   
   EyeDB is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 2.1 of the License, or (at your option) any later version.
   
   EyeDB 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
   Lesser General Public License for more details.
   
   You should have received a copy of the GNU Lesser General Public
   License along with this library; if not, write to the Free Software
   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA 
*/

/*
   Author: Eric Viara <viara@sysra.com>
*/


#ifndef _EYEDB_OID_H
#define _EYEDB_OID_H

#include <iostream>

namespace eyedb {

  class Oid;

  std::ostream& operator<<(std::ostream&, const Oid &);
  std::ostream& operator<<(std::ostream&, const Oid *);

  class Oid {

    // ----------------------------------------------------------------------
    // Oid Interface
    // ----------------------------------------------------------------------

  public:
    Oid() {
      oid = nullOid.oid;
    }

    Oid(const Oid &_oid);

    Oid(const char *str);

    Oid(eyedbsm::Oid::NX nx, eyedbsm::Oid::DbID dbid,
        eyedbsm::Oid::Unique unique);

    eyedbsm::Oid::NX getNX() const     {return oid.getNX();}

    eyedbsm::Oid::DbID getDbid() const   {return oid.getDbID();}

    eyedbsm::Oid::Unique getUnique() const {return oid.getUnique();}


    const char *getString() const;

    const char *toString()  const {return getString();}


    Oid &operator =(const Oid &oid);

    bool operator <(const Oid &oid) const {
      if (getDbid() != oid.getDbid())
        return getDbid() < oid.getDbid();
      return getNX() < oid.getNX();
    }

    bool operator !() const {
      return !isValid() ? true : false;
    }

    const eyedbsm::Oid *getOid() const {return &oid;}

    void setOid(const eyedbsm::Oid&);

    void setOid(const eyedbsm::Oid *_oid) {oid = *_oid;}

    eyedbsm::Oid *getOid() {return &oid;}


    Bool isValid() const {
      return oid.getNX() ? True : False;
    }    

    void invalidate() {

      oid = nullOid.oid;
    }

    Bool compare(const Oid &_oid) const {
      return IDBBOOL(!memcmp(&oid, &_oid.oid, sizeof(oid)));
    }

    Bool operator==(const Oid &_oid) const {
      return IDBBOOL(!memcmp(&oid, &_oid.oid, sizeof(oid)));
    }

    Bool operator!=(const Oid &_oid) const {
      return IDBBOOL(memcmp(&oid, &_oid.oid, sizeof(oid)));
    }

    static const Oid nullOid;

    ~Oid() {}

  private:
    eyedbsm::Oid oid;

  public: /* restricted */
    Oid(const eyedbsm::Oid &);
    Oid(const eyedbsm::Oid *);
  };

  class Collection;
  class OidList;
  class LinkedList;
  class LinkedListCursor;

  class OidArray {

  public:
    OidArray(const Oid *oids = NULL, int count = 0);

    OidArray(const Collection *coll);

    OidArray(const OidList &list);

    OidArray(const OidArray &oid_arr);

    OidArray& operator=(const OidArray &oid_arr);

    void set(const Oid *oids, int count);

    int getCount() const {return count;}


    Oid & operator[](int x) {
      return oids[x];
    }

    const Oid &operator[](int x) const {
      return oids[x];
    }

    OidList *toList() const;

    ~OidArray();

  private:
    int count;
    Oid *oids;
  };

  class OidListCursor;

  class OidList {

  public:
    OidList();

    OidList(const OidArray &oid_array);

    int getCount() const;

    void insertOid(const Oid &oid);

    void insertOidLast(const Oid &oid);

    void insertOidFirst(const Oid &oid);

    Bool suppressOid(const Oid &oid);

    Bool exists(const Oid &oid) const;

    void empty();

    OidArray *toArray() const;

    ~OidList();

  private:
    LinkedList *list;
    friend class OidListCursor;
  };

  class OidListCursor {

  public:
    OidListCursor(const OidList &oidlist);

    OidListCursor(const OidList *oidlist);

    Bool getNext(Oid &oid);

    ~OidListCursor();

  private:
    LinkedListCursor *c;
  };

}

#endif

---