C# Class InfoPathScraper.Reporting.Report

显示文件 Open project: OfficeDev/PnP-Transformation

Private Properties

Property	Type	Description
ProcessNext	System.Threading.Tasks.Task
PurgeDoneTasks	void
TaskBody	void

Public Methods

Method	Description
AddPath ( string path ) : void	Assumes all AddPath are called before Run(). This is enforced by CommandLineProcessor. If we ever get on a UI where additional files can be added after Run() is called, there will need to be a mechanism to ensure that we don't add after Run() has completed and not run any extra paths.
Report ( ) : System
Run ( ) : void	Simplified version of Run that doesn't do anything concurrent

Protected Methods

Method	Description
OutputTemplate ( Model template ) : string	A string representation of the report for a single template. Deriving classes will collate template.Features in a way that makes sense for the type of report

Private Methods

Method	Description
ProcessNext ( string path ) : System.Threading.Tasks.Task	Create a Task to load and run based on the path
PurgeDoneTasks ( ) : void	We need to remove all completed Tasks, otherwise they'll clog up our queue
TaskBody ( string path ) : void	Create a Task to load and run based on the path

Method Details

AddPath() public method

Assumes all AddPath are called before Run(). This is enforced by CommandLineProcessor. If we ever get on a UI where additional files can be added after Run() is called, there will need to be a mechanism to ensure that we don't add after Run() has completed and not run any extra paths.

public AddPath ( string path ) : void
path	string
return	void

OutputTemplate() protected abstract method

A string representation of the report for a single template. Deriving classes will collate template.Features in a way that makes sense for the type of report

protected abstract OutputTemplate ( Model template ) : string
template	Model
return	string

Report() public method

public Report ( ) : System
return	System

Run() public method

Simplified version of Run that doesn't do anything concurrent

public Run ( ) : void
return	void