DynamicBinary Class Reference

<class>Stream.DynamicBinary</class> character stream containing the 8-bit binary bytes of an element of a <class>DynamicAbstractObject</class>. More...

Inheritance diagram for DynamicBinary:

Collaboration diagram for DynamicBinary:

Public Member Functions
_.Library.Status	OutputToDevice (_.Library.Integer len)
	Write out len bytes of the stream to the current device. More...
_.Stream.Object	ReadLineIntoStream (_.Library.Status sc)
	This reads from the stream until it finds the. More...
Public Member Functions inherited from DynamicCharacter
_.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	Clear (_.Library.Boolean permanent)
_.Library.Status	CopyFrom (_.Stream.Object source)
_.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.Boolean	MoveTo (_.Library.Integer position)
	Move to this position in the stream. More...
_.Library.Status	MoveToEnd ()
_.Library.Integer	PositionGet ()
	Implements Property <property>Position</property> More...
_.Library.String	Read (_.Library.Integer len, _.Library.Status sc)
	Reads up to len characters from the current position. More...
_.Library.String	ReadLine (_.Library.Integer len, _.Library.Status sc, _.Library.Boolean eol)
	Read a line from the stream. More...
_.Library.Status	Rewind ()
	Go back to the start of the stream.
_.Library.Integer	SizeGet ()
	Implements Property <property>Size</property> More...
_.Library.Status	Write (_.Library.String data)
_.Library.Status	WriteLine (_.Library.String data)
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	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.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.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.
_.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	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...

Additional Inherited Members
Static Public Member Functions inherited from DynamicCharacter
_.Library.String	GetLockReference (_.Library.String pLocation, _.Library.String pId)
	Returns the global reference used to lock the current stream object.
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.
Public Attributes inherited from DynamicCharacter
	LineTerminator
	The line terminator we use for this stream. More...
	Position
	<property>Position</property> is a read-only property containing the More...
	Size
	<property>Size</property> is a read-only property containing the 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 DynamicCharacter
	BUFLEN = None
	<class>Stream.DynamicCharacter</class> character stream containing the textual value of an element of a <class>DynamicAbstractObject</class>. More...
	READLEN = None
	Default length for a Read.
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

<class>Stream.DynamicBinary</class> character stream containing the 8-bit binary bytes of an element of a <class>DynamicAbstractObject</class>.

It is particularly useful for holding the value of a <class>DynamicAbstractObject</class> element with a byte stream value that would exceed the capacity of an ObjectScript string variable. A <class>Stream.DynamicBinary</class> object is readonly and it cannot be modified or saved. But it can be copied to any other Stream class object that does support modification and saving.

One way to create a <class>Stream.DynamicBinary</class> is by making a method call that looks like dao.Get(key,default,"stream"), dao.Get(key,default,"stream<base64") or dao.Get(key,default,"stream>base64") where dao is an object reference to a subclass of <class>DynamicAbstractObject</class>; and where key is the key name value of an element of a <class>DynamicObject</class> or the index value of an element of a <class>DynamicArray</class>. You can also get a <class>Stream.DynamicBinary</class> object by calling the <method class="%Iterator.AbstractIterator">GetNext</method>(.key,.value,.type) method in one of subclasses of the <class>Iterator.AbstractIterator</class> class.

Member Function Documentation

OutputToDevice()

_.Library.Status OutputToDevice

(

_.Library.Integer

len

)

Write out len bytes of the stream to the current device.

starting from the current position. If len is omitted or set to -1 then the <method>OutputToDevice</method> method will write out the entire stream starting at the beginning and then rewind back to the beginning. If len &gt 0 and we are unable to write len bytes because we reach the end of the stream then we will stop writing and set the <property>AtEnd</property> property to 1. Otherwise, we will leave the stream positioned after the last byte written to the device. If parameter len is passed by reference and if no error occurs then the number of bytes actually written to the output device will be assigned to len. If zero bytes are written because we are already positioned at the end of the stream then len will be assigned to -1. If an error occurs while writing the device then len will be assigned to -2, an error <type>Status</type> value will be returned and the stream will rollback to its original position.

Reimplemented from DynamicCharacter.

ReadLineIntoStream()

_.Stream.Object ReadLineIntoStream

(

_.Library.Status

sc

)

This reads from the stream until it finds the.

<property>LineTerminator</property> and returns a new <class>Stream.TmpCharacter</class> stream containing the bytes in the line. If the stream does not contain the line terminator then this can potentially be the entire stream.

Reimplemented from DynamicCharacter.