voruby 1.1.1 → 2.0.0

data/lib/voruby/votables/data.rb

@@ -1,179 +0,0 @@
-module VORuby
-  module VOTables
-    module VOTable
-      
-      module Data
-  
-        # A class representing a generic stream of data.
-        class Stream
-          attr_reader :type, :href, :actuate, :encoding, :expires, :rights
-      
-          # [_href_:]
-          #  The URL of the stream (type: Type::AnyURI).
-          # [_expires_:]
-          #  The datetime on which the stream expires.  Must be parsable by
-          #  Ruby's DateTime.parse() method.
-          # [_rights_:]
-          #  The data rights associated with the stream.
-          # [_type_:]
-          #  The type of stream (type: Type::StreamType).
-          # [_actuate_:]
-          #  The actuate property of the stream (type: Type::Actuate).
-          # [_encoding_:]
-          #  The encoding of the stream (type: Type::EncodingType).
-          def initialize(href=nil, expires=nil, rights=nil, type=Type::StreamType.new('locator'),
-    		     	actuate=Type::Actuate.new('onRequest'),
-    		     	encoding=Type::EncodingType.new('none'))
-	
-    		    Misc::TypeCheck.new(type, Type::StreamType).check()
-    		    @type = type
-	
-    		    Misc::TypeCheck.new(href, Type::AnyURI).check()
-    		    @href = href
-	
-    		    Misc::TypeCheck.new(actuate, Type::Actuate).check()
-    		    @actuate = actuate
-	
-    		    Misc::TypeCheck.new(encoding, Type::EncodingType).check()
-    		    @encoding = encoding
-				
-    		    if expires
-    	 		    @expires = DateTime.parse(expires)
-    		    else
-    	  		  @expires = nil
-    		    end
-	
-    		    @rights = rights
-          end
-      
-          def to_s
-    		    "{type=#{@type};href=#{@href};actuate=#{@actuate};encoding=#{encoding};" +
-    	  	  "expires=#{@expires};rights=#{@rights}}"
-          end
-        end
-    
-        # A class representing a binary stream.
-        class BinaryStream
-          attr_reader :stream
-      
-          # [_stream_]
-          #  The basic information associated with a binary stream
-          #  (type: Stream).
-          def initialize(stream=nil)
-    		    Misc::TypeCheck.new(stream, Stream).check()
-    		    @stream = stream
-          end
-      
-          def to_s
-    		    "{stream=#{stream}}"
-          end
-        end
-    
-        # A class representing a FITS stream.
-        class FITSStream
-          attr_reader :stream, :extnum
-      
-          # [_stream_:]
-          #  The basic stream informatin (type: Stream).
-          # [_extnum_:]
-          #  The number of extensions in the FITS file (type Type::PositiveInteger).
-          def initialize(stream=nil, extnum=nil)
-    		    raise Misc::TypeException(stream, Stream) if stream and !stream.is_a?(Stream)
-    		    Misc::TypeCheck.new(stream, Stream).check()
-    		    @stream = stream
-	
-    		    Misc::TypeCheck.new(extnum, Type::PositiveInteger).check()
-    		    @extnum = extnum
-          end
-      
-          def to_s
-    		    "{stream=#{@stream};extnum=#{extnum}}"
-          end
-        end
-    
-        # A class representing the VOTable standard TD element.
-        class TD
-          attr_reader :value, :encoding
-      
-          # [_value_:]
-          #  The value of the cell data.
-          # [_encoding_:]
-          #  The encoding of the cell data (type: Type::EncodingType).
-          def initialize(value=nil, encoding=Type::EncodingType.new('none'))
-    		    @value = value
-	
-    		    Misc::TypeCheck.new(encoding, Type::EncodingType).check()
-    		    @encoding = encoding
-          end
-      
-          def to_s
-    		    "{value=#{@value};encoding=#{@encoding}}"
-          end
-        end
-    
-        # A class representing the VOTable standard TR element.
-        class TR
-          attr_reader :tds
-      
-          # [_tds_:]
-          #  A list of table data belonging in the row in question.
-          def initialize(tds=[])
-    		    tds.each{ |td|
-    	  		  Misc::TypeCheck.new(td, TD).check()
-    		    }
-    		@tds = tds
-          end
-      
-          def to_s
-    		    tds = @tds.collect{|x| x.to_s}.join('|')
-    		    "{tds=#{tds}}"
-          end
-        end
-    
-        # A class representing the VOTable standard TABLEDATA element.
-        class TableData
-          attr_reader :trs
-      
-          # [_trs_:]
-          #  A list of rows associated with the table in question.
-          def initialize(trs=[])
-    		    trs.each{ |tr|
-    	  		  Misc::TypeCheck.new(tr, TR).check()
-    		    }
-    		    @trs = trs
-          end
-      
-          def to_s
-    		    trs = @trs.collect{|x| x.to_s}.join('|')
-    		    "{trs=#{trs}}"
-          end
-        end
-    
-        # A class representing the VOTable standard DATA element.
-        class Data
-          attr_reader :format
-      
-          # [_format_:]
-          #  Where the actual data is coming from (types: FITSStream,
-          #  BinaryStream, TableData.
-          #  Currently, this class doesn't know what to do with streams.
-          def initialize(format=nil)
-    		    if format.is_a?(FITSStream) or format.is_a?(BinaryStream) or
-    	    	  format.is_a?(TableData)
-    	  		  @format = format
-    		    else
-    	  		  raise "Format #{format.class} is not valid.  Use one of: " +
-    	    		  "FITSStream, BinaryStream, TableData"
-    		    end
-          end
-      
-          def to_s
-    		    "{format=#{@format}}"
-          end
-        end
-    
-      end
-    end
-
-  end
-end

data/lib/voruby/votables/galex.rb

@@ -1,377 +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 GALEX VOTable.
-
-require 'voruby/votables/votable'
-
-module VORuby
-  module VOTables
-    module VOTable
-      class GALEXVOTable < 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 GALEX 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)
-          galex_field = {'id'=> nil, 'name'=> nil, 'ucd'=> nil}
-          
-          if key != nil
-            GALEX_ARCHIVE_CONFIG.each do |archive|
-              archive['votable_fields'].each do |field|
-                if field['key'] == key
-                  galex_field['id'] = field['id'] if field['id'] != 'nil'
-                  galex_field['name'] = field['name'] if field['name'] != 'nil'
-                  galex_field['ucd'] = field['ucd'] if field['ucd'] != 'nil'
-                  break
-                end
-              end
-            end
-          end
-          return galex_field
-        end
-        
-        # Find the column number(s) associated with the 
-        # VOX:imageAccessReference UCD.
-        # Returns a list of column positions.
-        def image_access_reference_columns()
-          ucd_access = find_field_in_conf_file('VOX:Image_AccessReference')['name']
-          
-          if find_columns(ucd_access).first != nil
-            find_columns(ucd_access).first
-          end
-        end
-        
-        def image_ra_columns
-          ucd_ra = find_field_in_conf_file('POS_EQ_RA_MAIN')['name']
-          
-          if find_columns(ucd_ra).first != nil
-            find_columns(ucd_ra).first
-          end
-        end
-        
-        def image_dec_columns
-          ucd_dec = find_field_in_conf_file('POS_EQ_DEC_MAIN')['name']
-          
-          if find_columns(ucd_dec).first != nil
-            find_columns(ucd_dec).first
-          end
-        end
-        
-        def image_filter_columns
-          ucd_filter = find_field_in_conf_file('VOX:BandPass_ID')['name']
-          
-          if find_columns(ucd_filter).first != nil
-            find_columns(ucd_filter).first
-          end
-        end
-        
-        def image_date_obs_columns
-          #ucd_date_obs = find_field_in_conf_file('')['name']
-          
-          #if find_columns(ucd_date_obs).first != nil
-          #  find_columns(ucd_date_obs).first
-          #end
-        end
-        
-        def image_telescope_columns
-          #ucd_telescope = find_field_in_conf_file('')['name']
-          
-          #if find_columns(ucd_telescope).first != nil
-          #  find_columns(ucd_telescope).first
-          #end
-        end
-        
-        def image_survey_columns
-          ucd_survey = find_field_in_conf_file('VOX:Image_Title')['name']
-          
-          if find_columns(ucd_survey).first != nil
-            find_columns(ucd_survey).first
-          end
-        end
-        
-        def image_instrument_columns
-          ucd_instrument = find_field_in_conf_file('VOX:INST_ID')['name']
-          
-          if find_columns(ucd_instrument).first != nil
-            find_columns(ucd_instrument).first
-          end
-        end
-        
-        def image_sky_columns
-          #ucd_sky = find_field_in_conf_file('')['name']
-          
-          #if find_columns(ucd_sky).first != nil
-          #  find_columns(ucd_sky).first
-          #end
-        end
-        
-        def image_zeropoint_columns
-          #ucd_zeropoint = find_field_in_conf_file('')['name']
-          
-          #if find_columns(ucd_zeropoint).first != nil
-          #  find_columns(ucd_zeropoint).first
-          #end
-        end
-        
-        def image_seeing_columns
-          #ucd_seeing = find_field_in_conf_file('')['name']
-          
-          #if find_columns(ucd_seeing).first != nil
-          #  find_columns(ucd_seeing).first
-          #end
-        end
-        
-        def image_depth_columns
-          #ucd_depth = find_field_in_conf_file('')['name']
-          
-          #if find_columns(ucd_depth).first != nil
-          #  find_columns(ucd_depth).first
-          #end
-        end
-        
-        def image_exptime_columns
-          #ucd_exptime = find_field_in_conf_file('')['name']
-          
-          #if find_columns(ucd_exptime).first != nil
-          #  find_columns(ucd_exptime).first
-          #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.ucd.value())
-            field_ucd = field_archive['ucd']
-            if options[:infer_access_ref] and col_count == access_ref_index
-              thead_2row[1] = field_ucd if field_ucd != 'nil'
-            else
-              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
-          
-          access_ref_index = image_access_reference_columns()
-          link_ref_array.push("resource=#{CGI.escape(columns[access_ref_index].value).to_s}") if access_ref_index
-          ra_index = image_ra_columns()
-          link_ref_array.push("rac=#{columns[ra_index].value.to_s}") if ra_index
-          dec_index = image_dec_columns()
-          link_ref_array.push("decc=#{columns[dec_index].value.to_s}") if dec_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
-                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)}\"/></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