voruby 1.0.1

data/lib/voruby/votables/cnoc.rb

@@ -0,0 +1,393 @@
+# A set of classes designed to read and manipulate 
+# especific VOTables[http://www.ivoa.net/Documents/latest/VOT.html].
+# This class represents a CNOC VOTable.
+
+require 'voruby/votables/votable'
+
+module VORuby
+  module VOTables
+    
+    module VOTable
+      class CNOCVOTable < 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 a field in CNOC configuration file given a key.
+        # Returns a hash with the field's attributes
+        # [_key_:]
+        #   The key indexing on field's attribute. This key is the same 
+        #   UCD, because I guess that CNOC always uses the UCDs on its 
+        #   fields
+        def find_field_in_conf_file(key)
+          cnoc_field = {'id'=> nil, 'name'=> nil, 'ucd'=> nil}
+      
+          if key != nil
+            CNOC_ARCHIVE_CONFIG.each do |archive|
+              archive['votable_fields'].each do |field|
+                if field['key'] == key
+                  cnoc_field['id'] = field['id'] if field['id'] != 'nil'
+                  cnoc_field['name'] = field['name'] if field['name'] != 'nil'
+                  cnoc_field['ucd'] = field['ucd'] if field['ucd'] != 'nil'
+                  break
+                end
+              end
+            end
+          end
+          return cnoc_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')['ucd']
+      
+          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')['ucd']
+      
+          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')['ucd']
+      
+          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('')['ucd']
+      
+          #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('')['ucd']
+      
+          #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('')['ucd']
+      
+          #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('ID_SURVEY')['ucd']
+      
+          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('INST_ID')['ucd']
+      
+          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('')['ucd']
+      
+          #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('')['ucd']
+      
+          #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('')['ucd']
+      
+          #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('')['ucd']
+      
+          #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('')['ucd']
+      
+          #if find_columns(ucd_exptime).first != nil
+          #  find_columns(ucd_exptime).first
+          #end
+        end
+    
+        # Create headers for HTML table
+        # [_res_:]
+        #  The resource from which to extract the table in question.
+        # [_tbl_:]
+        #  The table inside the resource from which to extract the rows in question.
+        # [_infer_add_to_cart_ref_:]
+        #  
+        # [_add_to_cart_header_value_:]
+        # 
+        # [_infer_access_ref_:]
+        #  Link the access reference URL associated with a row.
+        # [_access_ref_header_value_:]
+        #  For the access reference column, place this value in the header.
+        # [_access_ref_col_:]
+        #  A valid SIA VOTable will only ever have one VOX:Image_AccessReference.
+        # [_header_class_:]
+        #  The class to assign the header of the HTML table.
+        def create_headers(res, tbl,
+            infer_add_to_cart_ref, add_to_cart_header_value,
+            infer_access_ref, access_ref_header_value, access_ref_col,
+            header_class)
+      
+          headers = Array.new
+          thead = "<thead class=\"#{header_class}\">\n"
+      
+          thead << "<tr>\n"
+          if infer_add_to_cart_ref
+            thead << "<th>#{add_to_cart_header_value}</th>\n"
+            headers.push('&nbsp')
+          end
+          if infer_access_ref
+            thead << "<th>#{access_ref_header_value}</th>\n"
+            headers.push('&nbsp')
+          end
+          col_count = 0
+          fields(res, tbl).each do |field|
+            field_archive = find_field_in_conf_file(field.ucd.value())
+            field_ucd = field_archive['ucd']
+            if infer_access_ref and col_count == access_ref_col
+              headers[1] = field_ucd if field_ucd != 'nil'
+            else
+              thead << "<th>#{field_archive['name']}</th>\n"
+              if field_ucd != 'nil'
+                headers.push(field_ucd)
+              else
+                headers.push('&nbsp')
+              end
+            end
+            col_count += 1
+          end
+          thead << "  </tr>\n"
+      
+          thead << "<tr>\n"
+          headers.each do |h|
+            thead << "<th>#{h}</th>\n"
+          end
+          thead << "</tr>\n"
+      
+          thead << "</thead>"
+      
+          return thead
+        end
+    
+        def create_add_to_cart_link(link_ref, columns)
+          access_ref_col = image_access_reference_columns()
+          link_ref << '&resource=' + CGI.escape(columns[access_ref_col].value).to_s if access_ref_col
+          ra_col = image_ra_columns()
+          link_ref << '&rac=' + columns[ra_col].value.to_s if ra_col
+          dec_col = image_dec_columns()
+          link_ref << '&decc=' + columns[dec_col].value.to_s if dec_col
+          filter_col = image_filter_columns()
+          link_ref << '&filter=' + columns[filter_col].value.to_s if filter_col
+          date_obs_col = image_date_obs_columns()
+          link_ref << '&date_obs=' + columns[date_obs_col].value.to_s if date_obs_col
+          teles_col = image_telescope_columns()
+          link_ref << '&telescop=' + columns[teles_col].value.to_s if teles_col
+          survey_col = image_survey_columns()
+          link_ref << '&survey=' + columns[survey_col].value.to_s if survey_col
+          instrum_col = image_instrument_columns()
+          link_ref << '&instrument=' + columns[instrum_col].value.to_s if instrum_col
+          sky_col = image_sky_columns()
+          link_ref << '&sky=' + columns[sky_col].value.to_s if sky_col
+          zerop_col = image_zeropoint_columns()
+          link_ref << '&zeropoint=' + columns[zerop_col].value.to_s if zerop_col
+          seeing_col = image_seeing_columns()
+          link_ref << '&seeing=' + columns[seeing_col].value.to_s if seeing_col
+          depth_col = image_depth_columns()
+          link_ref << '&depth=' + columns[depth_col].value.to_s if depth_col
+          exptime_col = image_exptime_columns()
+          link_ref << '&exptime=' + columns[exptime_col].value.to_s if exptime_col
+      
+          return link_ref
+        end
+    
+        # Create body for HTML table
+        # [_res_:]
+        #  The resource from which to extract the table in question.
+        # [_tbl_:]
+        #  The table inside the resource from which to extract the rows in question.
+        # [_infer_add_to_cart_ref_:]
+        #  
+        # [_add_to_cart_link_value_:]
+        #  
+        # [_add_to_cart_link_ref_:]
+        #  
+        # [_infer_access_ref_:]
+        #  Link the access reference URL associated with a row.
+        # [_access_ref_link_value_:]
+        #  For the access reference column, link this word.
+        # [_access_ref_col_:]
+        #  A valid SIA VOTable will only ever have one VOX:Image_AccessReference.
+        # [_body_class_:]
+        #  The class to assign the body of the HTML table.
+        # [_row_classes_:]
+        #  The class to assign the HTML table body rows.
+        def create_body(res, tbl,
+            infer_add_to_cart_ref, add_to_cart_link_value, add_to_cart_link_ref,
+            infer_access_ref, access_ref_link_value, access_ref_col, 
+            body_class, row_classes)
+      
+          tbody = "<tbody class=\"#{body_class}\">\n"
+          row_count = 0
+          rows(res, tbl).each do |tr|
+            tbody << "<tr class=\"#{row_classes[row_count % 2]}\">\n"
+        
+            # Specially mark up the first column to link to the image.
+            columns = tr.tds()
+        
+            if infer_add_to_cart_ref
+              archive = add_to_cart_link_ref.slice(add_to_cart_link_ref.index('&archive='), add_to_cart_link_ref.length)
+              archive = archive.slice('&archive='.length, archive.length)
+              archive = archive.slice(0, archive.index('&')) if archive.index('&')
+              link_id = 'add_' + archive.to_s + '_' + row_count.to_s
+              url = create_add_to_cart_link(add_to_cart_link_ref, columns)
+              js = "new Ajax.Request('#{url}', " +
+                   "  {method: 'post', " +
+                   "   onComplete: function(request){Element.hide('#{link_id}');}});"
+              tbody << "<td><a id=\"#{link_id}\" href=\"javascript:void(0);\" " +
+                  "onclick=\"#{js};return false;\"" +
+                  ">#{add_to_cart_link_value}</a></td>\n"
+            end
+            if infer_access_ref
+              link_ref = columns[access_ref_col].value
+              tbody << "<td><a href=\"#{link_ref}\">#{access_ref_link_value}</a></td>\n"
+            end
+        
+            col_count = 0
+            columns.each do |td|
+              tbody << "<td>#{td.value}</td>\n" if infer_access_ref and col_count != access_ref_col
+              col_count += 1
+            end
+            tbody << "</tr>\n"
+            row_count += 1
+          end
+          tbody << "</tbody>"
+      
+          return tbody
+        end
+    
+        # Convert the specified table in the specified resource into an HTML
+        # table.
+        # [_id_:]
+        #  The ID to assign to the HTML table as a whole.
+        # [_add_to_cart_link_ref_:]
+        #  
+        # [_res_:]
+        #  The resource from which to extract the table in question.
+        # [_tbl_:]
+        #  The table inside the resource from which to extract the rows in question.
+        # [_infer_add_to_cart_ref_:]
+        #  
+        # [_add_to_cart_header_value_:]
+        # 
+        # [_add_to_cart_link_value_:]
+        # 
+        # [_infer_access_ref_:]
+        #  Link the access reference URL associated with a row.
+        # [_access_ref_header_value_:]
+        #  For the access reference column, place this value in the header.
+        # [_access_ref_link_value_:]
+        #  For the access reference column, link this word.
+        # [_show_border_:]
+        #  The boolean value to show HTML table border
+        # [_table_class_:]
+        #  The class to assign the HTML table as a whole.
+        # [_header_class_:]
+        #  The class to assign the header of the HTML table.
+        # [_body_class_:]
+        #  The class to assign the body of the HTML table.
+        # [_row_classes_:]
+        #  The class to assign the HTML table body rows.
+        def to_html(id=nil, add_to_cart_link_ref=nil, res=0, tbl=0,
+            infer_add_to_cart_ref=true,
+            add_to_cart_header_value='Add to Cart',
+            add_to_cart_link_value='Add',
+            infer_access_ref=true,
+            access_ref_header_value='URL',
+            access_ref_link_value='Retrieve',
+            show_border=false,
+            table_class='votable',
+            header_class='header',
+            body_class='body',
+            row_classes=['row1', 'row2'])
+          begin
+            # A valid SIA VOTable will only ever have one VOX:Image_AccessReference.
+            access_ref_col = image_access_reference_columns()
+        
+            if access_ref_col
+              # Create headers
+              thead = create_headers(res, tbl,
+                infer_add_to_cart_ref, add_to_cart_header_value,
+                infer_access_ref, access_ref_header_value, access_ref_col,
+                header_class)
+          
+              # Create body
+              tbody = create_body(res, tbl,
+                infer_add_to_cart_ref, add_to_cart_link_value, add_to_cart_link_ref,
+                infer_access_ref, access_ref_link_value, access_ref_col,
+                body_class, row_classes)
+          
+              return create_table(id, show_border, table_class, thead, tbody)
+            else
+              title = 'No Data'
+              message = 'VOTable not contains data.'
+              return create_message_table(table_class, header_class,
+                body_class, row_classes, title, message)
+            end
+        
+            rescue Exception => e
+              title = 'Error'
+              message = @resources[0].info[0].text().to_s()
+              table = create_message_table(table_class, header_class,
+                body_class, row_classes, title, message)
+          end
+        end
+    
+      end
+    end
+    
+  end
+end

data/lib/voruby/votables/data.rb

@@ -0,0 +1,179 @@
+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