This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > Ens.StreamContainer

Ens.StreamContainer

persistent class Ens.StreamContainer extends %Library.Persistent, Ens.Util.MessageBodyMethods, %XML.Adaptor

SQL Table Name: Ens.StreamContainer

This class is a persistent object that transparently encapsulates any type of persistable stream object

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property Attributes as array of %String);
An array of strings containing any attribute values
Property methods: AttributesBuildValueArray(), AttributesCollectionToDisplay(), AttributesCollectionToOdbc(), AttributesDisplayToCollection(), AttributesDisplayToLogical(), AttributesGet(), AttributesGetObject(), AttributesGetObjectId(), AttributesGetStored(), AttributesGetSwizzled(), AttributesIsValid(), AttributesLogicalToDisplay(), AttributesLogicalToOdbc(), AttributesNormalize(), AttributesOdbcToCollection(), AttributesSet(), AttributesSetObject(), AttributesSetObjectId()
property OriginalFilename as %String);
Property methods: OriginalFilenameDisplayToLogical(), OriginalFilenameGet(), OriginalFilenameGetStored(), OriginalFilenameIsValid(), OriginalFilenameLogicalToDisplay(), OriginalFilenameLogicalToOdbc(), OriginalFilenameNormalize(), OriginalFilenameSet()
property Stream as %Stream.Object [ Calculated , Transient ];
Property methods: StreamBFDelete(), StreamBFGet(), StreamBFGetObject(), StreamBFGetObjectId(), StreamBFGetStored(), StreamBFGetSwizzled(), StreamBFIsValid(), StreamBFNewObject(), StreamBFOid(), StreamBFOpen(), StreamBFSetObject(), StreamBFSetObjectId(), StreamBFUnSwizzle(), StreamBGDelete(), StreamBGGet(), StreamBGGetObject(), StreamBGGetObjectId(), StreamBGGetStored(), StreamBGGetSwizzled(), StreamBGIsValid(), StreamBGNewObject(), StreamBGOid(), StreamBGOpen(), StreamBGSetObject(), StreamBGSetObjectId(), StreamBGUnSwizzle(), StreamCFDelete(), StreamCFGet(), StreamCFGetObject(), StreamCFGetObjectId(), StreamCFGetStored(), StreamCFGetSwizzled(), StreamCFIsValid(), StreamCFNewObject(), StreamCFOid(), StreamCFOpen(), StreamCFSetObject(), StreamCFSetObjectId(), StreamCFUnSwizzle(), StreamCGDelete(), StreamCGGet(), StreamCGGetObject(), StreamCGGetObjectId(), StreamCGGetStored(), StreamCGGetSwizzled(), StreamCGIsValid(), StreamCGNewObject(), StreamCGOid(), StreamCGOpen(), StreamCGSetObject(), StreamCGSetObjectId(), StreamCGUnSwizzle(), StreamDelete(), StreamFBDelete(), StreamFBGet(), StreamFBGetObject(), StreamFBGetObjectId(), StreamFBGetStored(), StreamFBGetSwizzled(), StreamFBIsValid(), StreamFBNewObject(), StreamFBOid(), StreamFBOpen(), StreamFBSetObject(), StreamFBSetObjectId(), StreamFBUnSwizzle(), StreamFCDelete(), StreamFCGet(), StreamFCGetObject(), StreamFCGetObjectId(), StreamFCGetStored(), StreamFCGetSwizzled(), StreamFCIsValid(), StreamFCNewObject(), StreamFCOid(), StreamFCOpen(), StreamFCSetObject(), StreamFCSetObjectId(), StreamFCUnSwizzle(), StreamGBDelete(), StreamGBGet(), StreamGBGetObject(), StreamGBGetObjectId(), StreamGBGetStored(), StreamGBGetSwizzled(), StreamGBIsValid(), StreamGBNewObject(), StreamGBOid(), StreamGBOpen(), StreamGBSetObject(), StreamGBSetObjectId(), StreamGBUnSwizzle(), StreamGCDelete(), StreamGCGet(), StreamGCGetObject(), StreamGCGetObjectId(), StreamGCGetStored(), StreamGCGetSwizzled(), StreamGCIsValid(), StreamGCNewObject(), StreamGCOid(), StreamGCOpen(), StreamGCSetObject(), StreamGCSetObjectId(), StreamGCUnSwizzle(), StreamGet(), StreamSet()
property Type as %String (MAXLEN = 2) [ ReadOnly ];
Property methods: TypeDisplayToLogical(), TypeGet(), TypeGetStored(), TypeIsValid(), TypeLogicalToDisplay(), TypeLogicalToOdbc(), TypeNormalize()

Methods (Including Private)

private classmethod %OnDelete(oid As %ObjectIdentity) as %Status
Inherited description: This callback method is invoked by the %Delete() method to provide notification that the object specified by oid is being deleted.

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

private method %OnNew(pInput As %CacheString = $$$NULLOREF, pAttributes As %Collection.ArrayOfDT = $$$NULLOREF) as %Status
Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

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

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

private method %OnOpen() as %Status
Inherited description: This callback method is invoked by the %Open() method to provide notification that the object specified by oid is being opened.

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

method SetAttributes(ByRef pAttributes)
Set values into the Attributes array property Pass in an array object, a COS array, a COS array reference, a %AbstractStream with its own Attributes to copy from, a %Net.HttpResponse object with its own Headers to copy from, or a string of the form 'a=1,b=2,c=3'.
method StreamGet() as %Stream.Object
method StreamSet(pInput As %Stream.Object) as %Status

Triggers

trigger OnDelete (BEFORE event DELETE);

Inherited Members

Inherited Methods (Including Private)

Storage

Storage Model: CacheStorage (Ens.StreamContainer)

^Ens.StreamContainerD(ID,"Attributes",n)
=
Attributes(n)

Storage Model: CacheStorage (Ens.StreamContainer)

^Ens.StreamContainerD(ID)
=
%%CLASSNAME
OriginalFilename
StreamFB
StreamFC
StreamGB
StreamGC
Type
StreamCF
StreamBF
StreamCG
StreamBG
FileCharEncodingTable
CharEncodingTable

Subclasses

FeedbackOpens in a new window