Package edu.wisc.library.ocfl.core.model

Class InventoryBuilder

java.lang.Object

edu.wisc.library.ocfl.core.model.InventoryBuilder

public class InventoryBuilder
extends Object

Used to construct Inventory objects.

Constructor Summary

Constructors

Constructor	Description
InventoryBuilder()
InventoryBuilder(Inventory original)	Used to construct a new Inventory that's based on an existing inventory.

Method Summary

Modifier and Type	Method	Description
InventoryBuilder	addFileToManifest(String id, String contentPath)	Adds a file to the manifest
InventoryBuilder	addFixityForFile(String contentPath, DigestAlgorithm algorithm, String value)	Adds a file to the fixity block
InventoryBuilder	addHeadVersion(Version version)	Add the version as the new HEAD version.
Inventory	build()
InventoryBuilder	clearFixity()	Removes all of the entries from the fixity block.
boolean	containsContentPath(String contentPath)	Indicates if the manifest contains a contentPath
boolean	containsFileId(String fileId)	Indicates if the manifest contains a fileId
InventoryBuilder	contentDirectory(String contentDirectory)
InventoryBuilder	digestAlgorithm(DigestAlgorithm digestAlgorithm)
InventoryBuilder	fixity(Map<DigestAlgorithm,Map<String,Set<String>>> fixity)
InventoryBuilder	fixityBiMap(Map<DigestAlgorithm,PathBiMap> fixity)
Set<String>	getContentPaths(String fileId)	Retrieves the content paths associated to the fileId or an empty set
String	getFileFixity(String fileId, DigestAlgorithm algorithm)	Returns the fixity digest for a file or null
String	getFileId(String contentPath)	Retrieves the fileId associated to the content path
boolean	hasMutableHead()
InventoryBuilder	head(VersionNum head)
InventoryBuilder	id(String id)
InventoryBuilder	inventoryDigest(String inventoryDigest)
InventoryBuilder	manifest(PathBiMap manifest)
InventoryBuilder	manifest(Map<String,Set<String>> manifest)
InventoryBuilder	mutableHead(boolean mutableHead)
InventoryBuilder	objectRootPath(String objectRootPath)
InventoryBuilder	previousDigest(String previousDigest)
InventoryBuilder	putVersion(VersionNum versionNum, Version version)	Inserts a version at the specified version number.
InventoryBuilder	removeContentPath(String contentPath)	Removes a file from the manifest and fixity bock by content path
InventoryBuilder	removeContentPathFromFixity(String contentPath)	Removes a file from the fixity block by content path
InventoryBuilder	removeFileId(String fileId)	Removes a file from the manifest and fixity block
InventoryBuilder	revisionNum(RevisionNum revisionNum)
InventoryBuilder	type(InventoryType type)
InventoryBuilder	versions(Map<VersionNum,Version> versions)

Methods inherited from class java.lang.Object

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

Constructor Detail

InventoryBuilder

public InventoryBuilder()

InventoryBuilder

public InventoryBuilder(Inventory original)

Used to construct a new Inventory that's based on an existing inventory. This should be used when creating a new version of an existing object.

Parameters:

original - the original inventory

Method Detail

addHeadVersion

public InventoryBuilder addHeadVersion(Version version)

Add the version as the new HEAD version. This assigns the version the next available version number, unless it's mutable.

Parameters:

version - the new version

Returns:

builder

putVersion

public InventoryBuilder putVersion(VersionNum versionNum,
                                   Version version)

Inserts a version at the specified version number. This will OVERWRITE any version that is currently at that location.

Parameters:

versionNum - the id of the version

version - the version

Returns:

builder

addFileToManifest

public InventoryBuilder addFileToManifest(String id,
                                          String contentPath)

Adds a file to the manifest

Parameters:

id - the fileId of the file

contentPath - the content path of the file

Returns:

builder

removeFileId

public InventoryBuilder removeFileId(String fileId)

Removes a file from the manifest and fixity block

Parameters:

fileId - the fileId of the file

Returns:

builder

removeContentPath

public InventoryBuilder removeContentPath(String contentPath)

Removes a file from the manifest and fixity bock by content path

Parameters:

contentPath - the content path of the file to remove

Returns:

builder

removeContentPathFromFixity

public InventoryBuilder removeContentPathFromFixity(String contentPath)

Removes a file from the fixity block by content path

Parameters:

contentPath - the content path of the file to remove

Returns:

builder

addFixityForFile

public InventoryBuilder addFixityForFile(String contentPath,
                                         DigestAlgorithm algorithm,
                                         String value)

Adds a file to the fixity block

Parameters:

contentPath - the content path of the file

algorithm - digest algorithm

value - digest value

Returns:

builder

clearFixity

public InventoryBuilder clearFixity()

Removes all of the entries from the fixity block.

Returns:

builder

id

public InventoryBuilder id(String id)

type

public InventoryBuilder type(InventoryType type)

digestAlgorithm

public InventoryBuilder digestAlgorithm(DigestAlgorithm digestAlgorithm)

head

public InventoryBuilder head(VersionNum head)

contentDirectory

public InventoryBuilder contentDirectory(String contentDirectory)

fixityBiMap

public InventoryBuilder fixityBiMap(Map<DigestAlgorithm,PathBiMap> fixity)

fixity

public InventoryBuilder fixity(Map<DigestAlgorithm,Map<String,Set<String>>> fixity)

manifest

public InventoryBuilder manifest(PathBiMap manifest)

manifest

public InventoryBuilder manifest(Map<String,Set<String>> manifest)

versions

public InventoryBuilder versions(Map<VersionNum,Version> versions)

mutableHead

public InventoryBuilder mutableHead(boolean mutableHead)

revisionNum

public InventoryBuilder revisionNum(RevisionNum revisionNum)

objectRootPath

public InventoryBuilder objectRootPath(String objectRootPath)

previousDigest

public InventoryBuilder previousDigest(String previousDigest)

inventoryDigest

public InventoryBuilder inventoryDigest(String inventoryDigest)

build

public Inventory build()

Returns:

a new Inventory

containsFileId

public boolean containsFileId(String fileId)

Indicates if the manifest contains a fileId

Parameters:

fileId - the fileId

Returns:

true if the manifest contains the fileId

containsContentPath

public boolean containsContentPath(String contentPath)

Indicates if the manifest contains a contentPath

Parameters:

contentPath - the contentPath

Returns:

true if the manifest contains the contentPath

getContentPaths

public Set<String> getContentPaths(String fileId)

Retrieves the content paths associated to the fileId or an empty set

Parameters:

fileId - the fileId

Returns:

associated content paths or an empty set

getFileId

public String getFileId(String contentPath)

Retrieves the fileId associated to the content path

Parameters:

contentPath - the contentPath

Returns:

associated fileId or null

hasMutableHead

public boolean hasMutableHead()

getFileFixity

public String getFileFixity(String fileId,
                            DigestAlgorithm algorithm)

Returns the fixity digest for a file or null

Parameters:

fileId - the fileId

algorithm - the digest algorithm

Returns:

digest or null