C# Class SILUBS.ScriptureChecks.CharactersCheck

Checks all characters to see if they are valid

Inheritance: IScrCheckInventory

Mostrar archivo Open project: sillsdev/FieldWorks Class Usage Examples

Public Methods

Method	Description
CharactersCheck ( IChecksDataSource _checksDataSource ) : System	Initializes a new instance of the CharactersCheck class.
Check ( IEnumerable toks, RecordErrorHandler record ) : void	Runs the Characters Scripture checks.
GetReferences ( IEnumerable tokens, string desiredKey ) : List	Get (invalid) character references.
InventoryTokens ( int bookNum, TextInventory inventory, IEnumerable tokens ) : void	Creates an inventory of the tokens.
ParseCharacterSequences ( string text ) : IEnumerable	Parses a string into character sequences.
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
GetParameters ( ) : void	Gets the parameters needed for this check.
GetReferences ( IEnumerable tokens, string desiredKey, bool invalidCharactersOnly ) : List	Get (invalid) character references.
GetValidCharacters ( string locale ) : string	Gets the valid characters list for the specified locale.
SetDefaultValidItems ( ) : void	Sets the list of default valid items.
StringToDictionary ( string value ) : bool>.Dictionary	Converts a string to a dictionary

Method Details

CharactersCheck() public method

Initializes a new instance of the CharactersCheck class.

public CharactersCheck ( IChecksDataSource _checksDataSource ) : System
_checksDataSource	IChecksDataSource
return	System

Check() public method

Runs the Characters Scripture checks.

public Check ( IEnumerable toks, RecordErrorHandler record ) : void
toks	IEnumerable	The Scripture tokens to check.
record	RecordErrorHandler	Method to record the error.
return	void

GetReferences() public method

Get (invalid) character references.

public GetReferences ( IEnumerable tokens, string desiredKey ) : List
tokens	IEnumerable
desiredKey	string
return	List

InventoryTokens() public method

Creates an inventory of the tokens.

public InventoryTokens ( int bookNum, TextInventory inventory, IEnumerable tokens ) : void
bookNum	int	The book number.
inventory	TextInventory	The inventory.
tokens	IEnumerable	The tokens.
return	void

ParseCharacterSequences() public method

Parses a string into character sequences.

public ParseCharacterSequences ( string text ) : IEnumerable
text	string
return	IEnumerable

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