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 Class<TincanManifest>	getManifestClass()	Returns the class type of the TinCan manifest used by this parser.
XapiMetadata	parse()	Parses the xAPI/TinCan manifest.
ValidationResult	validate()	Validates the xAPI/TinCan 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

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

validate

public ValidationResult validate()

Validates the xAPI/TinCan 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<TincanManifest>

Overrides:

validate in class BaseParser<XapiMetadata,TincanManifest>

Returns:

ValidationResult containing any errors or warnings found

parse

public XapiMetadata parse()
                   throws ModuleException

Parses the xAPI/TinCan manifest.

Specified by:

parse in interface ModuleParser<TincanManifest>

Specified by:

parse in class BaseParser<XapiMetadata,TincanManifest>

Returns:

the parsed xAPI metadata

Throws:

ModuleParsingException - if parsing fails

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

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.