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

Class DefaultModuleTypeDetector

java.lang.Object

dev.jcputney.elearning.parser.impl.detector.DefaultModuleTypeDetector

All Implemented Interfaces:

ModuleTypeDetector

public final class DefaultModuleTypeDetector
extends Object
implements ModuleTypeDetector

Default implementation of the ModuleTypeDetector interface.

This class determines the type of eLearning module based on the files present in the file system. It uses a plugin system where each plugin is responsible for detecting a specific module type. Plugins are called in order of priority until one of them successfully detects a module type.

By default, the following plugins are registered:

1. ScormDetectorPlugin - Detects SCORM 1.2 and SCORM 2004 modules
2. Cmi5DetectorPlugin - Detects cmi5 modules
3. XapiDetectorPlugin - Detects xAPI/TinCan modules
4. AiccDetectorPlugin - Detects AICC modules

Additional plugins can be registered using the registerPlugin(ModuleTypeDetectorPlugin) method.

Constructor Summary

Constructors

Constructor	Description
DefaultModuleTypeDetector(FileAccess fileAccess)	Constructs a new DefaultModuleTypeDetector with the specified FileAccess implementation.

Method Summary

Modifier and Type	Method	Description
ModuleType	detectModuleType()	Detects the type of eLearning module based on the files present in the file system.
List<ModuleTypeDetectorPlugin>	getPlugins()	Returns an unmodifiable list of the registered plugins.
void	registerPlugin(ModuleTypeDetectorPlugin plugin)	Registers a module type detector plugin.
boolean	unregisterPlugin(ModuleTypeDetectorPlugin plugin)	Unregisters a module type detector plugin.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultModuleTypeDetector

public DefaultModuleTypeDetector(FileAccess fileAccess)

Constructs a new DefaultModuleTypeDetector with the specified FileAccess implementation.

Parameters:

fileAccess - the FileAccess implementation to use for accessing module files

Throws:

IllegalArgumentException - if fileAccess is null

Method Details

registerPlugin

public void registerPlugin(ModuleTypeDetectorPlugin plugin)

Registers a module type detector plugin.

Specified by:

registerPlugin in interface ModuleTypeDetector

Parameters:

plugin - the plugin to register

Throws:

IllegalArgumentException - if the plugin is null

unregisterPlugin

public boolean unregisterPlugin(ModuleTypeDetectorPlugin plugin)

Unregisters a module type detector plugin.

Specified by:

unregisterPlugin in interface ModuleTypeDetector

Parameters:

plugin - the plugin to unregister

Returns:

true if the plugin was unregistered, false if it wasn't registered

Throws:

IllegalArgumentException - if the plugin is null

getPlugins

public List<ModuleTypeDetectorPlugin> getPlugins()

Returns an unmodifiable list of the registered plugins.

Specified by:

getPlugins in interface ModuleTypeDetector

Returns:

an unmodifiable list of the registered plugins

detectModuleType

public ModuleType detectModuleType()
                            throws ModuleDetectionException

Detects the type of eLearning module based on the files present in the file system.

This method calls each registered plugin in order of priority until one of them successfully detects a module type.

Specified by:

detectModuleType in interface ModuleTypeDetector

Returns:

the detected ModuleType

Throws:

ModuleDetectionException - if the module type cannot be detected, or if there's an error during the detection process