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 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.

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

moduleFileProvider, XAPI_JS_FILE, XAPI_SEND_STATEMENT_FILE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected Class<AiccManifest>	getManifestClass()	Abstract method to return the class of the manifest object for the specific parser.
AiccMetadata	parse()	Parses the AICC module and returns its metadata.
AiccManifest	parseManifest()	Parses the AICC manifest and returns an instance of AiccManifest.

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

checkForXapi, 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

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(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

parse

public AiccMetadata parse()
                   throws ModuleParsingException

Parses the AICC module and returns its metadata.

Specified by:

parse in interface ModuleParser<AiccManifest>

Specified by:

parse in class BaseParser<AiccMetadata,AiccManifest>

Returns:

A ModuleMetadata object containing the parsed module metadata.

Throws:

ModuleParsingException - 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()

Description copied from class: BaseParser

Abstract method to return the class of the manifest object for the specific parser.

Specified by:

getManifestClass in class BaseParser<AiccMetadata,AiccManifest>

Returns:

The class of the manifest object.