Sha256: 37390f759af2088a19001efbfd7c35eb765811f213ad909c2883bf0cbb7b8a47

Contents?: true

Size: 911 Bytes

Versions: 5

Compression:

Stored size: 911 Bytes

Contents

module Alf
  class Environment
    #
    # This methods provides base methods for implementing the Environment 
    # contract. The Environment class already includes it and should be used
    # as a superclass of specific implementations.
    #
    module InstanceMethods

      # Returns a dataset whose name is provided.
      #
      # This method resolves named datasets to tuple enumerables. When the 
      # dataset exists, this method must return an Iterator, typically a 
      # Reader instance. Otherwise, it must throw a NoSuchDatasetError.
      #
      # @param [Symbol] name the name of a dataset
      # @return [Iterator] an iterator, typically a Reader instance
      # @raise [NoSuchDatasetError] when the dataset does not exists
      def dataset(name)
      end
      undef :dataset

    end # module InstanceMethods
    include(InstanceMethods)
  end # class Environment
end # module Alf

Version data entries

5 entries across 5 versions & 1 rubygems

Version Path
alf-0.12.2 lib/alf/environment/instance_methods.rb
alf-0.12.1 lib/alf/environment/instance_methods.rb
alf-0.12.0 lib/alf/environment/instance_methods.rb
alf-0.11.1 lib/alf/environment/instance_methods.rb
alf-0.11.0 lib/alf/environment/instance_methods.rb