Package dev.jcputney.elearning.parser.parsers

Class AiccParser

java.lang.Object

dev.jcputney.elearning.parser.parsers.BaseParser<AiccMetadata,AiccManifest>

dev.jcputney.elearning.parser.parsers.AiccParser

All Implemented Interfaces:

ModuleParser<AiccManifest>

public final class AiccParser
extends BaseParser<AiccMetadata,AiccManifest>

Parses AICC (Aviation Industry CBT Committee) eLearning modules by handling both INI-style and CSV-style files with specific extensions such as .crs, .des, .au, .cst, .ort, and .pre.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AU_EXTENSION	The file extension for the AICC assignable unit file.
static final String	CRS_EXTENSION	The file extension for the AICC course file.
static final String	CST_EXTENSION	The file extension for the AICC course structure file.
static final String	DES_EXTENSION	The file extension for the AICC descriptor file.
static final String	ORT_EXTENSION	The file extension for the AICC objectives relation table file.
static final String	PRE_EXTENSION	The file extension for the AICC prerequisites file.

Fields inherited from class dev.jcputney.elearning.parser.parsers.BaseParser

moduleFileProvider, options, XAPI_JS_FILE, XAPI_SEND_STATEMENT_FILE

Constructor Summary

Constructors

Constructor	Description
AiccParser(FileAccess fileAccess)	Default constructor for the AiccParser class.
AiccParser(FileAccess fileAccess, ParserOptions options)	Constructs an AiccParser with the specified FileAccess instance and parser options.
AiccParser(ModuleFileProvider moduleFileProvider)	Constructs an AiccParser with the specified ModuleFileProvider instance.

Method Summary

Modifier and Type	Method	Description
protected Class<AiccManifest>	getManifestClass()	Returns the class type representing the AICC manifest.
AiccMetadata	parse()	Parses the AICC module components and generates corresponding metadata.
AiccManifest	parseManifest()	Parses the AICC manifest and returns an instance of AiccManifest.
ValidationResult	validate()	Validates the AICC module without fully parsing it.

Methods inherited from class dev.jcputney.elearning.parser.parsers.BaseParser

checkForXapi, getOptions, loadExternalMetadataIntoMetadata, parseManifest, parseXmlToObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CRS_EXTENSION

public static final String CRS_EXTENSION

The file extension for the AICC course file.

See Also:

• Constant Field Values

DES_EXTENSION

public static final String DES_EXTENSION

The file extension for the AICC descriptor file.

See Also:

• Constant Field Values

AU_EXTENSION

public static final String AU_EXTENSION

The file extension for the AICC assignable unit file.

See Also:

• Constant Field Values

CST_EXTENSION

public static final String CST_EXTENSION

The file extension for the AICC course structure file.

See Also:

• Constant Field Values

ORT_EXTENSION

public static final String ORT_EXTENSION

The file extension for the AICC objectives relation table file.

See Also:

• Constant Field Values

PRE_EXTENSION

public static final String PRE_EXTENSION

The file extension for the AICC prerequisites file.

See Also:

• Constant Field Values

Constructor Details

AiccParser

public AiccParser(FileAccess fileAccess)

Default constructor for the AiccParser class.

Parameters:

fileAccess - An instance of FileAccess for reading files.

AiccParser

public AiccParser(FileAccess fileAccess,
 ParserOptions options)

Constructs an AiccParser with the specified FileAccess instance and parser options.

Parameters:

fileAccess - An instance of FileAccess for reading files.

options - The parser options to control validation and calculation behavior.

AiccParser

public AiccParser(ModuleFileProvider moduleFileProvider)

Constructs an AiccParser with the specified ModuleFileProvider instance.

Parameters:

moduleFileProvider - An instance of ModuleFileProvider for reading files in the module package.

Method Details

validate

public ValidationResult validate()

Validates the AICC module without fully parsing it. This method provides efficient validation by only parsing the manifest files and running structural validation checks.

Specified by:

validate in interface ModuleParser<AiccManifest>

Overrides:

validate in class BaseParser<AiccMetadata,AiccManifest>

Returns:

ValidationResult containing any errors or warnings found

parse

public AiccMetadata parse()
                   throws ModuleException

Parses the AICC module components and generates corresponding metadata. This method validates the presence of required data, such as title and launch URL, in the AICC module's course file, and constructs an AiccMetadata instance based on parsed information.

Specified by:

parse in interface ModuleParser<AiccManifest>

Specified by:

parse in class BaseParser<AiccMetadata,AiccManifest>

Returns:

An instance of AiccMetadata containing the parsed metadata for the AICC module.

Throws:

ModuleParsingException - If the module is missing required data, files, or an unexpected error occurs.

ModuleException - If the module type can't be determined or there's an error parsing.

parseManifest

public AiccManifest parseManifest()
                           throws IOException,
ModuleParsingException,
ManifestParseException

Parses the AICC manifest and returns an instance of AiccManifest.

Returns:

An instance of AiccManifest containing parsed data.

Throws:

IOException - If an error occurs while reading files.

ModuleParsingException - If an error occurs during parsing.

ManifestParseException - If an error occurs while parsing the manifest.

getManifestClass

protected Class<AiccManifest> getManifestClass()

Returns the class type representing the AICC manifest.

Specified by:

getManifestClass in class BaseParser<AiccMetadata,AiccManifest>

Returns:

The class type AiccManifest.class.