Class %iKnow.Model.listFiles

deprecatedclass %iKnow.Model.listFiles extends %iKnow.Model.list

For details on using this class, see NLP Domains.

Subclass of %iKnow.Model.list dedicated to represent lists for the File Lister. This class has its own set of properties representing the specific Lister paramaters of the File Lister and hence is more easy to use than the generic list class. Any <parameter> elements nested within this element will be overwritten with the values specified for the corresponding shorthand attributes.

See also %iKnow.Source.File.Lister for more details on these Lister Parameters.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
1	6

Summary

Properties
batchMode	configuration	converter	data
disabled	encoding	extensions	filterCondition
listerClass	listname	metadataValues	parameters
path	processor	recursive

Methods
%AddToSaveSet	%BindExport	%ClassIsLatestVersion	%ClassName
%ConstructClone	%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty
%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty
%Extends	%GetParameter	%IsA	%IsModified
%New	%NormalizeObject	%ObjectModified	%OriginalNamespace
%PackageName	%QuoteList	%QuoteValue	%QuoteValueL10N
%RemoveFromSaveSet	%SerializeObject	%SetModified	%Validate
%ValidateObject	XMLDTD	XMLExport	XMLExportToStream
XMLExportToString	XMLNew	XMLSchema	XMLSchemaNamespace
XMLSchemaType

Parameters

• parameter XMLNAME = "files";

This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.

Properties

• property encoding as %String(XMLPROJECTION="attribute");

The encoding to use when processing files in this location. (Note that this is actually a parameter of the File Processor %iKnow.Source.File.Processor)

• property extensions as %String(MAXLEN=1000,XMLPROJECTION="attribute");

Which file extensions to consider. Leave empty to load all files.

• property filterCondition as %String(MAXLEN=1000,XMLPROJECTION="attribute");

If set, this COS expression is called using xecute command for every file discovered by the File Lister. If it returns false, the file is skipped.

• property listerClass as %String(MAXLEN=250,XMLPROJECTION="attribute") [ InitialExpression = "%iKnow.Source.File.Lister",ReadOnly ];

The Lister class to use for loading data defined in this list element. This class should extend %iKnow.Source.Lister. The Lister class defined here dictates the contents of the parameters property.

• property path as %String(MAXLEN=1000,XMLPROJECTION="attribute");

The filesystem path, accessible to this InterSystems IRIS instance, where to load data from.

• property recursive as %Boolean(XMLPROJECTION="attribute");

Whether or not to recurse into subdirecories of path

Class Reference IRIS for UNIX 2024.1.2
Documentation Search