Main Page | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | Directories | File List | Namespace Members | Data Fields | Globals

ph::common::persistable_object_context Class Reference

#include <persistable_object.hpp>

Inheritance diagram for ph::common::persistable_object_context:

persist_test::context

Detailed Description

Abstract class representing a context that is passed when objects are created.

Definition at line 70 of file persistable_object.hpp.

Public Member Functions

virtual ~persistable_object_context ()
virtual object_basecreate (const std::string &type, const std::string &name)=0
virtual object_basefind_object (object_base *root, object_base *obj, const std::string &location)=0
virtual object_basefind_composite_object (object_base *root, object_base *obj, const std::string &location)=0
virtual bool delayed_import ()
virtual ph::common::object_basecreate_delayed (std::ostream *console, const boost::filesystem::path &url, const std::string &name, unsigned int debug)
 Create an object to hold delayed import information.


Constructor & Destructor Documentation

virtual ph::common::persistable_object_context::~persistable_object_context  )  [inline, virtual]
 

Definition at line 77 of file persistable_object.hpp.


Member Function Documentation

virtual object_base* ph::common::persistable_object_context::create const std::string &  type,
const std::string &  name
[pure virtual]
 

Create an object of the appropriate type and name. Usually implemented with an Abstract Factory pattern.

virtual object_base* ph::common::persistable_object_context::find_object object_base root,
object_base obj,
const std::string &  location
[pure virtual]
 

Find the object and return it if it's Composite. "root" is the root object of the tree. "obj" is the current object for relative locations. "location" is the path location.

virtual object_base* ph::common::persistable_object_context::find_composite_object object_base root,
object_base obj,
const std::string &  location
[pure virtual]
 

Find the object and return it if it's Composite. "root" is the root object of the tree. "obj" is the current object for relative locations. "location" is the path location.

virtual bool ph::common::persistable_object_context::delayed_import  )  [inline, virtual]
 

The XML parser can do delayed importing. This means that instead of actually importing an external file, a placeholder object is created and then when this placeholder is referenced, the actual import is performed. This speeds up extremely large object systems, and you can enable this behaviour by returning true here. If your parser doesn't handle this type of importing, then throw an error if this is set to true (or something).

Definition at line 105 of file persistable_object.hpp.

virtual ph::common::object_base* ph::common::persistable_object_context::create_delayed std::ostream *  console,
const boost::filesystem::path &  url,
const std::string &  name,
unsigned int  debug
[inline, virtual]
 

Create an object to hold delayed import information.

Definition at line 114 of file persistable_object.hpp.


The documentation for this class was generated from the following file:
Generated on Wed Apr 5 22:03:34 2006 for cppxmlobj by  doxygen 1.4.3