voruby 1.0.1

data/lib/voruby/votables/types.rb

@@ -0,0 +1,391 @@
+require 'uri'
+
+module VORuby
+  module VOTables
+    module VOTable
+
+      # Types of input that go into a VOTable.  Typically these enforce restrictions
+      # on string input formats and what not.
+      module Type
+    
+        # A class that represents a vanilla-flavoured string.
+        class AnyText
+          attr_reader :value
+      
+          # [_txt_:]
+          #  The text of the string.
+          def initialize(txt=nil)
+    		    @value = txt
+          end
+      
+          def to_s
+    		    "{#{@value}}"
+          end
+        end
+    
+        # A class representing a valid astronomical year.
+        class AstroYear
+          attr_reader :value
+          @@pattern = '^[JB]?[0-9]+([.][0-9]*)?$'
+      
+          # [_txt_:]
+          #  An astronomical year.  The allowed pattern is:
+          #  [JB]?[0-9]+([.][0-9]*)?$
+          # i.e. 2001, J2001, B2001, 2001.2 etc.
+          def initialize(txt=nil)
+    		    if txt and txt.match(@@pattern)
+    	  		  @value = txt
+    		    else
+    	  		  raise "Astro year '#{txt}' does not match #{@@pattern}"
+    		    end
+          end
+      
+          def to_s
+    		    "{#{@value}}"
+          end
+        end
+    
+        # A class representing a UCD, including UCD1+.
+        class UCDType
+          attr_reader :value
+          @@pattern = '^[A-Za-z0-9_.:;\-]*$'
+      
+          # [_txt_:]
+          #  A UCD.  The allowed pattern is:
+          #   ^[A-Za-z0-9_.:;\-]*$
+          #  i.e. phot.mag;em.opt.V, PHOT_JHN_V etc.
+          def initialize(txt=nil)
+    		    if txt and txt.match(@@pattern)
+    	  		  @value = txt
+    		    else
+    	  		  raise "UCD type '#{txt}' does not match #{@@pattern}"
+    		    end
+          end
+      
+          def to_s
+    		    "{#{@value}}"
+          end
+        end
+    
+        # A class representing a definition of an array size.
+        class ArrayDef
+          attr_reader :value
+          @@pattern = '^([0-9]+x)*[0-9]*[*]?(s\W)?$'
+      
+          # [_txt_:]
+          #  The text of the array size definition.  The allowed pattern is:
+          #    ^([0-9]+x)*[0-9]*[*]?(s\W)?$
+          #  i.e. *, 64x64x10*, etc.
+          def initialize(txt=nil)
+    		    if txt and txt.match(@@pattern)
+    	  		  @value = txt
+    		    else
+    	  		  raise "Array definition '#{txt}' does not match #{@@pattern}"
+    		    end
+          end
+      
+          def to_s
+    		    "{#{@value}}"
+          end
+        end
+    
+        # A class representing the encoding method of a document.
+        class EncodingType
+          attr_reader :value
+          @@types = ['gzip', 'base64', 'dynamic', 'none']
+      
+          # [_txt_:]
+          #  The encoding type.  Choices: gzip, base64, dynamic, none.
+          def initialize(txt=nil)
+    		    txt = 'none' if !txt
+    		    if @@types.include?(txt)
+    	  		  @value = txt
+    		    else
+    	  		  raise "Encoding type '#{txt}' is not valid.  Use one of: " +
+    	    		  @@types.join(', ')
+    		    end
+          end
+      
+          def to_s
+    		    "{#{@value}}"
+          end
+        end
+    
+        # A class representing a datatype.
+        class DataType
+          attr_reader :value
+          @@types = ['boolean', 'bit', 'unsignedByte', 'short', 'int',
+    				 'long', 'char', 'unicodeChar', 'float', 'double',
+    				 'floatComplex', 'doubleComplex']
+      
+          # [_txt_:]
+          #  The datatype.  Choices: boolean, bit, unsignedByte, short, int
+          #  long, char, unicodeChar, float, double, floatComplex, doubleComplex.
+          def initialize(txt=nil)
+    		    if txt and @@types.include?(txt)
+    	 		    @value = txt
+    		    else
+    	  		  raise "Data type '#{txt}' is not valid.  Use one of: " +
+    	    		  @@types.join(', ')
+    		    end
+          end
+      
+          def to_s
+    		    "{#{@value}}"
+          end
+        end
+    
+        # A class representing a precision type.
+        class PrecisionType
+          attr_reader :value
+          @@pattern = '^[EF]?[1-9][0-9]*$'
+      
+          # [_txt_:]
+          #  The precision type.  The allowed pattern is:
+          #    ^[EF]?[1-9][0-9]*$
+          #  i.e. F3, 5 etc.
+          def initialize(txt=nil)
+    		    if txt and txt.match(@@pattern)
+    	  		  @value = txt
+    		    else
+    	  		  raise "Precision type '#{txt}' does not match #{@@pattern}"
+    		    end
+          end
+      
+          def to_s
+    		    "{#{@value}}"
+          end
+        end
+    
+        # A class representing 'yes' or 'no'.
+        class YesNo
+          attr_reader :value
+      
+          # [_txt_:]
+          #  A text string with the value 'yes' or 'no'.
+          def initialize(txt=nil)
+    		    if txt and (txt.downcase == 'yes' or txt.downcase == 'no')
+    	  		  @value = txt.downcase
+    		    else
+    	  		  raise "YesNo '#{txt}' is not valid.  Use one of: yes, no"
+    		    end
+          end
+      
+          def to_s
+    		    "{#{@value}}"
+          end
+        end
+		
+    	# A class representing the type of coordinate system.
+        class CoordSystemType
+          attr_reader :value
+          @@systems = ['eq_FK4', 'eq_FK5', 'ICRS', 'ecl_FK4', 'ecl_FK5',
+    				   'galactic', 'supergalactic', 'xy', 'barycentric',
+    				   'geo_app']
+      
+          # [_txt_:]
+          #  The coordinate system type.  Choices: eq_FK4, ICRS, ecl_FK4,
+          #  ecl_FK5, galactic, supergalactic, xy, barycentric, geo_app.
+          def initialize(txt='eq_FK5')
+    		    if txt and @@systems.include?(txt)
+    	  		  @value = txt
+    		    else
+    	  		  raise "Coordinate system type '#{txt}' is not valid.  Use one of: " +
+    	    		  @@systems.join(', ')
+    		    end
+          end
+      
+          def to_s
+    		    "{#{@value}}"
+          end
+        end
+
+    	# A class representing a valid URI.	
+        class AnyURI
+          attr_reader :value
+      
+          # [_txt_:]
+          #  A string representing a _valid_ URI (e.g. one that Ruby's URI.parse
+          #  method recognizes.
+          def initialize(txt=nil)
+    		    begin
+    	  		  @value = URI.parse(URI.escape(txt))
+    		    rescue
+    	  		  raise "URI '#{txt}' is not valid: #{$!}"
+    		    end
+          end
+			
+          def to_s
+    		    "{#{@value.to_s}}"
+          end
+        end
+    
+        # A class representing the content role of a document.
+        class ContentRole
+          attr_reader :value
+          @@roles = ['query', 'hints', 'doc', 'location']
+      
+          # [_txt_:]
+          #  The content role.  Choices: query, hints, doc, location.
+          def initialize(txt=nil)
+    		    if txt and @@roles.include?(txt)
+    	  		  @value = txt
+    		    else
+    	  		  raise "Content role '#{txt}' is not valid.  Use one of: " +
+    	    		  @@roles.join(', ')
+    		    end
+          end
+      
+          def to_s
+    		    "{#{@value}}"
+          end
+        end
+    
+        # A class representing a type of stream.
+        class StreamType
+          attr_reader :value
+          @@types = ['locator', 'other']
+      
+          # [_txt_:]
+          #  The stream type.  Choices: locator, other.
+          def initialize(txt=nil)
+    		    if txt and @@types.include?(txt)
+    	  		  @value = txt
+    		    else
+    	  		  raise "Stream type '#{txt}' is not valid.  Use one of: " +
+    	    		  @@types.join(', ')
+    		    end
+          end
+      
+          def to_s
+    	      "{#{@value}}"
+          end
+        end
+    
+        # A class representing an actuator event.
+        class Actuate
+          attr_reader :value
+          @@events = ['onLoad', 'onRequest', 'other', 'none']
+      
+          # [_txt_:]
+          #  The event.  Choices: onLoad, onRequest, other, none.
+          def initialize(txt=nil)
+    		    if txt and @@events.include?(txt)
+    	  		  @value = txt
+    		    else
+    	  		  raise "Actuate event '#{txt}' is not valid:  " +
+    	    		  @@events.join(', ')
+    		    end
+          end
+      
+          def to_s
+    	      "{#{@value}}"
+          end
+        end
+    
+        # A class representing a positive integer.
+        class PositiveInteger
+          attr_reader :value
+      
+          # [_num_:]
+          #  An integer > 0.
+          def initialize(num=nil)
+    		    if num and num > 0
+    	  		  @value = num
+    		    else
+    	  		  raise "Positive integer #{num} must be > 0"
+    		    end
+          end
+      
+          def to_s
+    		    "{#{@value.to_s}}"
+          end
+        end
+    
+        # A class representing 0 or a positive integer.
+        class NonNegativeInteger
+          attr_reader :value
+      
+          # [_num_:]
+          #  An integer >= 0.
+          def initialize(num=nil)
+    		    if num and num >= 0
+    	  		  @value = num
+    		    else
+    	  		  raise "Non-negative integer #{num} must be >= 0"
+    		    end
+          end
+      
+          def to_s
+    		    "{#{@value.to_s}}"
+          end
+        end
+    
+        # A class representing a values type.
+        class ValuesType
+          attr_reader :value
+          @@types = ['legal', 'actual']
+      
+          # [_txt_:]
+          #  The type of values. Choices: legal, actual.
+          def initialize(txt=nil)
+    		    if txt and @@types.include?(txt)
+    	  		  @value = txt
+    		    else
+    	  		  raise "Values type '#{txt}' is not valid.  Use one of: " +
+    	    		  @@types.join(', ')
+    		    end
+          end
+      
+          def to_s
+    		    "{#{@value}}"
+          end
+        end
+    
+        # A class representing a resource type.
+        class ResourceType
+          attr_reader :value
+          @@types = ['results', 'meta']
+      
+          # [_txt_:]
+          #  The type of resource.  Choices: results, meta.
+          def initialize(txt=nil)
+    		    if txt and @@types.include?(txt)
+    	  		  @value = txt
+    		    else
+    	  		  raise "Resource type '#{txt}' is not valid.  Use one of: " +
+    	    		  @@types.join(', ')
+    		    end
+          end
+      
+          def to_s
+    		    "{#{@value}}"
+          end
+        end
+    
+        # A class representing a field type.
+        class FieldType
+          attr_reader :value
+          @@types = ['hidden', 'no_query', 'trigger', 'location']
+      
+          # [_txt_:]
+          #  The field type.  Choices: hidden, no_query, trigger, location.
+          def initialize(txt=nil)
+    		    if txt and @@types.include?(txt)
+    	  		  @value = txt
+    		    else
+    	  		  raise "Field type '#{txt}' is not valid.  Use one of: " +
+    	    		  @@types.join(', ')
+    		    end
+          end
+      
+          def to_s
+    		    "{#{@value}}"
+          end
+        end
+    
+      end
+    end
+    
+  end
+end