%SYS
DatabaseComponent Class Reference

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

Inheritance diagram for DatabaseComponent:
Collaboration diagram for DatabaseComponent:

Public Member Functions

Inventory.DatabaseComponent Init (Inventory.Scan scan, _.Library.String fileName)
 Initializes and saves this <class>DatabaseComponent</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

 DatabaseName
 The name of this database in the installed configuration. More...
 
- Public Attributes inherited from FileComponent
 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>DatabaseComponent</class> is a subclass of <class>FileComponent</class>. More...
 
 XMLTYPE = None
 The identifier used to distinguish the type of this component in the XML representation.
 
- Static Public Attributes inherited from FileComponent
 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.
 

Private Member Functions

_.Library.Status __ScanRoutinesAndClasses ()
 Scan the routines of the database into the SubComponents property of this. More...
 

Static Private Member Functions

_.Library.String __GetDatabaseName (_.Library.String datFile)
 Given a IRIS.DAT file name as datFile, returns the name. More...
 

Detailed Description

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

An instance represents a IRIS.DAT database file.

In addition to the properties of a <class>FileComponent</class>, it also contains the name of the database and the database's routines as subcomponents.

Member Function Documentation

◆ __GetDatabaseName()

_.Library.String __GetDatabaseName ( _.Library.String  datFile)
staticprivate

Given a IRIS.DAT file name as datFile, returns the name.

of the corresponding database in the active configuration, or the empty string if there is no such database.

◆ Init()

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

as the <property>Scan</property> property, and scanning fileName for its <property>DatabaseName</property> and routines.

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

Reimplemented from FileComponent.

◆ __ScanRoutinesAndClasses()

_.Library.Status __ScanRoutinesAndClasses ( )
private

Scan the routines of the database into the SubComponents property of this.

<class>DatabaseComponent</class>. If the database is not the manager's database, then system routines are skipped.

Member Data Documentation

◆ XMLNAME

XMLNAME = None
static

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

An instance represents a IRIS.DAT database file.

In addition to the properties of a <class>FileComponent</class>, it also contains the name of the database and the database's routines as subcomponents.

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

◆ DatabaseName

DatabaseName

The name of this database in the installed configuration.