FileComponent Class Reference

<class>FileComponent</class> is a subclass of <class>Component</class>. More...

Inheritance diagram for FileComponent:

Collaboration diagram for FileComponent:

Public Member Functions
Inventory.FileComponent	Init (Inventory.Scan scan, _.Library.String fileName)
	Initializes and saves this <class>FileComponent</class>, recording scan More...
Public Member Functions inherited from Hashable
	GenerateSHA1Hash (_.Library.String string)
	Generate a base 64 encoded SHA1 hash of string and store it as the <property>SHA1Hash</property> property. More...
	GenerateSHA1HashFromStream (_.Stream.Object stream)
	Generate a base 64 encoded SHA1 hash of the contents of stream and store it as the <property>SHA1Hash</property> property. More...

Public Attributes
	DateModified
	The last modified date of of the file referenced by this <class>FileComponent</class>. More...
	Filename
	The unqualified filename, i.e., without its directory component, of the file referenced by this <class>FileComponent</class>. More...
	Size
	The size, in bytes, of the file referenced by this <class>FileComponent</class>. More...
Public Attributes inherited from Component
	Name
	The name of this component, which distinguishes it from other components of the same type. More...
	ParentComponent
	The parent component of this component. More...
	Scan
	The <class>Scan</class> which found this component. More...
	SubComponents
	The subcomponents of this component. More...
Public Attributes inherited from Hashable
	SHA1Hash
	The SHA1Hash of the object, base 64 encoded. More...

Static Public Attributes
	XMLNAME = None
	<class>FileComponent</class> is a subclass of <class>Component</class>. More...
	XMLTYPE = None
	The identifier used to distinguish the type of this component in the XML representation.
Static Public Attributes inherited from Component
	XMLNAME = None
	The element name used in the XML representation of the component.
	XMLTYPE = None
	The identifier used to distinguish the type of this component in the XML representation.

Detailed Description

<class>FileComponent</class> is a subclass of <class>Component</class>.

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.

Member Function Documentation

Init()

Inventory.FileComponent Init	(	Inventory.Scan	scan,
		_.Library.String	fileName
	)

Initializes and saves this <class>FileComponent</class>, recording scan

as the <property>Scan</property> property, and scanning fileName for its size, last modified date, and SHA1 hash.

The saved <class>FileComponent</class> is returned.

Reimplemented in DatabaseComponent.

Member Data Documentation

XMLNAME

XMLNAME = None

static

<class>FileComponent</class> is a subclass of <class>Component</class>.

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.

The element name used in the XML representation of the component.

DateModified

DateModified

The last modified date of of the file referenced by this <class>FileComponent</class>.

 

Filename

Filename

The unqualified filename, i.e., without its directory component, of the file referenced by this <class>FileComponent</class>.

 

Size

Size

The size, in bytes, of the file referenced by this <class>FileComponent</class>.