SBOSReference.h

//========================================================================================
// 
// $File$
// 
// Owner: Jianlan Song
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================


#include "IPMStream.h"
#include "SBOSRefInstantiate.h"

template <class ISBOSObj>
class SBOSReference
{
 public:
 typedef base_type data_type;


 SBOSReference() :
 fBaseUIDRef(), fSubItem(kInvalidSBOSID)
 {}


 SBOSReference(const UIDRef& baseUIDRef, SBOSID subItemID = kInvalidSBOSID) :
 fBaseUIDRef(baseUIDRef), fSubItem(subItemID)
 {}


 const UIDRef& GetUIDRef() const
 { return fBaseUIDRef; }


 UID GetUID() const
 { return fBaseUIDRef.GetUID(); }


 IDataBase *GetDataBase() const
 { return fBaseUIDRef.GetDataBase(); }


 SBOSID GetLogicalID() const
 { return fSubItem; }


 void SetLogicalID(SBOSID newValue)
 { fSubItem = newValue; }


 ISBOSObj* Instantiate() const
 { 
 IPMUnknown* obj = SBOSRefInstantiate::Instantiate(fBaseUIDRef, fSubItem, ISBOSObj::kDefaultIID);
 if (obj)
 return static_cast<ISBOSObj*>(obj);
 else
 return nil;
 }

 void ReadWrite(IPMStream *s, IDataBase *db = nil)
 { 
 if (s->IsReading()) {
 // reset all values to default, in case this is a snapshot restore
 fBaseUIDRef = UIDRef::gNull;
 fSubItem = kInvalidSBOSID;
 }

 UID uid = fBaseUIDRef.GetUID();
 
 s->XferReference(uid); 
 if (s->IsReading() && uid != kInvalidUID) 
 fBaseUIDRef = UIDRef(db, uid);
 
 s->XferInt32((int32&)fSubItem); 
 } 

 bool16 operator == (const SBOSReference& other) const
 { return fBaseUIDRef == other.fBaseUIDRef && fSubItem == other.fSubItem; } 


 inline bool16 operator != (const SBOSReference& compareAgainst) const
 { return (!(*this == compareAgainst)); }

 bool16 operator < (const SBOSReference& compareAgainst) const
 {
 if (this->GetDataBase() == compareAgainst.GetDataBase())
 {
 if (this->GetUID() == compareAgainst.GetUID())
 return this->GetLogicalID() < compareAgainst.GetLogicalID();
 else
 return this->GetUID() < compareAgainst.GetUID();
 } 
 
 return this->GetDataBase() < compareAgainst.GetDataBase();
 }
 
 private:
 UIDRef fBaseUIDRef;
 SBOSID fSubItem;
};