# Module: languageParsing

Contains all of the business rule functions for processing of different language related text and characters.

Author:
  - Seth Hollingsead
Copyright:
  - Copyright © 2024-… by Seth Hollingsead. All rights reserved
Source:
  - businessRules/rules/languageParsing.js, line 1

### Requires

- module:ruleParsing
- module:loggers
- module:data
- @haystacks/constants
- path

### Methods

#### (inner) getChineseSimplifiedAlphabet(inputData, inputMetaData) → {string}

A simple function to return either upper case, lower case, or mixed case letters and special characters of the ChineseSimplified Alphabet.

##### Parameters:

Name | Type | Description
--- | --- | ---
`inputData` | string | Case sensitivity, UPPER CASE, or lowercase. if an empty string is provided or the language does not support upper or lower case, then combined case is used.
`inputMetaData` | string | Not used for this business rule.

Author:
  - Seth Hollingsead
Source:
  - businessRules/rules/languageParsing.js, line 108

##### Returns:

The string of special alphabetic characters for a given language.

Type
  string

#### (inner) getChineseTraditionalAlphabet(inputData, inputMetaData) → {string}

A simple function to return either upper case, lower case, or mixed case letters and special characters of the ChineseTraditional Alphabet.

##### Parameters:

Name | Type | Description
--- | --- | ---
`inputData` | string | Case sensitivity, UPPER CASE, or lowercase. if an empty string is provided or the language does not support upper or lower case, then combined case is used.
`inputMetaData` | string | Not used for this business rule.

Author:
  - Seth Hollingsead
Source:
  - businessRules/rules/languageParsing.js, line 130

##### Returns:

The string of special alphabetic characters for a given language.

Type
  string

#### (inner) getCzechAlphabet(inputData, inputMetaData) → {string}

A simple function to return either upper case, lower case, or mixed case letters and special characters of the Czech Alphabet.

##### Parameters:

Name | Type | Description
--- | --- | ---
`inputData` | string | Case sensitivity, UPPER CASE, or lowercase. if an empty string is provided or the language does not support upper or lower case, then combined case is used.
`inputMetaData` | string | Not used for this business rule.

Author:
  - Seth Hollingsead
Source:
  - businessRules/rules/languageParsing.js, line 152

##### Returns:

The string of special alphabetic characters for a given language.

Type
  string

#### (inner) getEnglishAlphabet(inputData, inputMetaData) → {string}

A simple function to return either upper case, lower case, or mixed case letters and special characters of the English Alphabet.

##### Parameters:

Name | Type | Description
--- | --- | ---
`inputData` | string | Case sensitivity, UPPER CASE, or lowercase. if an empty string is provided or the language does not support upper or lower case, then combined case is used.
`inputMetaData` | string | Not used for this business rule.

Author:
  - Seth Hollingsead
Source:
  - businessRules/rules/languageParsing.js, line 80

##### Returns:

The string of special alphabetic characters for a given language.

Type
  string

#### (inner) getFrenchAlphabet(inputData, inputMetaData) → {string}

A simple function to return either upper case, lower case, or mixed case letters and special characters of the French Alphabet.

##### Parameters:

Name | Type | Description
--- | --- | ---
`inputData` | string | Case sensitivity, UPPER CASE, or lowercase. if an empty string is provided or the language does not support upper or lower case, then combined case is used.
`inputMetaData` | string | Not used for this business rule.

Author:
  - Seth Hollingsead
Source:
  - businessRules/rules/languageParsing.js, line 180

##### Returns:

The string of special alphabetic characters for a given language.

Type
  string

#### (inner) getGermanAlphabet(inputData, inputMetaData) → {string}

A simple function to return either upper case, lower case, or mixed case letters and special characters of the German Alphabet.

##### Parameters:

Name | Type | Description
--- | --- | ---
`inputData` | string | Case sensitivity, UPPER CASE, or lowercase. if an empty string is provided or the language does not support upper or lower case, then combined case is used.
`inputMetaData` | string | Not used for this business rule.

Author:
  - Seth Hollingsead
Source:
  - businessRules/rules/languageParsing.js, line 208

##### Returns:

The string of special alphabetic characters for a given language.

Type
  string

#### (inner) getHungarianAlphabet(inputData, inputMetaData) → {string}

A simple function to return either upper case, lower case, or mixed case letters and special characters of the Hungarian Alphabet.

##### Parameters:

Name | Type | Description
--- | --- | ---
`inputData` | string | Case sensitivity, UPPER CASE, or lowercase. if an empty string is provided or the language does not support upper or lower case, then combined case is used.
`inputMetaData` | string | Not used for this business rule.

Author:
  - Seth Hollingsead
Source:
  - businessRules/rules/languageParsing.js, line 236

##### Returns:

The string of special alphabetic characters for a given language.

Type
  string

#### (inner) getItalianAlphabet(inputData, inputMetaData) → {string}

A simple function to return either upper case, lower case, or mixed case letters and special characters of the Italian Alphabet.

##### Parameters:

Name | Type | Description
--- | --- | ---
`inputData` | string | Case sensitivity, UPPER CASE, or lowercase. if an empty string is provided or the language does not support upper or lower case, then combined case is used.
`inputMetaData` | string | Not used for this business rule.

Author:
  - Seth Hollingsead
Source:
  - businessRules/rules/languageParsing.js, line 264

##### Returns:

The string of special alphabetic characters for a given language.

Type
  string

#### (inner) getJapaneseAlphabet(inputData, inputMetaData) → {string}

A simple function to return either upper case, lower case, or mixed case letters and special characters of the Japanese Alphabet.

##### Parameters:

Name | Type | Description
--- | --- | ---
`inputData` | string | Case sensitivity, UPPER CASE, or lowercase. if an empty string is provided or the language does not support upper or lower case, then combined case is used.
`inputMetaData` | string | Not used for this business rule.

Author:
  - Seth Hollingsead
Source:
  - businessRules/rules/languageParsing.js, line 292

##### Returns:

The string of special alphabetic characters for a given language.

Type
  string

#### (inner) getKoreanAlphabet(inputData, inputMetaData) → {string}

A simple function to return either upper case, lower case, or mixed case letters and special characters of the Korean Alphabet.

##### Parameters:

Name | Type | Description
--- | --- | ---
`inputData` | string | Case sensitivity, UPPER CASE, or lowercase. if an empty string is provided or the language does not support upper or lower case, then combined case is used.
`inputMetaData` | string | Not used for this business rule.

Author:
  - Seth Hollingsead
Source:
  - businessRules/rules/languageParsing.js, line 314

##### Returns:

The string of special alphabetic characters for a given language.

Type
  string

#### (inner) getMiscellaneousAlphabet(inputData, inputMetaData) → {string}

A simple function to return either upper case, lower case, or mixed case letters and special characters of the Miscellaneous Alphabet.

##### Parameters:

Name | Type | Description
--- | --- | ---
`inputData` | string | Case sensitivity, UPPER CASE, or lowercase. if an empty string is provided or the language does not support upper or lower case, then combined case is used.
`inputMetaData` | string | Not used for this business rule.

Author:
  - Seth Hollingsead
Source:
  - businessRules/rules/languageParsing.js, line 342

##### Returns:

The string of special alphabetic characters for a given language.

Type
  string

#### (inner) getPolishAlphabet(inputData, inputMetaData) → {string}

A simple function to return either upper case, lower case, or mixed case letters and special characters of the Polish Alphabet.

##### Parameters:

Name | Type | Description
--- | --- | ---
`inputData` | string | Case sensitivity, UPPER CASE, or lowercase. if an empty string is provided or the language does not support upper or lower case, then combined case is used.
`inputMetaData` | string | Not used for this business rule.

Author:
  - Seth Hollingsead
Source:
  - businessRules/rules/languageParsing.js, line 364

##### Returns:

The string of special alphabetic characters for a given language.

Type
  string

#### (inner) getPortugueseAlphabet(inputData, inputMetaData) → {string}

A simple function to return either upper case, lower case, or mixed case letters and special characters of the Portuguese Alphabet.

##### Parameters:

Name | Type | Description
--- | --- | ---
`inputData` | string | Case sensitivity, UPPER CASE, or lowercase. if an empty string is provided or the language does not support upper or lower case, then combined case is used.
`inputMetaData` | string | Not used for this business rule.

Author:
  - Seth Hollingsead
Source:
  - businessRules/rules/languageParsing.js, line 392

##### Returns:

The string of special alphabetic characters for a given language.

Type
  string

#### (inner) getRussianAlphabet(inputData, inputMetaData) → {string}

A simple function to return either upper case, lower case, or mixed case letters and special characters of the Russian Alphabet.

##### Parameters:

Name | Type | Description
--- | --- | ---
`inputData` | string | Case sensitivity, UPPER CASE, or lowercase. if an empty string is provided or the language does not support upper or lower case, then combined case is used.
`inputMetaData` | string | Not used for this business rule.

Author:
  - Seth Hollingsead
Source:
  - businessRules/rules/languageParsing.js, line 420

##### Returns:

The string of special alphabetic characters for a given language.

Type
  string

#### (inner) getSpanishAlphabet(inputData, inputMetaData) → {string}

A simple function to return either upper case, lower case, or mixed case letters and special characters of the Spanish Alphabet.

##### Parameters:

Name | Type | Description
--- | --- | ---
`inputData` | string | Case sensitivity, UPPER CASE, or lowercase. if an empty string is provided or the language does not support upper or lower case, then combined case is used.
`inputMetaData` | string | Not used for this business rule.

Author:
  - Seth Hollingsead
Source:
  - businessRules/rules/languageParsing.js, line 448

##### Returns:

The string of special alphabetic characters for a given language.

Type
  string

#### (inner) languageToAlphabet(inputData, inputMetaData) → {string}

Takes the name of a language and returns the special character alphabet for that language. So an input of Spanish will return: áéíóú¿¡üñ

##### Parameters:

Name | Type | Description
--- | --- | ---
`inputData` | string | The name of the language that it's alphabet of special characters should be returned for.
`inputMetaData` | string | Case sensitivity, UPPER CASE, or lower case.

Author:
  - Seth Hollingsead
Source:
  - businessRules/rules/languageParsing.js, line 28

##### Returns:

The string of special alphabetic characters for a given language.

Type
  string