GlobalStreamAdaptor Class Reference

Stream adaptor for streams that store data in global nodes. More...

Inheritance diagram for GlobalStreamAdaptor:

Collaboration diagram for GlobalStreamAdaptor:

Public Member Functions
_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
_.Library.Status	OnRollBack ()
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...
_.Library.Status	Flush ()
	Flush any output in the stream not already saved.
_.Library.Status	MoveToEnd ()
	Move to the end of the stream so the next <METHDO>Write</METHOD> will be appended to the end. More...
_.Library.AbstractStream	ReadLineIntoStream ()
	This reads from the stream until it find the <property>LineTerminator</property> and returns. More...
_.Library.Status	Rewind ()
	Go back to the start of the stream.
_.Library.Status	SaveStream ()
	Deprecated method, use <method>Save</method> instead. More...
_.Library.Integer	SizeGet ()
	Return the current size of the data stream.
Public Member Functions inherited from AbstractStream
_.Library.Status	CopyFrom (_.Stream.Object source)
	Copies the contents of source into this Stream. More...
_.Library.Boolean	DeleteAttribute (_.Library.String name)
	Removes this attribute variable from the collection. More...
_.Library.String	GetAttribute (_.Library.String name, _.Library.String default)
	Retrieves the named attribute value.
_.Library.String	GetStreamId ()
	Returns an full id value (including class name) with which the Stream implementation has stored. More...
_.Library.Boolean	IsDefinedAttribute (_.Library.String name)
	Returns true if the named attribute variable exists in the collection, false otherwise.
_.Library.Boolean	IsNull ()
	Returns true if this is a "NULL" stream; that is, a stream which has never. More...
_.Library.String	NextAttribute (_.Library.String name)
	Retrieves the next attribute variable name in the sequence, skip any '' names.
	SetAttribute (_.Library.String name, _.Library.String value)
	Inserts an attribute variable by name into the collection.
_.Library.Status	WriteLine (_.Library.RawString data)
	Appends the string data along with a line terminator to the stream and advances the. More...
Public Member Functions inherited from Object
_.Library.Status	AcquireLock (locktype)
	Acquires a lock for the current instance. More...
_.Library.Status	OnAfterSave (_.Library.Boolean insert)
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...
_.Library.Status	OnBeforeSave (_.Library.Boolean insert)
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...
_.Library.Status	OnOpen ()
	This callback method is invoked by the <METHOD>Open</METHOD> method to. More...
_.Library.Status	OnReload ()
	This callback method is invoked by the <METHOD>Reload</METHOD> method to. More...
_.Library.Status	Clear ()
	Clear the contents of this Stream from permanent storage. More...
_.Library.Status	CopyFrom (_.Stream.Object source)
	Copies the contents of source into this Stream. More...
_.Library.Status	CopyFromAndSave (_.Stream.Object source)
	Copy the stream from source into the current stream ignoring anything already in the current stream. More...
_.Library.Integer	FindAt (_.Library.Integer position, _.Library.RawString target, _.Library.RawString tmpstr, _.Library.Boolean caseinsensitive)
	Find the first occurrence of target in the stream, starting the search at position. More...
_.Library.Status	InputFromDevice (_.Library.Integer len, _.Library.Integer timeout)
	Input len characters from the current device into the stream. More...
_.Library.Boolean	MoveTo (_.Library.Integer position)
	Move to this position in the stream. More...
_.Library.Status	OutputToDevice (_.Library.Integer len)
	Write out len characters of the stream to the current device starting from the current position. More...
_.Library.Status	OutputToDeviceAt (_.Library.Integer position, _.Library.Integer length)
	Output the stream to the current device starting at position of length. More...
_.Library.RawString	Read (_.Library.Integer len, _.Library.Status sc)
	Reads up to len characters from the current position. More...
_.Library.RawString	ReadLine (_.Library.Integer len, _.Library.Status sc, _.Library.Boolean eol)
	Read a line from the stream. More...
_.Library.String	ReadSQL (_.Library.Integer start, _.Library.Integer end)
	SQL specific method for reading stream data.
_.Library.Status	SerializeToSyncSet (_.SYNC.SyncSet ss, _.Library.Integer iPtr, _.Library.String property)
	SerializeToSyncSet copies the stream value from the current object to the sync set global. More...
_.Library.Status	SyncStreamIn (_.SYNC.SyncSet ss, _.Library.Integer iPtr, _.Library.String property)
	SyncStreamIn copies the stream value from the sync set global into the current object.
_.Library.Status	Write (_.Library.RawString data)
	Appends the string data to the stream and advances the. More...
_.Library.Status	WriteLine (_.Library.RawString data)
	Appends the string data along with a line terminator to the stream and advances the. More...
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...
_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...
_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Static Public Member Functions
_.Library.String	GetLockReference (_.Library.String pLocation, _.Library.String pId)
	Returns the global reference used to lock the current stream object. More...
_.Library.Integer	ObjectSizeInternal (_.Library.ObjectIdentity soid)
	Return the size of the stream pointed to by soid.
_.Library.String	GlobalFromSid (_.Library.String sid)
	Given a stream id this returns the root global node where this stream is stored.
_.Library.Boolean	StreamOIDIsNull (_.Library.ObjectIdentity soid)
	Return true if this stream oid is a null stream and false if the stream is not null.
Static Public Member Functions inherited from AbstractStream
_.Library.Status	DeleteStream (_.Library.ObjectIdentity oid, _.Library.Integer concurrency)
	Deprecated method, use <method>Delete</method> instead. More...
Static Public Member Functions inherited from Object
_.Library.String	GetLockReference (_.Library.String pLocation, _.Library.String pId)
	Returns the global reference used to lock the current stream object. More...
_.Library.Status	OnDelete (_.Library.ObjectIdentity oid)
	This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...
_.Library.String	IsCharacter ()
	Return true if this is a character stream and false if it is a binary stream.
_.Library.Boolean	StreamOIDIsNull (_.Library.ObjectIdentity soid)
	Return true if this stream oid is a null stream and false if the stream is not null.

Static Public Attributes
	BUFFERLEN = None
	Stream adaptor for streams that store data in global nodes. More...
	STOREGLOBALNAME = None
	Default location: can be overridden at run-time.
Static Public Attributes inherited from AbstractStream
	MAXLEN = None
	The maximum number of characters (or bytes) allowed in a stream.
	PROPERTYVALIDATION = None
	Turns off property validation.
Static Public Attributes inherited from Object
	DEFAULTCONCURRENCY = None
Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...
	JAVATYPE = None
	The Java type to be used when exported.
	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Private Member Functions
	LockStream ()
	LockStream() More...
_.Library.Status	NormalizeObject ()
	Normalizes all of an object's property values by invoking the data type Normalize methods. More...
	__CheckAtEnd ()
	Check if we are at the end of the global, but do not read the next buffer.
_.Library.String	__IOGetStreamId ()
	Return the id for a stream; that is, an identifier that can later be used. More...
	__IOInit ()
	Initialize member variable used by the StreamAdaptor. More...
_.Library.Boolean	__ReadIntoBuffer ()
	Reads the next node into Buffer. More...

Static Private Member Functions
_.Library.Boolean	ObjectIsNull (_.Library.ObjectIdentity soid)
	Return true if this stream oid is a null stream and false if the stream is not null.
_.Library.Status	__IODeleteStream (_.Library.String sid, _.Library.Integer concurrency)
	Delete the storage for the stream identified by sid.

Private Attributes
	__Buffer
	More...
	__IOSize
	More...
	__MaxNodeNo
	Maximum subscript in data we are reading. More...
	__NodeNo
	The current node we are reading from. More...
	__Position
	More...
	__StoreGlvn
	StoreGlvn is actual location where data is stored: StoreRoot + StoreNode. More...
	__StoreNode
	More...
	__StoreRoot
	Root is Global Location (name and top subscripts) More...
	__TempGlvn
	TempGlvn is actual temp location: TEMPGLOBALNAME + TempNode. More...
	__TempNode
	More...
	__rollback
	More...

Additional Inherited Members
Public Attributes inherited from AbstractStream
	Attributes
	An array of strings containing any attribute values associated with this stream. More...
	LineTerminator
	Type of line terminator we use for this stream, defaults to Cr/Lf. More...
Public Attributes inherited from Object
	AtEnd
	The AtEnd property is set to true (1) when, during a read,. More...
	LastModified
	LastModified is a read-only property containing the <class>TimeStamp</class> of More...
	Size
	Size is a read-only property containing the current size of the stream (in bytes More...

Detailed Description

Stream adaptor for streams that store data in global nodes.

Not to be used directly.

Member Function Documentation

GetLockReference()

_.Library.String GetLockReference ( _.Library.String  pLocation, _.Library.String  pId  )

static

Returns the global reference used to lock the current stream object.

Throws Exception.AbstractException

LockStream()

LockStream ( )

private

LockStream()

Obtain a shared lock on the current stream object. The return value is 1 if the stream was already locked or if it was successfully locked. If the stream cannot be locked the return value is 0. This version of LockStream differs from Stream.Object only in the arguments passed to GetLockReference.

Reimplemented from Object.

NormalizeObject()

_.Library.Status NormalizeObject ( )

private

Normalizes all of an object's property values by invoking the data type Normalize methods.

Many data types may allow many different representations of the same value. 
Normalization converts a value to its cannonical, or <em>normalized</em>, form.

Reimplemented from RegisteredObject.

OnClose()

_.Library.Status OnClose

(

)

This callback method is invoked by the <METHOD>Close</METHOD> method to.

provide notification that the current object is being closed.

The return value of this method is ignored.

Reimplemented from AbstractStream.

OnConstructClone()

_.Library.Status OnConstructClone	(	_.Library.RegisteredObject	object,
		_.Library.Boolean	deep,
		_.Library.String	cloned
	)

This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to.

provide notification that a clone of an object is being created. It passes in the oref of the object that was cloned in object.

If this method returns an error then the object will not be created.

Reimplemented from RegisteredObject.

OnRollBack()

_.Library.Status OnRollBack

(

)

This callback method is invoked by the <METHOD>Save</METHOD> method to.

provide notification that a save transaction is being rolled back.

If this method returns an error then the rollback operation will be aborted.

Reimplemented from Object.

__IOGetStreamId()

_.Library.String __IOGetStreamId ( )

private

Return the id for a stream; that is, an identifier that can later be used.

to open the same stream.

Reimplemented from AbstractStream.

__IOInit()

__IOInit ( )

private

Initialize member variable used by the StreamAdaptor.

This

This is called when the containing stream is opened via SetSerial.

Reimplemented from AbstractStream.

MoveToEnd()

_.Library.Status MoveToEnd

(

)

Move to the end of the stream so the next <METHDO>Write</METHOD> will be appended to the end.

This allows you to read from a stream, then MoveToEnd() and append new data, where just calling <METHOD>Write</METHOD> after a read will clear the stream before writing new data.

Returns a <CLASS>Status</CLASS> value indicating success or failure.

Reimplemented from AbstractStream.

__ReadIntoBuffer()

_.Library.Boolean __ReadIntoBuffer ( )

private

Reads the next node into Buffer.

Returns 0 if there is no more data.

ReadLineIntoStream()

_.Library.AbstractStream ReadLineIntoStream

(

)

This reads from the stream until it find the <property>LineTerminator</property> and returns.

this as a stream. If the stream does not contain the line terminator this can potentially be the entire stream.

Reimplemented from AbstractStream.

SaveStream()

_.Library.Status SaveStream

(

)

Deprecated method, use <method>Save</method> instead.

Saves the temporary copy of the stream data to a persistent location. Note that any locking or transaction handling must be done by the caller.

Returns a <CLASS>Status</CLASS> value indicating success or failure.

Reimplemented from AbstractStream.

Member Data Documentation

BUFFERLEN

BUFFERLEN = None

static

Stream adaptor for streams that store data in global nodes.

Not to be used directly.

Number of characters that we are storing in each global node

__Buffer

__Buffer

private

 

 

__IOSize

__IOSize

private

 

 

__MaxNodeNo

__MaxNodeNo

private

Maximum subscript in data we are reading.

 

__NodeNo

__NodeNo

private

The current node we are reading from.

 

__Position

__Position

private

 

 

__StoreGlvn

__StoreGlvn

private

StoreGlvn is actual location where data is stored: StoreRoot + StoreNode.

 

__StoreNode

__StoreNode

private

 

 

__StoreRoot

__StoreRoot

private

Root is Global Location (name and top subscripts)

 

__TempGlvn

__TempGlvn

private

TempGlvn is actual temp location: TEMPGLOBALNAME + TempNode.

 

__TempNode

__TempNode

private

 

 

__rollback

__rollback

private