Module html.Writer.TemplateData.FileSystemEntry
Info:
- Copyright: 2020 wesen
- Release: 0.1
- License: MIT
- Author: wesen
Class FileSystemEntry
| FileSystemEntry.fileSystemEntryCoverageData | The raw FileSystemEntry coverage data |
| FileSystemEntry.rootDirectoryTemplateData | The template data of the root directory This is used to calculate the relative path to the root directory |
| FileSystemEntry.outputPathGenerator | The output path generator |
| FileSystemEntry.templateDataFactory | The TemplateData factory |
| FileSystemEntry:new (_fileSystemEntryCoverageData, _rootDirectoryTemplateData, _outputPathGenerator, _templateDataFactory) | FileSystemEntry constructor. |
| FileSystemEntry:getFileSystemEntryCoverageData () | Returns the raw FileSystemEntry coverage data. |
| FileSystemEntry:toTemplateValues () | Generates and returns a regular table that contains all template data that is required to visualize the raw FileSystemEntry coverage data. |
| FileSystemEntry:getRelativePathToRoot () | Returns the relative path from the file system entry to the root directory. |
| FileSystemEntry:getRelativePathFrom (_fileSystemEntryTemplateData, _includeBaseName) | Returns the relative path from another file system entry to this file system entry. |
| FileSystemEntry:getReportTargetName () | Returns the report target name. |
| FileSystemEntry:getPathPartTemplateDataObjects () | Returns the Directory template data objects for all path parts of the file system entry including the root directory. |
| FileSystemEntry:getBaseName () | Returns the base name of the file system entry. |
| FileSystemEntry:getHitMissStatistics () | Returns the hit/miss statistics of the file system entry. |
| FileSystemEntry:generatePathPartTemplateValues () | Generates and returns a regular table that contains all data that is required to visualize the path parts. |
Class FileSystemEntry
Base class for coverages of file system entries (directories or files).
- FileSystemEntry.fileSystemEntryCoverageData
-
The raw FileSystemEntry coverage data
- fileSystemEntryCoverageData CoverageData.FileSystemEntry
- FileSystemEntry.rootDirectoryTemplateData
-
The template data of the root directory
This is used to calculate the relative path to the root directory
- rootDirectoryTemplateData Directory
- FileSystemEntry.outputPathGenerator
-
The output path generator
- outputPathGenerator OutputPathGenerator
- FileSystemEntry.templateDataFactory
-
The TemplateData factory
- templateDataFactory TemplateDataFactory
- FileSystemEntry:new (_fileSystemEntryCoverageData, _rootDirectoryTemplateData, _outputPathGenerator, _templateDataFactory)
-
FileSystemEntry constructor.
Parameters:
- _fileSystemEntryCoverageData CoverageData.FileSystemEntry The raw FileSystemEntry coverage data
- _rootDirectoryTemplateData Directory The template data of the root directory
- _outputPathGenerator OutputPathGenerator The output path generator
- _templateDataFactory TemplateDataFactory The TemplateData factory
- FileSystemEntry:getFileSystemEntryCoverageData ()
-
Returns the raw FileSystemEntry coverage data.
Returns:
-
CoverageData.FileSystemEntry
The raw FileSystemEntry coverage data
- FileSystemEntry:toTemplateValues ()
-
Generates and returns a regular table that contains all template data that is required to
visualize the raw FileSystemEntry coverage data.
Returns:
-
table
The template values
- FileSystemEntry:getRelativePathToRoot ()
-
Returns the relative path from the file system entry to the root directory.
Returns:
-
string
The relative path to the root directory
- FileSystemEntry:getRelativePathFrom (_fileSystemEntryTemplateData, _includeBaseName)
-
Returns the relative path from another file system entry to this file system entry.
Parameters:
- _fileSystemEntryTemplateData FileSystemEntry The other file system entry
- _includeBaseName bool True to include the base name in the relative path, false otherwise
Returns:
-
string
The relative path from the other file system entry to this file system entry
- FileSystemEntry:getReportTargetName ()
-
Returns the report target name.
This is an abstract method that must be implemented by child classes.
Returns:
-
string
The report target name
- FileSystemEntry:getPathPartTemplateDataObjects ()
-
Returns the Directory template data objects for all path parts of the file system entry
including the root directory.
Returns:
-
Directory[]
The Directory template data objects for all path parts
- FileSystemEntry:getBaseName ()
-
Returns the base name of the file system entry.
Returns:
-
string
The base name
- FileSystemEntry:getHitMissStatistics ()
-
Returns the hit/miss statistics of the file system entry.
Returns:
-
HitMissStatistics
The hit/miss statistics
- FileSystemEntry:generatePathPartTemplateValues ()
-
Generates and returns a regular table that contains all data that is required
to visualize the path parts.
Returns:
-
table[]
The template values