Package edu.wisc.library.ocfl.core.extension.storage.layout

Class FlatLayoutExtension

java.lang.Object

edu.wisc.library.ocfl.core.extension.storage.layout.FlatLayoutExtension

All Implemented Interfaces:

OcflExtension, OcflStorageLayoutExtension

public class FlatLayoutExtension
extends Object
implements OcflStorageLayoutExtension

Implementation of the Flat Storage Layout extension.

See Also:

https://ocfl.github.io/extensions/0002-flat-direct-storage-layout.html

Field Summary

Fields

Modifier and Type	Field	Description
static String	EXTENSION_NAME

Constructor Summary

Constructors

Constructor	Description
FlatLayoutExtension()

Method Summary

Modifier and Type	Method	Description
String	getDescription()
Class<? extends OcflExtensionConfig>	getExtensionConfigClass()	The class that represents the extensions deserialized configuration.
String	getExtensionName()	Returns the name of the extension
void	init(OcflExtensionConfig config)	Configures the extension.
String	mapObjectId(String objectId)	Maps an object id to its path within the OCFL storage root.

Methods inherited from class java.lang.Object

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

Field Detail

EXTENSION_NAME

public static final String EXTENSION_NAME

See Also:

Constant Field Values

Constructor Detail

FlatLayoutExtension

public FlatLayoutExtension()

Method Detail

getExtensionName

public String getExtensionName()

Returns the name of the extension

Specified by:

getExtensionName in interface OcflExtension

Returns:

extension name

getDescription

public String getDescription()

Specified by:

getDescription in interface OcflStorageLayoutExtension

Returns:

the description text that should be used in ocfl_layout.json

init

public void init(OcflExtensionConfig config)

Configures the extension. This method must be called before the extension can be used.

Specified by:

init in interface OcflStorageLayoutExtension

Parameters:

config - extension configuration

getExtensionConfigClass

public Class<? extends OcflExtensionConfig> getExtensionConfigClass()

Description copied from interface: OcflStorageLayoutExtension

The class that represents the extensions deserialized configuration.

Specified by:

getExtensionConfigClass in interface OcflStorageLayoutExtension

Returns:

configuration class

mapObjectId

public String mapObjectId(String objectId)

Maps an object id to its path within the OCFL storage root.

Specified by:

mapObjectId in interface OcflStorageLayoutExtension

Parameters:

objectId - the object id

Returns:

the path to the object root relative to the OCFL storage root