Module: ActiveFedora::Datastreams::ClassMethods

Defined in:
lib/active_fedora/datastreams.rb,
lib/active_fedora/datastreams.rb

Instance Method Summary collapse

Instance Method Details

#build_datastream_accessor(dsid) ⇒ Object 



229
230
231
232
233
234
 
# File 'lib/active_fedora/datastreams.rb', line 229

def build_datastream_accessor(dsid)
name = name_for_dsid(dsid)
define_method name do
  datastreams[dsid]
end
end

#datastream_class_for_name(dsid) ⇒ Class

Returns the class of the datastream.

Parameters:

  • dsid (String) —

    the datastream id

Returns:

  • (Class) —

    the class of the datastream



166
167
168
 
# File 'lib/active_fedora/datastreams.rb', line 166

def datastream_class_for_name(dsid)
  ds_specs[dsid] ? ds_specs[dsid].fetch(:type, ActiveFedora::Datastream) : ActiveFedora::Datastream
end

#has_file_datastream(name, args) ⇒ Object #has_file_datastream(args) ⇒ Object

Overloads:

  • #has_file_datastream(name, args) ⇒ Object

    Declares a file datastream exists for objects of this type

    Parameters:

    • name (String)
    • args (Hash) —

      @option args :type (ActiveFedora::Datastream) The class the datastream should have @option args :label (“File Datastream”) The default value to put in the dsLabel field @option args :control_group (“M”) The type of controlGroup to store the datastream as. Defaults to M @option args [Boolean] :autocreate Always create this datastream on new objects @option args [Boolean] :versionable Should versioned datastreams be stored

  • #has_file_datastream(args) ⇒ Object

    Declares a file datastream exists for objects of this type

    Parameters:

    • args (Hash) —

      @option args :name (“content”) The dsid of the datastream @option args :type (ActiveFedora::Datastream) The class the datastream should have @option args :label (“File Datastream”) The default value to put in the dsLabel field @option args :control_group (“M”) The type of controlGroup to store the datastream as. Defaults to M @option args [Boolean] :autocreate Always create this datastream on new objects @option args [Boolean] :versionable Should versioned datastreams be stored



218
219
220
221
222
223
224
225
226
227
 
# File 'lib/active_fedora/datastreams.rb', line 218

def has_file_datastream(*args)
  @file_ds_defaults ||= {
    :autocreate => false,
    :type=>ActiveFedora::Datastream,
    :label=>"File Datastream",
    :control_group=>"M",
    :name=>"content"
  }
  spec_datastream(args, @file_ds_defaults)
end

#has_metadata(*args) { ... } ⇒ Object

This method is used to specify the details of a datastream. You can pass the name as the first argument and a hash of options as the second argument or you can pass the :name as a value in the args hash. Either way, name is required. Note that this method doesn’t actually execute the block, but stores it, to be executed by any the implementation of the datastream(specified as :type)

Parameters:

  • args (Hash)

Options Hash (*args):

  • :type (Class) —

    The class that will represent this datastream, should extend “Datastream”

  • :name (String) —

    the handle to refer to this datastream as

  • :label (String) —

    sets the fedora label

  • :control_group (String) —

    must be one of ‘E’, ‘X’, ‘M’, ‘R’

  • :disseminator (String) —

    Sets the disseminator location see ActiveFedora::Datastreams#add_disseminator_location_to_datastreams

  • :url (String)
  • :autocreate (Boolean) —

    Always create this datastream on new objects

  • :versionable (Boolean) —

    Should versioned datastreams be stored

Yields:

  • block executed by some kinds of datastreams



186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/active_fedora/datastreams.rb', line 186

def has_metadata(*args, &block)
  @metadata_ds_defaults ||= {
    :autocreate => false,
    :type=>nil,
    :label=>"",
    :control_group=>nil,
    :disseminator=>"",
    :url=>"",
    :name=>nil
  }
  spec_datastream(args, @metadata_ds_defaults, &block)
end

#inherited(kls) ⇒ Object

:nodoc:



16
17
18
19
 
# File 'lib/active_fedora/datastreams.rb', line 16

def inherited(kls) #:nodoc:
  super
  kls.ds_specs = kls.ds_specs.dup
end