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

Class NTupleOmitPrefixStorageLayoutConfig

java.lang.Object

edu.wisc.library.ocfl.core.extension.storage.layout.config.NTupleOmitPrefixStorageLayoutConfig

All Implemented Interfaces:

OcflExtensionConfig

public class NTupleOmitPrefixStorageLayoutConfig
extends Object
implements OcflExtensionConfig

Configuration for the N Tuple Storage Layout extension.

Since:

2021-10-25

Author:

vcrema

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NTupleOmitPrefixStorageLayoutConfig.ZeroPadding

Constructor Summary

Constructors

Constructor	Description
NTupleOmitPrefixStorageLayoutConfig()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getDelimiter()
String	getExtensionName()	Returns the name of the extension the config is for.
int	getNumberOfTuples()
int	getTupleSize()
NTupleOmitPrefixStorageLayoutConfig.ZeroPadding	getZeroPadding()	return zeroPadding - Indicates whether to use left or right zero padding for ids less than tupleSize * numberOfTuples
int	hashCode()
boolean	hasParameters()	Indicates if the extension defines parameters.
boolean	isReverseObjectRoot()	return true or false, indicates that the prefix-omitted, padded object identifier should be reversed
NTupleOmitPrefixStorageLayoutConfig	setDelimiter(String delimiter)	The case-insensitive, delimiter marking the end of the OCFL object identifier prefix; MUST consist of a character string of length one or greater.
NTupleOmitPrefixStorageLayoutConfig	setNumberOfTuples(int numberOfTuples)	The number of segments to use for path generation
NTupleOmitPrefixStorageLayoutConfig	setReverseObjectRoot(boolean reverseObjectRoot)	indicates that the prefix-omitted, padded object identifier should be reversed
NTupleOmitPrefixStorageLayoutConfig	setTupleSize(int tupleSize)	the segment size (in characters) to split the digest into
NTupleOmitPrefixStorageLayoutConfig	setZeroPadding(NTupleOmitPrefixStorageLayoutConfig.ZeroPadding zeroPadding)	Indicates whether to use left or right zero padding for ids less than tupleSize * numberOfTuples
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

NTupleOmitPrefixStorageLayoutConfig

public NTupleOmitPrefixStorageLayoutConfig()

Method Detail

getExtensionName

public String getExtensionName()

Description copied from interface: OcflExtensionConfig

Returns the name of the extension the config is for.

Specified by:

getExtensionName in interface OcflExtensionConfig

Returns:

extension name

hasParameters

public boolean hasParameters()

Description copied from interface: OcflExtensionConfig

Indicates if the extension defines parameters.

Specified by:

hasParameters in interface OcflExtensionConfig

Returns:

true if the extension defines parameters; false otherwise

getDelimiter

public String getDelimiter()

Returns:

the delimiter marking end of prefix

getTupleSize

public int getTupleSize()

Returns:

tupleSize - the segment size (in characters) to split the digest into

getNumberOfTuples

public int getNumberOfTuples()

Returns:

The number of segments to use for path generation

getZeroPadding

public NTupleOmitPrefixStorageLayoutConfig.ZeroPadding getZeroPadding()

return zeroPadding - Indicates whether to use left or right zero padding for ids less than tupleSize * numberOfTuples

isReverseObjectRoot

public boolean isReverseObjectRoot()

return true or false, indicates that the prefix-omitted, padded object identifier should be reversed

setDelimiter

public NTupleOmitPrefixStorageLayoutConfig setDelimiter(String delimiter)

The case-insensitive, delimiter marking the end of the OCFL object identifier prefix; MUST consist of a character string of length one or greater. If the delimiter is found multiple times in the OCFL object identifier, its last occurrence (right-most) will be used to select the termination of the prefix.

Parameters:

delimiter - marking the end of prefix

setTupleSize

public NTupleOmitPrefixStorageLayoutConfig setTupleSize(int tupleSize)

the segment size (in characters) to split the digest into

Parameters:

tupleSize - - the segment size (in characters) to split the digest into

setNumberOfTuples

public NTupleOmitPrefixStorageLayoutConfig setNumberOfTuples(int numberOfTuples)

The number of segments to use for path generation

Parameters:

numberOfTuples - - The number of segments to use for path generation

setZeroPadding

public NTupleOmitPrefixStorageLayoutConfig setZeroPadding(NTupleOmitPrefixStorageLayoutConfig.ZeroPadding zeroPadding)

Indicates whether to use left or right zero padding for ids less than tupleSize * numberOfTuples

Parameters:

zeroPadding -

setReverseObjectRoot

public NTupleOmitPrefixStorageLayoutConfig setReverseObjectRoot(boolean reverseObjectRoot)

indicates that the prefix-omitted, padded object identifier should be reversed

Parameters:

reverseObjectRoot - - indicates that the prefix-omitted, padded object identifier should be reversed

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object