lib/zcc/resultset.rb

   1 module ZCC
   2   class ResultSet
   3     include Enumerable
   4
   5     attr_accessor :query, :sort_by, :index_start, :index_end, :records
   6
   7     #All values of initialize are optional, though you'll want to supply it with a query object if you intend on getting records into your set through a z39.50 search. index_start and index_end will be used for the TUI display.
   8     def initialize(query_object=nil, sort_by='title', index_start=0, index_end=5 )
   9       @query = query_object #query object
  10
  11       @sort_by = sort_by
  12       @index_start = index_start
  13       @index_end = index_end
  14       #puts self.sort_by
  15       #puts self.index_start
  16       @records = []
  17       #puts self.records.class
  18       #STDIN.gets
  19     end
  20
  21     #Pretty prints the result set object. Nests pretty printed record objects within.
  22     def to_s
  23       full_string =  "-------RESULT SET--------------\n" + "Result set has #{self.records.size} records."
  24       self.records.each do |record|
  25         full_string << record.to_s
  26       end
  27       full_string += "-------RESULT SET--------------\n"
  28     end
  29
  30     # Method to add records only to a result set.
  31     def ingest record
  32       self.records << record
  33     end
  34
  35     # appends a result set to another.
  36     # Replaces the query and sort_by instance variables with the new ones.
  37     def <<(result_set)
  38       #puts record
  39       self.records << result_set.records
  40       self.query = result_set.query
  41       self.sort_by = result_set.sort_by
  42       self.records.flatten!
  43       #puts self.records.inspect
  44     end
  45
  46     #Removes unselected records from the result set. Uses the selected instance variable to check for true or false.
  47     def remove_unselected!
  48       self.records.each_index do |i|
  49         if self.records[i].nil?
  50         else
  51           self.records[i] = nil unless self.records[i].selected
  52         end
  53       end
  54       self.records.flatten!
  55       self.records.compact!
  56       self.records.uniq!
  57     end
  58
  59     #Number of records in the result set
  60     def size
  61       self.records.length
  62     end
  63
  64     alias length size
  65
  66     def selected_size
  67       selected_records = self.find_all{|record| record.selected unless record == nil}
  68       selected_records.length
  69     end #returns number of ZCC::Records with @selected set to true
  70
  71     alias selected_length selected_size
  72
  73
  74
  75     def each
  76       for record in @records
  77         yield record
  78       end
  79     end
  80
  81     def sort_relevant
  82     end #
  83
  84     def hits_per_source
  85     end #=> hash{zurl=>[rec, rec],zurl=>[rec, rec]
  86
  87     def []
  88     end # Record at that position
  89
  90     def empty?
  91       if self.records.size == 0
  92         return true
  93       elsif self.records.size > 0
  94         return false
  95       end
  96     end #returns true if the @ZCCRecords array is empty or only nil values
  97
  98     #def find_all
  99       #self.find_all {|record| record.selected}
 100     #end
 101
 102   end
 103 end