C# Class SILUBS.ScriptureChecks.RepeatedWordsCheck

Check to detect repeated words

Inheritance: IScrCheckInventory

Show file Open project: sillsdev/FieldWorks Class Usage Examples

Public Methods

Method	Description
Check ( IEnumerable toks, RecordErrorHandler record ) : void	Find all repeated words. Ignore any found in 'validItemsList'. Call RecordError delegate whenever any other repeated key is found.
GetReferences ( IEnumerable tokens, string desiredKey ) : List	Gets a list if TextTokenSubstrings conataining the references and character offsets where repeated words occur.
RepeatedWordsCheck ( IChecksDataSource checksDataSource ) : System	Initializes a new instance of the RepeatedWordsCheck class.
Save ( ) : void	Update the parameter values for storing the valid and invalid lists in CheckDataSource and then save them. This is here because the inventory form does not know the names of the parameters that need to be saved for a given check, only the check knows this.

Private Methods

Method	Description
Localize ( string strToLocalize ) : string	Returns a localized version of the specified string.

Method Details

Check() public method

Find all repeated words. Ignore any found in 'validItemsList'. Call RecordError delegate whenever any other repeated key is found.

public Check ( IEnumerable toks, RecordErrorHandler record ) : void
toks	IEnumerable	ITextToken's corresponding to the text to be checked. /// Typically this is one books worth.
record	RecordErrorHandler	Call this delegate to report each error found.
return	void

GetReferences() public method

Gets a list if TextTokenSubstrings conataining the references and character offsets where repeated words occur.

public GetReferences ( IEnumerable tokens, string desiredKey ) : List
tokens	IEnumerable	The tokens (from the data source) to check for repeated words. ///
desiredKey	string
return	List

RepeatedWordsCheck() public method

Initializes a new instance of the RepeatedWordsCheck class.

public RepeatedWordsCheck ( IChecksDataSource checksDataSource ) : System
checksDataSource	IChecksDataSource
return	System

Save() public method

Update the parameter values for storing the valid and invalid lists in CheckDataSource and then save them. This is here because the inventory form does not know the names of the parameters that need to be saved for a given check, only the check knows this.

public Save ( ) : void
return	void