Package dev.jcputney.elearning.parser.parsers

Class Scorm12Parser

java.lang.Object

dev.jcputney.elearning.parser.parsers.BaseParser<Scorm12Metadata,Scorm12Manifest>

dev.jcputney.elearning.parser.parsers.Scorm12Parser

All Implemented Interfaces:

ModuleParser<Scorm12Manifest>

public final class Scorm12Parser
extends BaseParser<Scorm12Metadata,Scorm12Manifest>

Parses SCORM 1.2 modules by reading the imsmanifest.xml file and extracting core metadata.

This parser extracts key information such as title, description, identifier, launch URL, version, and optional fields like mastery score and custom data, storing them in a standardized ModuleMetadata object.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MANIFEST_FILE	The name of the manifest file for SCORM 1.2 modules.

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

moduleFileProvider, options, XAPI_JS_FILE, XAPI_SEND_STATEMENT_FILE

Constructor Summary

Constructors

Constructor	Description
Scorm12Parser(FileAccess fileAccess)	Constructs a Scorm12Parser with the specified FileAccess instance.
Scorm12Parser(FileAccess fileAccess, ParserOptions options)	Constructs a Scorm12Parser with the specified FileAccess instance and parser options.
Scorm12Parser(ModuleFileProvider moduleFileProvider)	Constructs a Scorm12Parser with the specified ModuleFileProvider instance.

Method Summary

Modifier and Type	Method	Description
protected Class<Scorm12Manifest>	getManifestClass()	Returns the class type of the SCORM 1.2 manifest.
Scorm12Metadata	parse()	Parses the SCORM 1.2 module located at the specified modulePath.
ValidationResult	validate()	Validates the SCORM 1.2 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

MANIFEST_FILE

public static final String MANIFEST_FILE

The name of the manifest file for SCORM 1.2 modules.

See Also:

• Constant Field Values

Constructor Details

Scorm12Parser

public Scorm12Parser(FileAccess fileAccess)

Constructs a Scorm12Parser with the specified FileAccess instance.

Parameters:

fileAccess - An instance of FileAccess for reading files in the module package.

Scorm12Parser

public Scorm12Parser(FileAccess fileAccess,
 ParserOptions options)

Constructs a Scorm12Parser with the specified FileAccess instance and parser options.

Parameters:

fileAccess - An instance of FileAccess for reading files in the module package.

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

Scorm12Parser

public Scorm12Parser(ModuleFileProvider moduleFileProvider)

Constructs a Scorm12Parser 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 SCORM 1.2 module without fully parsing it. This method provides efficient validation by only parsing the manifest file and running structural validation checks.

Specified by:

validate in interface ModuleParser<Scorm12Manifest>

Overrides:

validate in class BaseParser<Scorm12Metadata,Scorm12Manifest>

Returns:

ValidationResult containing any errors or warnings found

parse

public Scorm12Metadata parse()
                      throws ModuleException

Parses the SCORM 1.2 module located at the specified modulePath. Extracts metadata, including title, description, identifier, launch URL, a default version string, and optional fields like mastery score and custom data.

Specified by:

parse in interface ModuleParser<Scorm12Manifest>

Specified by:

parse in class BaseParser<Scorm12Metadata,Scorm12Manifest>

Returns:

A populated ModuleMetadata object containing the extracted metadata.

Throws:

ModuleParsingException - if an error occurs during parsing.

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

getManifestClass

protected Class<Scorm12Manifest> getManifestClass()

Returns the class type of the SCORM 1.2 manifest.

Specified by:

getManifestClass in class BaseParser<Scorm12Metadata,Scorm12Manifest>

Returns:

The class object representing Scorm12Manifest.