Module: ActiveFedora::Datastreams::ClassMethods

Defined in:
lib/active_fedora/datastreams.rb

Instance Method Summary (collapse)

Instance Method Details

- (Object) build_datastream_accessor(dsid)



226
227
228
229
230
231
# File 'lib/active_fedora/datastreams.rb', line 226

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

- (Class) datastream_class_for_name(dsid)



163
164
165
# File 'lib/active_fedora/datastreams.rb', line 163

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

- (Object) has_file_datastream(name, args) - (Object) has_file_datastream(args)

Overloads:

  • - (Object) has_file_datastream(name, args)

    Declares a file datastream exists for objects of this type

  • - (Object) has_file_datastream(args)

    Declares a file datastream exists for objects of this type



215
216
217
218
219
220
221
222
223
224
# File 'lib/active_fedora/datastreams.rb', line 215

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

- (Object) has_metadata(*args) { ... }

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)

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)
  • :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



183
184
185
186
187
188
189
190
191
192
193
194
# File 'lib/active_fedora/datastreams.rb', line 183

def (*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