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

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

Method Inventory

Parameters

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

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

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.

Indexes

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

Inherited Methods

Storage

Gray indicates storage defined by superclasses.

Storage Model: Storage (Inventory.Component)

^SYS("Inventory","ComponentD")(ID)
=
%%CLASSNAME
Name
ParentComponent
Scan

Storage Model: Storage (Inventory.Component)

^SYS("Inventory","ComponentD")(ID,"SubComponents",n)
=
SubComponents(n)

Storage Model: Storage (Inventory.FileComponent)

^SYS("Inventory","ComponentD")(ID,"FileComponent")
=
SHA1Hash
DateModified
Filename
Size

Subclasses

FeedbackOpens in a new window