Module: Moab

Defined in:

lib/moab.rb,
lib/moab/bagger.rb,
lib/moab/config.rb,
lib/moab/utc_time.rb,
lib/moab/exceptions.rb,
lib/moab/file_group.rb,
lib/moab/file_instance.rb,
lib/moab/file_inventory.rb,
lib/moab/file_signature.rb,
lib/moab/storage_object.rb,
lib/moab/storage_services.rb,
lib/moab/signature_catalog.rb,
lib/moab/file_manifestation.rb,
lib/moab/storage_repository.rb,
lib/moab/verification_result.rb,
lib/moab/file_group_difference.rb,
lib/moab/storage_object_version.rb,
lib/moab/version_metadata_entry.rb,
lib/moab/signature_catalog_entry.rb,
lib/moab/file_instance_difference.rb,
lib/moab/storage_object_validator.rb,
lib/moab/file_inventory_difference.rb,
lib/moab/file_group_difference_subset.rb

Overview

Note:

Copyright (c) 2012 by The Board of Trustees of the Leland Stanford Junior University. All rights reserved. See LICENSE for details.

Moab is a module that provides a distintive namespace for the collection of classes it contains.

====Data Model

• FileInventory = container for recording information about a collection of related files

  • FileGroup [1..*] = subset allow segregation of content and metadata files
    • FileManifestation [1..*] = snapshot of a file's filesystem characteristics
      • FileSignature [1] = file fixity information
      • FileInstance [1..*] = filepath and timestamp of any physical file having that signature

• SignatureCatalog = lookup table containing a cumulative collection of all files ever ingested

  • SignatureCatalogEntry [1..*] = an row in the lookup table containing storage information about a single file
    • FileSignature [1] = file fixity information

• FileInventoryDifference = compares two FileInventory instances based on file signatures and pathnames

  • FileGroupDifference [1..*] = performs analysis and reports differences between two matching FileGroup objects
    • FileGroupDifferenceSubset [1..5] = collects a set of file-level differences of a give change type
      • FileInstanceDifference [1..*] = contains difference information at the file level
        • FileSignature [1..2] = contains the file signature(s) of two file instances being compared

• StorageObject = represents a digital object's repository storage location and ingest/dissemination methods

  • StorageObjectVersion [1..*] = represents a version subdirectory within an object's home directory
    • Bagger [1] = utility for creating bagit packages for ingest or dissemination

Defined Under Namespace

Classes: Bagger, Configuration, FileGroup, FileGroupDifference, FileGroupDifferenceSubset, FileInstance, FileInstanceDifference, FileInventory, FileInventoryDifference, FileManifestation, FileNotFoundException, FileSignature, InvalidMetadataException, InvalidSuriSyntaxError, MoabRuntimeError, MoabStandardError, ObjectNotFoundException, SignatureCatalog, SignatureCatalogEntry, StorageObject, StorageObjectValidator, StorageObjectVersion, StorageRepository, StorageServices, UtcTime, VerificationResult, VersionMetadataEntry

Constant Summary

DEFAULT_CHECKSUM_TYPES =

%i[md5 sha1 sha256].freeze

Config =

Returns the configuration data.

Returns:

• (Moab::Configuration) —

  the configuration data

Configuration.new