GlobalCharacter Class Reference

Inheritance diagram for GlobalCharacter:

Collaboration diagram for GlobalCharacter:

Public Member Functions
_.Library.Status	CopyFromAndSave (_.Stream.Object source)
	Copy the stream from source into the current stream ignoring anything already in the current stream. More...
Public Member Functions inherited from TmpCharacter
_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
_.Library.Status	OnRollBack ()
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...
_.Library.Status	CopyFrom (_.Stream.Object source)
	Copies the contents of source into this Stream. More...
_.Library.Status	Flush ()
	Flush any output in the stream not already saved.
_.Library.Boolean	IsNull ()
	Returns true if this is a "NULL" stream; that is, a stream which has never. More...
_.Library.Status	MoveToEnd ()
	Move to the end of the stream so the next <METHDO>Write</METHOD> will be appended to the end. 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.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...
_.Stream.Object	ReadLineIntoStream (_.Library.Status sc)
	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.Integer	SizeGet ()
	Return the current size of the data stream.
_.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 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.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.String	GetStreamId ()
	Returns an full id value (including class name) with which the Stream implementation has stored. 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	OutputToDeviceAt (_.Library.Integer position, _.Library.Integer length)
	Output the stream to the current device starting at position of length. 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.
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	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	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.Integer	ObjectSizeInternal (_.Library.ObjectIdentity soid)
	Return the size of the stream pointed to by soid.
Static Public Member Functions inherited from TmpCharacter
_.Library.String	GetLockReference (_.Library.String pLocation, _.Library.String pId)
	Returns the global reference used to lock the current stream object. More...
Static Public Member Functions inherited from Object
_.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.

Private Member Functions
	__SetupTmpGbl ()
	Setup the TempGbl location of where we will write the temp stream to.

Additional Inherited Members
Public Attributes inherited from TmpCharacter
	LineTerminator
	Type of line terminator we use for this stream, defaults to Cr/Lf. More...
	RemoveOnClose
	If true then remove the permanent global as well as any temp global when this object is closed. More...
Public Attributes inherited from Object
	AtEnd
	The AtEnd property is set to true (1) when, during a read,. More...
	Id
	Id is the unique identifier for a stream within the Location. 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...
Static Public Attributes inherited from TmpCharacter
	BUFFERLEN = None
	Number of characters that we are storing in each global node.
	COMPRESS = None
	Compress behavior of this class. More...
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...

Detailed Description

For information on this class, see Working with Streams.

Stream class that stores character data in global nodes.

Member Function Documentation

CopyFromAndSave()

_.Library.Status CopyFromAndSave

(

_.Stream.Object

source

)

Copy the stream from source into the current stream ignoring anything already in the current stream.

and save the result to the permanent location. This is used to optimise the copying of say a <CLASS>GlobalCharacterStream</CLASS> to another <CLASS>GlobalCharacterStream</CLASS> to avoid copying into temporary storage first and then moving this to the permanent storage when <METHOD>SaveStream</METHOD> is called.

Note that any locking or transaction handling must be done by the caller.

Reimplemented from Object.