Home > Class Reference > %SYS namespace > Inventory.FileComponent


persistent class Inventory.FileComponent extends Inventory.Component, Inventory.Hashable

SQL Table Name: Inventory.FileComponent

FileComponent is a subclass of Component. An instance represents an operating system file.

It contains properties representing the file's name, last modified date, size, and a SHA1 hash of the file's contents.

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter XMLNAME = FileComponent;
The element name used in the XML representation of the component.
parameter XMLTYPE = FileComponent;
The identifier used to distinguish the type of this component in the XML representation.

Properties (Including Private)

property DateModified as %TimeStamp;
The last modified date of of the file referenced by this FileComponent.
Property methods: DateModifiedDisplayToLogical(), DateModifiedGet(), DateModifiedGetStored(), DateModifiedIndexExists(), DateModifiedIsValid(), DateModifiedLogicalToDisplay(), DateModifiedLogicalToXSD(), DateModifiedNormalize(), DateModifiedOdbcToLogical(), DateModifiedSet(), DateModifiedXSDToLogical()
property Filename as %String (MAXLEN = 256) [ Required ];
The unqualified filename, i.e., without its directory component, of the file referenced by this FileComponent.
Property methods: FilenameDisplayToLogical(), FilenameGet(), FilenameGetStored(), FilenameIndexExists(), FilenameIsValid(), FilenameLogicalToDisplay(), FilenameLogicalToOdbc(), FilenameNormalize(), FilenameSet()
property Size as %Integer;
The size, in bytes, of the file referenced by this FileComponent.
Property methods: SizeDisplayToLogical(), SizeGet(), SizeGetStored(), SizeIsValid(), SizeLogicalToDisplay(), SizeNormalize(), SizeSet(), SizeXSDToLogical()

Methods (Including Private)

method Init(scan As Scan, fileName As %String) as FileComponent [ Language = objectscript ]
Initializes and saves this FileComponent, recording scan as the Scan property, and scanning fileName for its size, last modified date, and SHA1 hash.

The saved FileComponent is returned.


index (DateModifiedIndex on DateModified);
Index methods: DateModifiedIndexExists()
index (FilenameIndex on Filename);
Index methods: FilenameIndexExists()
index (ScanSHA1HashIndex on Scan,SHA1Hash:Exact);
Index methods: ScanSHA1HashIndexExists()

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)


Gray indicates storage defined by superclasses.

Storage Model: Storage (Inventory.Component)


Storage Model: Storage (Inventory.Component)


Storage Model: Storage (Inventory.FileComponent)