Package dev.jcputney.elearning.parser.parsers

Class XapiParser

java.lang.Object

dev.jcputney.elearning.parser.parsers.BaseParser<XapiMetadata,TincanManifest>

dev.jcputney.elearning.parser.parsers.XapiParser

All Implemented Interfaces:

ModuleParser<TincanManifest>

public final class XapiParser
extends BaseParser<XapiMetadata,TincanManifest>

Parser for xAPI/TinCan packages.

Parses the tincan.xml manifest file and creates XapiMetadata containing the module information.

The TinCan manifest format is a simple XML structure containing one or more activities with their launch URLs and metadata.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TINCAN_XML	The name of the TinCan XML file that contains the module metadata.

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

moduleFileProvider, options, XAPI_JS_FILE, XAPI_SEND_STATEMENT_FILE

Constructor Summary

Constructors

Constructor	Description
XapiParser(FileAccess fileAccess)	Constructs an XapiParser with the specified FileAccess instance.
XapiParser(FileAccess fileAccess, ParserOptions options)	Constructs an XapiParser with the specified FileAccess instance and parser options.

Method Summary

Modifier and Type	Method	Description
protected XapiMetadata	extractMetadata(TincanManifest manifest, ValidationResult validation)	Extracts metadata from a parsed and validated manifest.
protected Class<TincanManifest>	getManifestClass()	Returns the class type of the TinCan manifest used by this parser.
protected String	getManifestFileName()	Abstract method to return the filename of the manifest for the specific parser.
protected ValidationResult	validateManifest(TincanManifest manifest)	Validates a parsed manifest and returns validation results.

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

checkForXapi, getModuleType, getOptions, loadExternalMetadataIntoMetadata, parseAndValidate, parseManifest, parseOnly, parseXmlToObject

Methods inherited from class java.lang.Object

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

Field Details

TINCAN_XML

public static final String TINCAN_XML

The name of the TinCan XML file that contains the module metadata.

See Also:

• Constant Field Values

Constructor Details

XapiParser

public XapiParser(FileAccess fileAccess)

Constructs an XapiParser with the specified FileAccess instance.

Parameters:

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

XapiParser

public XapiParser(FileAccess fileAccess,
 ParserOptions options)

Constructs an XapiParser 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

Method Details

validateManifest

protected ValidationResult validateManifest(TincanManifest manifest)

Description copied from class: BaseParser

Validates a parsed manifest and returns validation results. Subclasses implement this to use their parser-specific validators.

Specified by:

validateManifest in class BaseParser<XapiMetadata,TincanManifest>

Parameters:

manifest - The parsed manifest to validate

Returns:

ValidationResult containing any errors or warnings

extractMetadata

protected XapiMetadata extractMetadata(TincanManifest manifest,
 ValidationResult validation)
                                throws ModuleException

Description copied from class: BaseParser

Extracts metadata from a parsed and validated manifest.

Specified by:

extractMetadata in class BaseParser<XapiMetadata,TincanManifest>

Parameters:

manifest - The parsed manifest

validation - The validation result (for reference during extraction)

Returns:

Module-specific metadata

Throws:

ModuleException - if metadata extraction fails

getManifestFileName

protected String getManifestFileName()

Description copied from class: BaseParser

Abstract method to return the filename of the manifest for the specific parser.

Specified by:

getManifestFileName in class BaseParser<XapiMetadata,TincanManifest>

Returns:

The manifest filename (e.g., "imsmanifest.xml", "cmi5.xml")

getManifestClass

protected Class<TincanManifest> getManifestClass()

Returns the class type of the TinCan manifest used by this parser.

Specified by:

getManifestClass in class BaseParser<XapiMetadata,TincanManifest>

Returns:

The Class object representing the TincanManifest type.