Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / EnsLib.File.Common
Private  Storage   

EnsLib.File.Common


abstract class EnsLib.File.Common extends
Ens.Util.File

A helper class for File and FTP adapters defining properties that are common to all

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 6 2


Summary


Properties
%logTransfers Charset FilePath

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
CorrespondingSemaphoreExists CreateTimestamp DeepListClose DeepListExecute
DeepListFetch FileLikePattern FileListClose FileListExecute
FileListFetch GenerateSemaphoreFilename LinkFileStream NormalizeDirectory
SemaphoreFileExists fixPath

Subclasses
EnsLib.FTP.OutboundAdapter EnsLib.File.InboundAdapter EnsLib.File.OutboundAdapter

Properties


• property %logTransfers as %Boolean [ InitialExpression = 1 ];
Flag controlling logging of files processed
• property Charset as %String [ InitialExpression = "Native" ];
Character encoding scheme used for translating output to files. For binary output, use 'Binary'. Other choices include:
Native - the default character encoding of the installed locale of the InterSystems IRIS server
latin1 - the ISO Latin1 8-bit encoding
ISO-8859-1 - the ISO Latin1 8-bit encoding
UTF-8 - the Unicode 8-bit encoding
Unicode - the Unicode 16-bit encoding (Little-Endian)
UnicodeBig - the Unicode 16-bit encoding (Big-Endian)
@<ttable> - <ttable> means a raw InterSystems character translation table name. A prefix of '@' means to use the named table.
• property FilePath as %String(MAXLEN=1000) [ Required ];
The operating system directory where output files should be deposited. Does not include a filename specifier - see Filename. May be prepended with @AgentName:.

Methods


• classmethod DeepListClose(QHandle As %Binary) as %Status
• classmethod DeepListExecute(ByRef QHandle As %Binary, adapter As Ens.Adapter, directory As %String, wildcards As %String, recurseSubdirs As %Integer = 0, listQuery As %String = "FileList", semaphoreSpec As %String = "") as %Status
• classmethod DeepListFetch(ByRef QHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
• classmethod FileListClose(QHandle As %Binary) as %Status
• classmethod FileListExecute(ByRef QHandle As %Binary, adapter As Ens.Adapter, directory As %String, wildcards As %String, dirsOrNoDirs As %Boolean = 0, semaphoreSpec As %String = "") as %Status
• classmethod FileListFetch(ByRef QHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status

Queries


• query DeepList(adapter As Ens.Adapter, directory As %String(MAXLEN=""), wildcards As %String, recurseSubdirs As %Integer = 0, listQuery As %String = "FileList", semaphoreSpec As %String = "")
Selects Name As %String, Type As %String, Size As %BigInt, DateCreated As %TimeStamp, DateModified As %TimeStamp, ItemName As %String, ItemDir As %String, SemaphoreName As %String
This query is a shadow of the one of the same name in %Library.File, using an interface to the Adapter and skipping directories The recurseSubdirs argument will cause files from subdirectories also to be returned up to the specified integer depth of subdirectory levels.
• query FileList(adapter As Ens.Adapter, directory As %String(MAXLEN=""), wildcards As %String, dirsOrNoDirs As %Boolean = 0, semaphoreSpec As %String = "")
Selects Name As %String, Type As %String, Size As %BigInt, DateCreated As %TimeStamp, DateModified As %TimeStamp, ItemName As %String, ItemDir As %String, SemaphoreName As %String
This query is a shadow of the FileSet query in %Library.File, using an interface to the Adapter and skipping directories The dirsOrNoDirs argument if 0 (the default) will exclude directory entries, or if 1 will return directory entries only.