Class: Assembly::ContentMetadata

Inherits:
Object
  • Object
show all
Defined in:
lib/assembly-objectfile/content_metadata.rb,
lib/assembly-objectfile/content_metadata/file.rb,
lib/assembly-objectfile/content_metadata/config.rb,
lib/assembly-objectfile/content_metadata/file_set.rb,
lib/assembly-objectfile/content_metadata/file_set_builder.rb,
lib/assembly-objectfile/content_metadata/nokogiri_builder.rb

Overview

This class generates content metadata for image files

Defined Under Namespace

Modules: Types Classes: Config, File, FileSet, FileSetBuilder, NokogiriBuilder

Class Method Summary collapse

Class Method Details

.create_content_metadata(druid:, objects:, auto_labels: true, add_exif: false, bundle: :default, style: :simple_image, add_file_attributes: false, file_attributes: {}, preserve_common_paths: false, flatten_folder_structure: false, include_root_xml: nil, reading_order: 'ltr') ⇒ Object

Generates image content XML metadata for a repository object. This method only produces content metadata for images and does not depend on a specific folder structure. Note that it is class level method.

Example:

Assembly::ContentMetadata.create_content_metadata(:druid=>'druid:nx288wh8889',:style=>:simple_image,:objects=>object_files,:add_file_attributes=>false)

Parameters:

  • params (Hash) —

    a hash containg parameters needed to produce content metadata :druid = required - a string of druid of the repository object’s druid id (with or without ‘druid:’ prefix) :objects = required - an array of Assembly::ObjectFile objects containing the list of files to add to content metadata

    NOTE: if you set the :bundle option to :prebundled, you will need to pass in an array of arrays, and not a flat array, as noted below

    :style = optional - a symbol containing the style of metadata to create, allowed values are

    :simple_image (default), contentMetadata type="image", resource type="image"
:file, contentMetadata type="file", resource type="file"
:simple_book, contentMetadata type="book", resource type="page", but any resource which has file(s) other than an image, and also contains no images at all, will be resource type="object"
:book_with_pdf, contentMetadata type="book", resource type="page", but any resource which has any file(s) other than an image will be resource type="object" - NOTE: THIS IS DEPRECATED
:book_as_image, as simple_book, but with contentMetadata type="book", resource type="image" (same rule applies for resources with non images)  - NOTE: THIS IS DEPRECATED
:map, like simple_image, but with contentMetadata type="map", resource type="image"
:3d, contentMetadata type="3d", ".obj" and other configured 3d extension files go into resource_type="3d", everything else into resource_type="file"
:webarchive-seed, contentMetadata type="webarchive-seed", resource type="image"

    :bundle = optional - a symbol containing the method of bundling files into resources, allowed values are

    :default = all files get their own resources (default)
:filename = files with the same filename but different extensions get bundled together in a single resource
:dpg = files representing the same image but of different mimetype that use the SULAIR DPG filenaming standard (00 vs 05) get bundled together in a single resource
:prebundlded = this option requires you to prebundled the files passed in as an array of arrays, indicating how files are bundlded into resources; this is the most flexible option since it gives you full control

    :add_exif = optional - a boolean to indicate if exif data should be added (mimetype, filesize, image height/width, etc.) to each file, defaults to false and is not required if project goes through assembly :add_file_attributes = optional - a boolean to indicate if publish/preserve/shelve/role attributes should be added using defaults or by supplied override by mime/type, defaults to false and is not required if project goes through assembly :file_attributes = optional - a hash of file attributes by mimetype to use instead of defaults, only used if add_file_attributes is also true,

    If a mimetype match is not found in your hash, the default is used (either your supplied default or the gems).
e.g. {'default'=>{:preserve=>'yes',:shelve=>'yes',:publish=>'yes'},'image/tif'=>{:preserve=>'yes',:shelve=>'no',:publish=>'no'},'application/pdf'=>{:preserve=>'yes',:shelve=>'yes',:publish=>'yes'}}

    :include_root_xml = optional - a boolean to indicate if the contentMetadata returned includes a root <?xml version=“1.0”?> tag, defaults to true :preserve_common_paths = optional - When creating the file “id” attribute, content metadata uses the “relative_path” attribute of the ObjectFile objects passed in. If the “relative_path” attribute is not set, the “path” attribute is used instead,

    which includes a full path to the file. If the "preserve_common_paths" parameter is set to false or left off, then the common paths of all of the ObjectFile's passed in are removed from any "path" attributes.  This should turn full paths into
the relative paths that are required in content metadata file id nodes.  If you do not want this behavior, set "preserve_common_paths" to true.  The default is false.

    :flatten_folder_structure = optional - Will remove all folder structure when genearting file IDs (e.g. DPG subfolders like ‘00’,‘05’ will be removed) when generating file IDs. This is useful if the folder structure is flattened when staging files (like for DPG).

    The default is false.  If set to true, will override the "preserve_common_paths" parameter.

    :auto_labels = optional - Will add automated resource labels (e.g. “File 1”) when labels are not provided by the user. The default is true. See consul.stanford.edu/pages/viewpage.action?spaceKey=chimera&title=DOR+content+types%2C+resource+types+and+interpretive+metadata for next two settings :reading_order = optional - only valid for simple_book, can be ‘rtl’ or ‘ltr’. The default is ‘ltr’.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/assembly-objectfile/content_metadata.rb', line 59

def self.create_content_metadata(druid:, objects:, auto_labels: true,
                                 add_exif: false, bundle: :default, style: :simple_image,
                                 add_file_attributes: false, file_attributes: {},
                                 preserve_common_paths: false, flatten_folder_structure: false,
                                 include_root_xml: nil, reading_order: 'ltr')

  common_path = find_common_path(objects) unless preserve_common_paths # find common paths to all files provided if needed

  filesets = FileSetBuilder.build(bundle: bundle, objects: objects, style: style)
  config = Config.new(auto_labels: auto_labels,
                      flatten_folder_structure: flatten_folder_structure,
                      add_file_attributes: add_file_attributes,
                      file_attributes: file_attributes,
                      add_exif: add_exif,
                      reading_order: reading_order,
                      type: object_level_type(style))

  builder = NokogiriBuilder.build(druid: druid,
                                  filesets: filesets,
                                  common_path: common_path,
                                  config: config)

  if include_root_xml == false
    builder.doc.root.to_xml
  else
    builder.to_xml
  end
end

.object_level_type(style) ⇒ Object 



103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/assembly-objectfile/content_metadata.rb', line 103

def self.object_level_type(style)
  Deprecation.warn(self, "the style #{style} is now deprecated and should not be used. This will be removed in assembly-objectfile 2.0") if DEPRECATED_STYLES.include? style
  raise "Supplied style (#{style}) not valid" unless (VALID_STYLES + DEPRECATED_STYLES).include? style

  case style
  when :simple_image
    'image'
  when :simple_book, :book_with_pdf, :book_as_image
    'book'
  else
    style.to_s
  end
end

.special_dpg_folder?(folder) ⇒ Boolean

Returns:

  • (Boolean) 


88
89
90
 
# File 'lib/assembly-objectfile/content_metadata.rb', line 88

def self.special_dpg_folder?(folder)
  SPECIAL_DPG_FOLDERS.include?(folder)
end