OptimizedPersistable Class

The default constructor can be used to create simple OptimizedPersistable objects.

This constructor can be used in cases where the object id is known but you don't want to open the object, maybe you just want to add this object to a BTreeSet.

Objects can be stored more efficiently if all object types on the page share the same type. By default mixed types are allowed. Override this to return false for types that should not share pages with other types.

By default, the an object cache is determined by a SessionBase constructor parameter but certain types of objects may be re opened more frequently than others, for such types override this to return a value. Caching objects this way can cause out of date object references to stay active due to lacking code to invalidate a cached object when referenced objects are replaced. We will add this automatic invalidation as soon as possible but for now use caution when caching objects. Caching objects that does not strongly reference other objects is OK to do.

Gets the database number of this object.

Gets the field members load state. By default, all members are loaded when a persistent object is opened but if an overrode of LazyLoadFields returns true then the object members are loaded by calling [!:OptimizedPersistable.LoadFields]

By default we flush (write) any updated page we find when looking for an object placement page and the page is considered full (depends on how many objects we permit/page)

Gets the id of this object. The id is structured as Oid

Gets the persistent state of an object. An object is considered persistent when it has an Oid, that is the Id is not 0

Gets the updated state of the object

By default all fields are loaded when opening a persistent object but an option is provided to load members on demand (lazy loading).

Possibly restrict instances of to a single Database. By default this property is UInt32.MaxValue but classes like BTreeSetOidShort, BTreeMapShortOid ... override this property to return 1 since short references are restricted to a single Database.

A default for number of objects per database page used when persisting objects without an explicit Placement object or if persisted using Persist(SessionBase, IOptimizedPersistable, Boolean, Boolean) This happens when objects are persisted by reachability from a persistent object. All objects reachable from a persistent object are automatically made persistent.

Gets the object identifier represented as an Oid.

Gets the OidShort part of the object Oid

Gets the page number part of the object Oid (Id)

A default for number of objects per database page used when persisting objects without an explicit Placement object or if persisted using Persist(SessionBase, IOptimizedPersistable, Boolean, Boolean) This happens when objects are persisted by reachability from a persistent object. All objects reachable from a persistent object are automatically made persistent.

Gets the Database Id number to use when placing (persisting) an instance of this class when no other placement directive has been given.

true if call to [!:Update(bool)] or UpdateObject(IOptimizedPersistable, Boolean, Boolean) caused this object to be removed from possible indices

Gets the short id of this object. The id is structured as OidShort

Gets the page number from the object identifier

See MemberwiseClone

Compares objects using the object Id

Determines whether the specified Object is equal to the current Object. If this object or other object isn't persistent we call Equals(Object)

Process data in transient fields (if any), do whatever is required to persist such data if needed. By default does nothing.

Gets a list of the fields meta data objects

Returns a list of field values of this object or returns it as an array (if this is an array)

Computes a hash code based on Oid of object. Make sure to persist objects before using GetHashCode() or override GetHashCode()

Get the persistent storage Page of this object

Gets the session of this object or null if this object isn't yet persisted.

The database engine needs this internally

Internally used when IOptimizedPersistable is a wrapper for a non IOptimizedPersistable

This function is called when an object has been read from disk and all data members (fields) have been loaded. Override this to provide your own initializations of transient data.

This function is called when an object has been read from disk before all data members (fields) have been fully loaded. Override this to provide your own initializations of transient data.

This is a support function for the VelocityDbBrowser

Gets the Oid (encoded as an UInt64) of a non OptimizedPersistable object or 0 if the object isn't persistent on the same page as this object.

Opens a persistent object located in the same Database as this object

Opens a persistent object located in the same Database as this object

Gets a list of all field values of the current object that are subclasses of OptimizedPersistable

Persists this object.

Persists this object. Override in your subclasses when you want fields of your class to be persisted in some special way.

Gets the page version of a persistent object

Persists references from this object

Used by code generator

Used by code generator. By default objects are read and written using persisted schema information and reflection.

Sets the persistent storage Page of this object

The database engine needs this internally

Internal use for now

Displays class name plus object id

Removes an object from the persistent store and makes the object a transient object. It does not automatically make referenced objects unpersisted. Best way to do so is to override this virtual function in your own classes.

Marks an object as being updated so that object will be written at commit transaction. Call before making object changes!

Marks an object as being updated so that object will be written at commit transaction. Call before making object changes! Add code to update object in Action parameter.

Marks an object as being updated so that object will be written at commit transaction. Call before updating a NON indexed field. Same as Update but avoids deleting object from indices (if any). If updating a field used in any index, call Update instead or you may end up with one or more corrupt indices.

Updates the object and make this object use the latest Type definition for its class. The object now will now adjust for data attribute changes.

By calling this you force a persisted (has an Id) object to be written to disk (if updated) and indices (if any) to be updated. Other objects on the same page will also be written.

Used by code generator.

Used by code generator. This is the default way of writing objects using schema information and .NET reflection info.

Object details as a string

Currently only used by Database Manager