voruby 1.1.1 → 2.0.0

data/lib/voruby/votables/misc.rb

@@ -1,51 +0,0 @@
-module VORuby
-  module VOTables
-    module VOTable
-
-      # Miscellaneous classes that don't fit elsewhere.
-      module Misc
-    
-        # An exception thrown when the incoming type does not match
-        # the expected value.
-        class TypeException < Exception
-    
-          # [_obj_:]
-          #  The object itself.
-          # [_prototype_:]
-          #  The prototype of the expected class.
-          def initialize(obj=nil, prototype=nil)
-    		    super("Invalid type: #{obj.class} (#{obj}) != #{prototype}")
-          end
-        end
-	  
-    	  # A class which checks to see whether the type of the incoming class
-    	  # matches expectation.
-        class TypeCheck
-          attr_accessor :obj, :proto
-	   
-    	    # [_obj_:]
-    	    #  The object in question.
-    	    # [_proto_:]
-    	    #  The prototype of the expected class.
-          def initialize(obj=nil, proto=nil)
-    		    #raise "TypeCheck must have an object" if obj == nil
-    		    #raise "TypeCheck must have a prototype" if proto == nil
-	
-    		    @obj = obj
-    		    @proto = proto
-          end
-      
-          # Check to see whether the class is of the expected type.
-          def check
-    		    raise TypeException.new(@obj, @proto) if @obj and !@obj.is_a?(@proto)
-          end
-      
-          def to_s
-    		    "{object=#{@obj};prototype=#{@proto}}"
-          end
-        end
-      end
-    
-    end
-  end
-end

data/lib/voruby/votables/nsa.rb

@@ -1,410 +0,0 @@
-# A set of classes designed to read and manipulate 
-# especific VOTables[http://www.ivoa.net/Documents/latest/VOT.html].
-# This class represents a NSA VOTable.
-
-require 'voruby/votables/votable'
-
-module VORuby
-  module VOTables
-    
-    module VOTable
-      class NSAVOTable < VOTable
-    
-        # Our object's contructor
-        # [_votable:_]
-        #   The VOTable object
-        def initialize(votable)
-          super(votable.id, votable.version, votable.description, 
-                votable.definitions, votable.coosys, votable.params, 
-                votable.info, votable.resources)
-        end
-        
-        # Find the column number(s) associated with a Name.
-        # Returns a list of column positions.
-        # [_res_:]
-        #   The resource from which to extract the table in question.
-        # [_tbl_:]
-        #   The resource from which to extract the table in question.
-        def find_columns(name, res=0, tbl=0)
-          columns = []
-          
-          col_count = 0
-          fields = fields(res, tbl)
-          if fields
-            fields.each do |field|
-              if field.name() != nil
-                columns.push(col_count) if field.name() == name
-              end  
-              col_count += 1
-            end
-          end
-          return columns
-        end
-        
-        # Find a field in NSA SIAP configuration file given a key.
-        # Returns a hash with the field's attributes
-        # [_key_:]
-        #   The key indexing on field's attribute.
-        def find_field_in_conf_file(key)
-          nsa_field = {'id'=> nil, 'name'=> nil, 'ucd'=> nil}
-          
-          if key != nil
-            NSA_SIAP_CONFIG.each do |archive|
-              archive['votable_fields'].each do |field|
-                if field['key'] == key
-                  nsa_field['id'] = field['id'] if field['id'] != 'nil'
-                  nsa_field['name'] = field['name'] if field['name'] != 'nil'
-                  nsa_field['ucd'] = field['ucd'] if field['ucd'] != 'nil'
-                  break
-                end
-              end
-            end
-          end
-          return nsa_field
-        end
-        
-        def image_access_reference_columns()
-          access_key = find_field_in_conf_file('reference')['name']
-          
-          if find_columns(access_key).first != nil
-            find_columns(access_key).first
-          end
-        end
-        
-        def image_ra_columns
-          ra_key = find_field_in_conf_file('ra')['name']
-          
-          if find_columns(ra_key).first != nil
-            find_columns(ra_key).first
-          end
-        end
-        
-        def image_dec_columns
-          dec_key = find_field_in_conf_file('dec')['name']
-          
-          if find_columns(dec_key).first != nil
-            find_columns(dec_key).first
-          end
-        end
-        
-        def image_obstype_columns
-          obstype_key = find_field_in_conf_file('object')['name']
-          
-          if find_columns(obstype_key).first != nil
-            find_columns(obstype_key).first
-          end
-        end
-        
-        def image_filter_columns
-          #filter_key = find_field_in_conf_file('')['name']
-          
-          #if find_columns(filter_key).first != nil
-          #  find_columns(filter_key).first
-          #end
-        end
-        
-        def image_date_obs_columns
-          #date_obs_key = find_field_in_conf_file('')['name']
-          
-          #if find_columns(date_obs_key).first != nil
-          #  find_columns(date_obs_key).first
-          #end
-        end
-        
-        def image_telescope_columns
-          telescope_key = find_field_in_conf_file('telescope')['name']
-          
-          if find_columns(telescope_key).first != nil
-            find_columns(telescope_key).first
-          end
-        end
-        
-        def image_survey_columns
-          survey_key = find_field_in_conf_file('prop_id')['name']
-          
-          if find_columns(survey_key).first != nil
-            find_columns(survey_key).first
-          end
-        end
-        
-        def image_instrument_columns
-          instrument_key = find_field_in_conf_file('instrument')['name']
-          
-          if find_columns(instrument_key).first != nil
-            find_columns(instrument_key).first
-          end
-        end
-        
-        def image_sky_columns
-          #sky_key = find_field_in_conf_file('')['name']
-          
-          #if find_columns(sky_key).first != nil
-          #  find_columns(sky_key).first
-          #end
-        end
-        
-        def image_zeropoint_columns
-          #zeropoint_key = find_field_in_conf_file('')['name']
-          
-          #if find_columns(zeropoint_key).first != nil
-          #  find_columns(zeropoint_key).first
-          #end
-        end
-        
-        def image_seeing_columns
-          seeing_key = find_field_in_conf_file('seeing')['name']
-          
-          if find_columns(seeing_key).first != nil
-            find_columns(seeing_key).first
-          end
-        end
-        
-        def image_depth_columns
-          depth_key = find_field_in_conf_file('depth')['name']
-          
-          if find_columns(depth_key).first != nil
-            find_columns(depth_key).first
-          end
-        end
-        
-        def image_exptime_columns
-          #exptime_key = find_field_in_conf_file('')['name']
-          
-          #if find_columns(exptime_key).first != nil
-          #  find_columns(exptime_key).first
-          #end
-        end
-        
-        def image_vo_id_columns
-          vo_id_key = find_field_in_conf_file('vo_id')['name']
-          
-          if find_columns(vo_id_key).first != nil
-            find_columns(vo_id_key).first
-          end
-        end
-        
-        def show_columns(col_count)
-          case col_count
-            when image_access_reference_columns()
-              return false
-            when image_vo_id_columns()
-              return false
-            else
-              return true
-          end
-        end
-        
-        # Create the headers for HTML table
-        # [_access_ref_index_:]
-        #  A valid SIA VOTable will only ever have one VOX:Image_AccessReference.
-        # [_options_:]
-        # 
-        def create_headers(access_ref_index, options)
-          thead, thead_2row = create_header_cart_links(options)
-          
-          if options[:infer_access_ref] and access_ref_index
-            thead << "<th>#{options[:access_ref_header_label]}</th>\n"
-            thead_2row.push('&nbsp;')
-          end
-          
-          col_count = 0
-          fields(options[:res], options[:tbl]).each do |field|
-            field_archive = find_field_in_conf_file(field.name)
-            field_ucd = field_archive['ucd']
-            if options[:infer_access_ref] and access_ref_index and col_count == access_ref_index
-              thead_2row[1] = field_ucd if field_ucd != 'nil'
-            elsif show_columns(col_count)
-              thead << "<th>#{field_archive['name']}</th>\n"
-              if field_ucd != 'nil'
-                thead_2row.push(field_ucd)
-              else
-                thead_2row.push('&nbsp')
-              end
-            end
-            col_count += 1
-          end
-          
-          thead << "  </tr>\n"
-          
-          thead << "<tr>\n"
-          thead_2row.each do |h|
-            thead << "<th>#{h}</th>\n"
-          end
-          thead << "</tr>\n"
-          
-          thead << "</thead>"
-          
-          return thead
-        end
-        
-        # Creates the cart parameters
-        # [_cart_params:_]
-        # 
-        # [_columns:_]
-        #  
-        def create_item_cart_params(cart_params, columns)
-          link_ref_array = []
-          
-          cart_params.each do |key, value|
-            link_ref_array.push("#{key}=#{value}")
-          end
-          
-          ra_index = image_ra_columns()
-          link_ref_array.push("rac=#{convert_ra_to_degrees(columns[ra_index].value.to_s).to_s}") if ra_index
-          dec_index = image_dec_columns()
-          link_ref_array.push("decc=#{convert_dec_to_degrees(columns[dec_index].value.to_s).to_s}") if dec_index
-          obstype_index = image_obstype_columns()
-          link_ref_array.push("obstype=#{columns[obstype_index].value.to_s}") if obstype_index
-          filter_index = image_filter_columns()
-          link_ref_array.push("filter=#{columns[filter_index].value.to_s}") if filter_index
-          date_obs_index = image_date_obs_columns()
-          link_ref_array.push("date_obs=#{columns[date_obs_index].value.to_s}") if date_obs_index
-          teles_index = image_telescope_columns()
-          link_ref_array.push("telescop=#{columns[teles_index].value.to_s}") if teles_index
-          survey_index = image_survey_columns()
-          link_ref_array.push("survey=#{columns[survey_index].value.to_s}") if survey_index
-          instrum_index = image_instrument_columns()
-          link_ref_array.push("instrument=#{columns[instrum_index].value.to_s}") if instrum_index
-          sky_index = image_sky_columns()
-          link_ref_array.push("sky=#{columns[sky_index].value.to_s}") if sky_index
-          zerop_index = image_zeropoint_columns()
-          link_ref_array.push("zeropoint=#{columns[zerop_index].value.to_s}") if zerop_index
-          seeing_index = image_seeing_columns()
-          link_ref_array.push("seeing=#{columns[seeing_index].value.to_s}") if seeing_index
-          depth_index = image_depth_columns()
-          link_ref_array.push("depth=#{columns[depth_index].value.to_s}") if depth_index
-          exptime_index = image_exptime_columns()
-          link_ref_array.push("exptime=#{columns[exptime_index].value.to_s}") if exptime_index
-          
-          return link_ref_array.join('&')
-        end
-        
-        # Create body for HTML table
-        # [_access_ref_index_:]
-        #  A valid SIA VOTable will only ever have one VOX:Image_AccessReference.
-        # [_options_:]
-        #  
-        def create_body(access_ref_index, options)
-          tbody = "<tbody class=\"#{options[:body_class]}\" align=\"center\">\n"
-          row_count = 0
-          rows_data = rows(options[:res], options[:tbl])
-          if rows_data
-            rows_data.each do |tr|
-              tbody << "<tr class=\"#{options[:row_classes][row_count % 2]}\">\n"
-              
-              # Specially mark up the first column to link to the image.
-              columns = tr.tds()
-              
-              if options[:infer_add_to_cart_ref] and access_ref_index
-                link_ref = "&resource=#{CGI.escape(columns[access_ref_index].value).to_s}"
-                if options[:ssl]
-                  resource = URI.parse(columns[access_ref_index].value)
-                  resource.scheme = options[:resource_link][:scheme]
-                  resource.port = options[:resource_link][:port]
-                  resource_link = resource.scheme.to_s + '://' + resource.host.to_s + ':' + 
-                      resource.port.to_s + resource.request_uri().to_s
-                  link_ref = "&resource=#{CGI.escape(resource_link).to_s}"
-                end
-                
-                tbody << "<td><input type=\"checkbox\" " +
-                         "id=\"checkbox_add_#{options[:cart_params][:archive]}_#{row_count.to_s}\" " +
-                         "value=\"#{create_item_cart_params(options[:cart_params], columns)}#{link_ref}\"/></td>\n"
-              end
-              
-              if options[:infer_access_ref] and access_ref_index
-                tbody << "<td><a href=\"#{columns[access_ref_index].value}\">#{options[:access_ref_link_label]}</a></td>\n"
-              end
-              
-              col_count = 0
-              ra_index = image_ra_columns()
-              dec_index = image_dec_columns()
-              columns.each do |td|
-                if col_count != access_ref_index
-                  if ra_index and col_count == ra_index
-                    tbody << "<td>#{convert_ra_to_degrees(td.value)}</td>\n"
-                  elsif dec_index and col_count == dec_index
-                    tbody << "<td>#{convert_dec_to_degrees(td.value)}</td>\n"
-                  else
-                    tbody << "<td>#{td.value}</td>\n"
-                  end
-                end
-                col_count += 1
-              end
-              
-              tbody << "</tr>\n"
-              row_count += 1
-            end
-          end
-          tbody << "</tbody>"
-          
-          return tbody
-        end
-        
-        # Convert the specified table in the specified resource into an HTML
-        # table.
-        # [_options_:]
-        #  The options for this VOTable.
-        def to_html(options={})
-          # The ID to assign to the HTML table as a whole.
-          options[:id] = options[:id] || "#{votable}_#{Time.now.to_i}_#{rand(10000)}"
-          
-          options[:infer_add_to_cart_ref] = true if options[:infer_add_to_cart_ref] == nil
-          options[:add_to_cart_header_label] = options[:add_to_cart_header_label] || 'Add to Cart'
-          options[:cart_params] = {} if options[:cart_params] == nil
-          #options[:add_to_cart_url] = options[:add_to_cart_url] || nil
-          
-          options[:throbber_src] = options[:throbber_src] || '/images/general/indicator.gif'
-          options[:throbber_size] = options[:throbber_size] || '16x16'
-          options[:throbber_class] = options[:throbber_class] || 'throbber'
-          options[:throbber_id] = options[:throbber_id] || "#{options[:id]}_throbber_id"
-          
-          options[:flash_notice_class] = options[:flash_notice_class] || 'flash_notice'
-          options[:flash_notice_id] = options[:flash_notice_id] || "#{options[:id]}_flash_notice_id"
-          
-          # Link the access reference URL associated with a row.
-          options[:infer_access_ref] = true if options[:infer_access_ref] == nil
-          #options[:retrieve_link_ref] = options[:retrieve_link_ref] || nil
-          # For the access reference column, place this value in the header.
-          options[:access_ref_header_label] = options[:access_ref_header_label] || 'URL'
-          # For the access reference column, link this word.
-          options[:access_ref_link_label] = options[:access_ref_link_label] || 'Retrieve'
-          options[:ssl] = false if options[:ssl] == nil
-          #options[:resource_link] = options[:resource_link]
-          
-          # The resource from which to extract the table in question.
-          options[:res] = options[:res] || 0
-          # The table inside the resource from which to extract the rows in question.
-          options[:tbl] = options[:tbl] || 0
-          
-          # The boolean value to show HTML table border
-          options[:show_border] = false if options[:show_border] == nil
-          # The class to assign the HTML table as a whole.
-          options[:table_class] = options[:table_class] || 'votable'
-          # The class to assign the header of the HTML table.
-          options[:header_class] = options[:header_class] || 'header'
-          # The class to assign the body of the HTML table.
-          options[:body_class] = options[:body_class] || 'body'
-          # The class to assign the HTML table body rows.
-          options[:row_classes] = options[:row_classes] || ['row1', 'row2']
-          
-          begin
-            # A valid SIA VOTable will only ever have one VOX:Image_AccessReference.
-            access_ref_index = image_access_reference_columns()
-              
-            return create_votable(create_headers(access_ref_index, options),
-                                  create_body(access_ref_index, options),
-                                  options)
-            
-            rescue Exception => e
-              title = 'Error...'
-              message = "VORuby error: #{e.message}<br>#{e.backtrace}"
-              message << "<br>#{@resources[0].info[0].text().to_s()}" if @resources[0].info[0]
-              create_message(title, message, options)
-          end
-        end
-        
-      end
-    end
-    
-  end
-end