Package dev.jcputney.elearning.parser.output.metadata

Class BaseModuleMetadata<M extends PackageManifest>

java.lang.Object

dev.jcputney.elearning.parser.output.ModuleMetadata<M>

dev.jcputney.elearning.parser.output.metadata.BaseModuleMetadata<M>

Type Parameters:

M - The type of package manifest.

All Implemented Interfaces:

PackageManifest, MetadataComponent, Serializable

Direct Known Subclasses:

AiccMetadata, Cmi5Metadata, Scorm12Metadata, Scorm2004Metadata

public abstract class BaseModuleMetadata<M extends PackageManifest>
extends ModuleMetadata<M>
implements MetadataComponent

Base class for module metadata that implements the MetadataComponent interface.

This class serves as a bridge between the old metadata model and the new composite metadata model. It provides the core capability of the old ModuleMetadata class while implementing the new MetadataComponent interface.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected CompositeMetadata	compositeMetadata	The composite metadata component that contains additional metadata.
static final String	DESCRIPTION	The description field of the module metadata.
static final String	DURATION	The duration field of the module metadata.
static final String	IDENTIFIER	The identifier field of the module metadata.
static final String	LAUNCH_URL	The launch URL field of the module metadata.
static final String	MODULE_TYPE	The module type field of the module metadata.
static final String	TITLE	The title field of the module metadata.
static final String	VERSION	The version field of the module metadata.
static final String	XAPI_ENABLED	The xAPI enabled field of the module metadata.

Fields inherited from class dev.jcputney.elearning.parser.output.ModuleMetadata

manifest, moduleEditionType, moduleType, xapiEnabled

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseModuleMetadata(M manifest, ModuleType moduleType, boolean xapiEnabled)	Constructor for BaseModuleMetadata.

Method Summary

Modifier and Type	Method	Description
void	addMetadataComponent(@NonNull MetadataComponent component)	Adds a metadata component to this module's composite metadata.
Optional<Object>	getMetadata(String key)	Gets a metadata value by key.
<T> Optional<T>	getMetadata(String key, Class<T> type)	Gets a metadata value by key, with type conversion.
protected SimpleMetadata	getSimpleMetadata(PackageManifest manifest)	Creates a SimpleMetadata object from the provided PackageManifest.
boolean	hasMetadata(String key)	Checks if this component contains metadata for the given key.

Methods inherited from class dev.jcputney.elearning.parser.output.ModuleMetadata

equals, getDescription, getDuration, getIdentifier, getLaunchUrl, getTitle, getVersion, hashCode

Methods inherited from class java.lang.Object

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

Field Details

TITLE

public static final String TITLE

The title field of the module metadata.

See Also:

• Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

The description field of the module metadata.

See Also:

• Constant Field Values

LAUNCH_URL

public static final String LAUNCH_URL

The launch URL field of the module metadata.

See Also:

• Constant Field Values

IDENTIFIER

public static final String IDENTIFIER

The identifier field of the module metadata.

See Also:

• Constant Field Values

VERSION

public static final String VERSION

The version field of the module metadata.

See Also:

• Constant Field Values

DURATION

public static final String DURATION

The duration field of the module metadata.

See Also:

• Constant Field Values

MODULE_TYPE

public static final String MODULE_TYPE

The module type field of the module metadata.

See Also:

• Constant Field Values

XAPI_ENABLED

public static final String XAPI_ENABLED

The xAPI enabled field of the module metadata.

See Also:

• Constant Field Values

compositeMetadata

protected CompositeMetadata compositeMetadata

The composite metadata component that contains additional metadata.

Constructor Details

BaseModuleMetadata

protected BaseModuleMetadata(M manifest,
 ModuleType moduleType,
 boolean xapiEnabled)

Constructor for BaseModuleMetadata.

Parameters:

manifest - The package manifest.

moduleType - The module type.

xapiEnabled - Whether xAPI is enabled.

Method Details

addMetadataComponent

public void addMetadataComponent(@NonNull
 @NonNull MetadataComponent component)

Adds a metadata component to this module's composite metadata.

Parameters:

component - The component to add.

getMetadata

public Optional<Object> getMetadata(String key)

Description copied from interface: MetadataComponent

Gets a metadata value by key.

Specified by:

getMetadata in interface MetadataComponent

Parameters:

key - The key to look up.

Returns:

An Optional containing the value if found, or empty if not found.

getMetadata

public <T> Optional<T> getMetadata(String key,
 Class<T> type)

Description copied from interface: MetadataComponent

Gets a metadata value by key, with type conversion.

Specified by:

getMetadata in interface MetadataComponent

Type Parameters:

T - The type to convert the value to.

Parameters:

key - The key to look up.

type - The class to convert the value to.

Returns:

An Optional containing the converted value if found, or empty if not found.

hasMetadata

public boolean hasMetadata(String key)

Description copied from interface: MetadataComponent

Checks if this component contains metadata for the given key.

Specified by:

hasMetadata in interface MetadataComponent

Parameters:

key - The key to check.

Returns:

true if this component contains metadata for the key, false otherwise.

getSimpleMetadata

protected SimpleMetadata getSimpleMetadata(PackageManifest manifest)

Creates a SimpleMetadata object from the provided PackageManifest.

Parameters:

manifest - The package manifest to extract metadata from.

Returns:

A SimpleMetadata object containing the extracted metadata.