Home > Class Reference > %SYS namespace > %iKnow.Model.listFiles

%iKnow.Model.listFiles

class %iKnow.Model.listFiles extends %iKnow.Model.list

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.

Property Inventory

Parameters

parameter XMLNAME = files;
Inherited description: 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 methods: encodingDisplayToLogical(), encodingGet(), encodingIsValid(), encodingLogicalToDisplay(), encodingLogicalToOdbc(), encodingNormalize(), encodingSet()
property extensions as %String (MAXLEN = 1000, XMLPROJECTION = "attribute");
Which file extensions to consider. Leave empty to load all files.
Property methods: extensionsDisplayToLogical(), extensionsGet(), extensionsIsValid(), extensionsLogicalToDisplay(), extensionsLogicalToOdbc(), extensionsNormalize(), extensionsSet()
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 methods: filterConditionDisplayToLogical(), filterConditionGet(), filterConditionIsValid(), filterConditionLogicalToDisplay(), filterConditionLogicalToOdbc(), filterConditionNormalize(), filterConditionSet()
property listerClass as %String (MAXLEN = 250, XMLPROJECTION = "attribute") [ InitialExpression = "%iKnow.Source.File.Lister" , ReadOnly ];
Inherited description: 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 methods: listerClassDisplayToLogical(), listerClassGet(), listerClassIsValid(), listerClassLogicalToDisplay(), listerClassLogicalToOdbc(), listerClassNormalize(), listerClassSet()
property path as %String (MAXLEN = 1000, XMLPROJECTION = "attribute");
The filesystem path, accessible to this Caché instance, where to load data from.
Property methods: pathDisplayToLogical(), pathGet(), pathIsValid(), pathLogicalToDisplay(), pathLogicalToOdbc(), pathNormalize(), pathSet()
property recursive as %Boolean (XMLPROJECTION = "attribute");
Whether or not to recurse into subdirecories of path
Property methods: recursiveDisplayToLogical(), recursiveGet(), recursiveIsValid(), recursiveLogicalToDisplay(), recursiveLogicalToXSD(), recursiveNormalize(), recursiveSet(), recursiveXSDToLogical()

Inherited Members

Inherited Properties

Inherited Methods