Package edu.wisc.library.ocfl.core.validation

Class InventoryValidator

java.lang.Object

edu.wisc.library.ocfl.core.validation.InventoryValidator

public final class InventoryValidator
extends Object

Validates that an Inventory meets the minimum requirements to be serialized as valid OCFL inventory.

Method Summary

Modifier and Type	Method	Description
static void	validateCompatibleInventories(Inventory currentInventory, Inventory previousInventory)	Validates that the currentInventory is a valid next inventory state from the previousInventory.
static Inventory	validateDeep(Inventory inventory)	Validates the entire Inventory.
static Inventory	validateShallow(Inventory inventory)	Validates that an Inventory meets the minimum requirements to be serialized as valid OCFL inventory.
static void	validateVersionStates(Inventory currentInventory, Inventory previousInventory)	Validates that the two inventories contain the same version states, excluding the version in the current that is not in the previous.

Methods inherited from class java.lang.Object

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

Method Detail

validateShallow

public static Inventory validateShallow(Inventory inventory)

Validates that an Inventory meets the minimum requirements to be serialized as valid OCFL inventory. Only the HEAD version is validated.

Parameters:

inventory - the inventory to validate

Returns:

the same inventory

Throws:

InvalidInventoryException - when validation fails

validateDeep

public static Inventory validateDeep(Inventory inventory)

Validates the entire Inventory. This is VERY SLOW.

Parameters:

inventory - the inventory to validate

Returns:

the same inventory

Throws:

InvalidInventoryException - when validation fails

validateVersionStates

public static void validateVersionStates(Inventory currentInventory,
                                         Inventory previousInventory)

Validates that the two inventories contain the same version states, excluding the version in the current that is not in the previous.

Parameters:

currentInventory - current inventory

previousInventory - inventory immediately prior to the current inventory

validateCompatibleInventories

public static void validateCompatibleInventories(Inventory currentInventory,
                                                 Inventory previousInventory)

Validates that the currentInventory is a valid next inventory state from the previousInventory. The must have the same id, type, digestAlgorithm, and contentDirectory values. Additionally, the currentInventory must be one version later than the previous, and all of the versions they have in common must be identical.

Parameters:

currentInventory - current inventory

previousInventory - inventory immediately prior to the current inventory