Docs For Class StorableStringAbstract

Description

This is the StorablePrimitive abstract for classes with string-type data values.

author: Adam Franco <AT adamfranco DOT com adam AT adamfranco DOT com> <afranco AT middlebury DOT edu>
version: $Id: StorableString.abstract.php,v 1.12 2007/09/04 20:25:33 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/dataManager/storablePrimitives/StorableString.abstract.php (line 13)

SObject
   |
   --String
      |
      --StorableStringAbstract

Direct descendents

Class	Description
StorableBlob	This is the StorablePrimitive equivalent of Blob for the dm_blob table.
StorableShortString	This is the StorablePrimitive equivalent of String for the dm_shortstring table.
StorableString	This is the StorablePrimitive equivalent of String for the dm_string table.

Variable Summary

mixed $_table

Method Summary

object asABlob ()

object asABoolean ()

object asADateTime ()

object asAFloat ()

object asAInteger ()

object asAnOKIType ()

object asAShortString ()

object asAString ()

integer insert (integer $dbID)

void prune (integer $dbID, integer $dataID)

void update (integer $dbID, integer $dataID)

Variables

mixed $_table (line 19)

*******************************************************

Instance Methods *******************************************************

Inherited Variables

Inherited from String

String::$_string

Methods

asABlob (line 107)

Convert this object to a StorableBlob

since: 6/9/06
access: public

object asABlob ()

Redefined in descendants as:

StorableBlob::asABlob() : Convert this object to a StorableBlob

asABoolean (line 163)

Convert this object to a Boolean

since: 6/9/06
access: public

object asABoolean ()

asADateTime (line 140)

Convert this object to a StorableTime

since: 6/9/06
access: public

object asADateTime ()

asAFloat (line 185)

Convert this object to a StorableFloat

since: 6/9/06
access: public

object asAFloat ()

asAInteger (line 174)

Convert this object to a StorableInteger

since: 6/9/06
access: public

object asAInteger ()

asAnOKIType (line 152)

Convert this object to a OKIType

since: 6/9/06
access: public

object asAnOKIType ()

asAShortString (line 129)

Convert this object to a StorableShortString

since: 6/9/06
access: public

object asAShortString ()

Redefined in descendants as:

StorableBlob::asAShortString() : Convert this object to a StorableShortString

asAString (line 118)

Convert this object to a StorableString

since: 6/9/06
access: public

object asAString ()

Redefined in descendants as:

StorableBlob::asAString() : Convert this object to a StorableString

insert (line 27)

Inserts a new row into the Database with the data contained in the object.

return: Returns the new ID of the data stored.
access: public

integer insert (integer $dbID)

integer $dbID: The DBHandler database ID to query.

Redefined in descendants as:

StorableBlob::insert() : Inserts a new row into the Database with the data contained in the object.
StorableShortString::insert() : Inserts a new row into the Database with the data contained in the object.
StorableString::insert() : Inserts a new row into the Database with the data contained in the object.

prune (line 81)

Deletes the data row from the appropriate table.

access: public

void prune (integer $dbID, integer $dataID)

integer $dbID: The DBHandler database ID to query.
integer $dataID: The ID in the database of the data to be deleted.

update (line 54)

Uses the ID passed and updates the database row with new data.

access: public

void update (integer $dbID, integer $dataID)

integer $dbID: The DBHandler database ID to query.
integer $dataID: The ID in the database of the data to be updated.

Inherited Methods

Inherited From String

String::String()
String::fromString()
String::isEqualTo()
String::printableString()
String::withValue()

Inherited From SObject

SObject::asA()
SObject::asString()
SObject::copy()
SObject::copySameFrom()
SObject::copyTwoLevel()
SObject::deepCopy()
SObject::isEqual()
SObject::isEqualTo()
SObject::isNotEqualTo()
SObject::isNotReferenceTo()
SObject::isReferenceTo()
SObject::newFrom()
SObject::postCopy()
SObject::printableString()
SObject::shallowCopy()
SObject::_deepCopyArray()