Package dev.jcputney.elearning.parser.impl.detector

Class XapiDetectorPlugin

java.lang.Object

dev.jcputney.elearning.parser.impl.detector.XapiDetectorPlugin

All Implemented Interfaces:

ModuleTypeDetectorPlugin

public class XapiDetectorPlugin
extends Object
implements ModuleTypeDetectorPlugin

Detector plugin for xAPI/TinCan packages.

Detects xAPI modules by looking for the presence of a tincan.xml manifest file in the root directory.

Priority: 40 (after cmi5 which is 50, before SCORM which is 30)

Constructor Summary

Constructors

Constructor	Description
XapiDetectorPlugin()	Constructs a new XapiDetectorPlugin.

Method Summary

Modifier and Type	Method	Description
ModuleType	detect(FileAccess fileAccess)	Detects if the module is an xAPI/TinCan package.
String	getName()	Returns the name of this detector plugin.
int	getPriority()	Returns the priority for this detector.

Methods inherited from class java.lang.Object

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

Constructor Details

XapiDetectorPlugin

public XapiDetectorPlugin()

Constructs a new XapiDetectorPlugin.

Method Details

detect

public ModuleType detect(FileAccess fileAccess)
                  throws ModuleDetectionException

Detects if the module is an xAPI/TinCan package.

Specified by:

detect in interface ModuleTypeDetectorPlugin

Parameters:

fileAccess - the file access interface

Returns:

ModuleType.XAPI if tincan.xml exists, null otherwise

Throws:

ModuleDetectionException - if an error occurs during detection

getPriority

public int getPriority()

Returns the priority for this detector. Higher priority detectors run first.

Specified by:

getPriority in interface ModuleTypeDetectorPlugin

Returns:

40

getName

public String getName()

Returns the name of this detector plugin.

Specified by:

getName in interface ModuleTypeDetectorPlugin

Returns:

"xAPI/TinCan"