voruby 1.0.1

data/lib/voruby/resources/vodataservice/vodataservice_v1_0.rb

@@ -0,0 +1,221 @@
+require 'voruby/resources/vodataservice/loader'
+
+require 'voruby/resources/voresource/voresource_v1_0'
+
+include VORuby::Resources::VOResource::V1_0
+
+module VORuby
+  module Resources
+    module VODataService
+      module V1_0
+        
+        # Forward declarations
+        class Format; end
+        class Coverage; end
+        class ServiceReference < AnyURI; end
+        class Waveband; end
+        class Catalog; end
+        class Table; end
+        class BaseParam; end
+        class TableParam < BaseParam; end
+        class VOTScalarDataType; end
+        class TableDataType < VOTScalarDataType; end
+        class DataCollection < Resource; end
+        class StandardSTC < Resource; end
+        class DataService < Service; end
+        class ParamHTTP < Interface; end
+        class HTTPQueryType; end
+        class InputParam < BaseParam; end
+        class ParamUse; end
+        class SimpleScalarDataType; end
+        class SimpleDataType < SimpleScalarDataType; end
+        class CatalogService < DataService; end
+        class TableService < Service; end
+        class ArrayShape; end
+        
+        # An expression of a the shape of a multi-dimensional array of the form LxNxM... where each value between gives the
+        # integer length of the array along a dimension.  An asterisk (*) as the last dimension of the shape indicates 
+        # that the length of the last axis is variable or undetermined.
+        class ArrayShape
+          include XML::Mapping
+          
+          text_node :value, '', :optional => false
+
+          def value=(shape)
+            raise RuntimeError, "ArrayShape '#{shape}' in wrong format" if !shape.match(/^([0-9]+x)*[0-9]*[*]?$/)
+
+            @value = shape
+          end
+        end
+
+        # A logical grouping of data which, in general, is composed of one or more accessible datasets.  A collection can contain any
+        # combination of images, spectra, catalogs, or other data.
+        class DataCollection
+          object_node :coverage, 'coverage', :class => Coverage, :optional => true
+          object_node :access_url, 'accessURL', :class => VOResource::V1_0::AccessURL, :optional => true
+
+          array_node :facilities, 'facility', :class => VOResource::V1_0::ResourceName, :optional => true, :default_values => []
+          array_node :instruments, 'instrument', :class => VOResource::V1_0::ResourceName, :optional => true, :default_values => []
+          array_node :rights, 'rights', :class => VOResource::V1_0::Rights, :optional => true, :default_values => []
+          array_node :formats, 'format', :class => Format, :optional => true, :default_values => []
+          array_node :catalogs, 'catalog', :class => Catalog, :optional => true, :default_values => []
+        end
+
+        # The physical or digital manifestation of the information supported by a resource.
+        class Format
+          include XML::Mapping
+
+          text_node :value, '', :optional => false
+          boolean_node :is_mime_type, '@isMIMEType', 'true', 'false', :optional => false, :default_value => 'false'
+        end
+
+        # Extent of the content of the resource over space, time, and frequency.
+        # Coverage includes an STCResourceProfile which I haven't implemented yet.
+        class Coverage
+          include XML::Mapping
+
+          # object_node :stc_resource_profile, 'STCResourceProfile', :class => STC::STCResourceProfile, :optional => true
+          object_node :footprint, 'footprint', :class => ServiceReference, :optional => true
+
+          array_node :wavebands, 'waveband', :class => Waveband, :optional => true, :default_values => []
+        end
+
+        # The service URL for a potentially registerd service.  That is, if an IVOA identifier is also provided, then the service is 
+        # described in a registry.
+        class ServiceReference
+          object_node :ivo_id, '@ivo-id', :class => VOResource::V1_0::IdentifierURI, :optional => true
+        end
+
+        # A detailed description of a logically-related set of tables.
+        class Catalog
+          include XML::Mapping
+
+          array_node :tables, 'table', :class => Table, :optional => true, :default_values => []
+        end
+
+        # A description of a parameter that places no restriction on the parameter's data type.
+        class BaseParam
+          include XML::Mapping
+
+          text_node :name, 'name', :optional => true
+          text_node :description, 'description', :optional => true
+          text_node :unit, 'unit', :optional => true
+          text_node :ucd, 'ucd', :optional => true
+        end
+
+        # A description of a table parameter having a fixed data type.
+         class TableParam
+           boolean_node :std, '@std', 'true', 'false', :optional => true
+
+           object_node :data_type, 'dataType', :class => TableDataType, :optional => true
+         end
+
+        # A scalar data type name taken controlled set that corresponds closely to VOTable data types.
+        class VOTScalarDataType
+          include XML::Mapping
+
+          text_enumeration_node :value, '', :optional => false,
+            :choices => ['boolean', 'bit', 'unsignedByte', 'short', 'int', 'long',
+                        'char', 'unicodeChar', 'float', 'double', 'floatComplex',
+                        'doubleComplex', 'string']
+        end
+
+        # A (VOTable-supported) data type
+        class TableDataType
+          object_node :arraysize, '@arraysize', :class => ArrayShape, :optional => true
+        end
+
+        # A description of a table and its columns.
+        class Table
+           include XML::Mapping
+
+           text_node :name, 'name', :optional => true
+           text_node :description, 'description', :optional => true
+           text_node :role, '@role', :optional => true
+
+           array_node :columns, 'column', :class => TableParam, :optional => true, :default_values => []
+        end
+
+        # A description of standard space-time coordinate systems, positions, and regions.
+        # We need a full STC description to use this...
+        class StandardSTC
+          #array_node :stc_resource_profile, 'STCResourceProfile', :class => STC::STCResourceProfile,
+          #  :optional => true, :default_values => []
+        end
+    
+        # A service for accessing astronomical data.
+        class DataService
+          object_node :coverage, 'coverage', :class => Coverage, :optional => true
+      
+          array_node :facilities, 'facility', :class => VOResource::V1_0::ResourceName, :optional => true, :default_values => []
+          array_node :instruments, 'instrument', :class => VOResource::V1_0::ResourceName, :optional => true, :default_values => []
+        end
+    
+        # A service invoked via an HTTP Query (either Get or Post) with a set of arguments consisting of keyword name-value pairs.
+        class ParamHTTP
+          text_node :result_type, 'resultType', :optional => false
+      
+          array_node :query_type, 'queryType', :class => HTTPQueryType, :optional => true, :default_values => []
+          array_node :param, 'param', :class => InputParam, :optional => true, :default_values => []
+        end
+    
+        # The type of HTTP request, either GET or POST.
+        class HTTPQueryType
+          include XML::Mapping
+      
+          text_enumeration_node :value, '', :optional => false,
+            :choices => ['GET', 'POST']
+        end
+    
+        # A description of a service or function parameter having a fixed data type.
+        class InputParam
+          boolean_node :std, '@std', 'true', 'false', :optional => true, :default => 'true'
+      
+          object_node :data_type, 'dataType', :class => SimpleDataType, :optional => true
+          object_node :use, '@use', :class => ParamUse, :default => 'optional'
+        end
+    
+        # The parameter is required for the application or service to work properly.
+        class ParamUse
+          include XML::Mapping
+      
+          text_enumeration_node :value, '', :optional => false,
+            :choices => ['required', 'optional', 'ignored']
+        end
+    
+        # A scalar data type name taken from a small controlled set that does not imply a size nor precise format.
+        class SimpleScalarDataType
+          include XML::Mapping
+      
+          text_enumeration_node :value, '', :optional => false,
+            :choices => ['integer', 'real', 'complex', 'boolean', 'char', 'string']
+        end
+    
+        # A simple data type that does not imply a size nor precise format.
+        class SimpleDataType
+          object_node :arraysize, '@arraysize', :class => ArrayShape, :optional => true
+        end
+    
+        # A service that interacts with one or more specified tables having some coverage of the sky, time, and/or frequency.
+        class CatalogService
+          array_node :tables, 'table', :class => Table, :optional => true, :default_values => []
+        end
+    
+        # A service that returns or otherwise interacts with one or more specified tables.
+        class TableService
+          array_node :facilities, 'facility', :class => VOResource::V1_0::ResourceName, :optional => true, :default_values => []
+          array_node :instruments, 'instrument', :class => VOResource::V1_0::ResourceName, :optional => true, :default_values => []
+          array_node :tables, 'table', :class => Table, :optional => true, :default_values => []
+        end
+        
+        class Waveband
+          include XML::Mapping
+
+          text_enumeration_node :value, '', :optional => false,
+            :choices => ['Radio', 'Millimeter', 'Infrared', 'Optical', 'UV', 'EUV', 'X-ray', 'Gamma-ray']
+        end
+        
+      end
+    end
+  end
+end

data/lib/voruby/resources/voregistry/loader.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'xml/mapping'
+
+require 'voruby/loader'

data/lib/voruby/resources/voregistry/voregistry.rb

@@ -0,0 +1,9 @@
+require 'voruby/resources/voregistry/voregistry_v1_0'
+
+module VORuby
+  module Resources
+    module VORegistry
+      #include VORegistry::V1_0
+    end
+  end
+end

data/lib/voruby/resources/voregistry/voregistry_v0_2.rb

@@ -0,0 +1,40 @@
+require 'voruby/resources/voregistry/loader'
+require 'voruby/resources/voresource/voresource_v0_9'
+
+include VORuby::Resources::VOResource::V0_9
+
+module VORuby
+  module Resources
+    module VORegistry
+      module V0_2
+        
+        # Forward declarations
+        class RegistryType < ServiceType; end
+        class Registry < RegistryType; end
+        class ManagedAuthority < AuthorityIDType; end
+        class AuthorityType < ResourceType; end
+        class Authority < AuthorityType; end
+        class ManagingOrg < IdentifierType; end
+        
+        # A service that provides access to descriptions of resources.
+        class Registry; end
+        class RegistryType
+          array_node :managed_authorities, 'ManagedAuthority', :class => ManagedAuthority, :optional => false
+        end
+        
+        # An authority identifier managed by a registry.
+        class ManageAuthority; end
+        
+        # A naming authority; an assertion of control over a namespace represented by an authority identifier.
+        class Authority; end
+        class AuthorityType
+          object_node :managing_org, 'ManagingOrg', :class => ManagingOrg, :optional => true
+        end
+        
+        # A reference to an organization that manages something.
+        class ManagingOrg; end
+        
+      end
+    end
+  end
+end

data/lib/voruby/resources/voregistry/voregistry_v0_3.rb

@@ -0,0 +1,30 @@
+require 'voruby/resources/voregistry/loader'
+require 'voruby/resources/voresource/voresource_v0_10'
+
+include VORuby::Resources::VOResource::V0_10
+
+module VORuby
+  module Resources
+    module VORegistry
+      module V0_3
+        
+        # Forward declarations
+        class Registry < Service; end
+        class Authority < Resource; end
+        
+        # A service that provides access to descriptions of resources.
+        class Registry
+          # an authority identifier managed by a registry
+          array_node :managed_authorities, 'managedAuthority', :class => AuthorityID, :optional => true, :default_value => []
+        end
+        
+        # A naming authority; an assertion of control over a namespace represented by an authority identifier.
+        class Authority
+          # the organization that manages or owns the this authority
+          object_node :managing_org, 'managingOrg', :class => ResourceName, :optional => true
+        end
+        
+      end
+    end
+  end
+end

data/lib/voruby/resources/voregistry/voregistry_v1_0.rb

@@ -0,0 +1,86 @@
+require 'voruby/resources/voregistry/loader'
+require 'voruby/resources/voresource/voresource_v1_0'
+
+include VORuby::Resources::VOResource::V1_0
+
+module VORuby
+  module Resources
+    module VORegistry
+      module V1_0
+      
+        # Forward declarations
+        class Registry < Service; end
+        class RegCapRestriction < Capability; end
+        class Harvest < RegCapRestriction; end
+        class ExtensionSearchSupport; end
+        class OptionalProtocol; end
+        class OAIHTTP < Interface; end
+        class OAISOAP < WebService; end
+        class Authority < Resource; end
+        class Search < RegCapRestriction; end
+    
+        # A service that provides access to descriptions of resources.
+        class Registry
+          boolean_node :full, 'full', 'true', 'false', :optional => true, :default_value => false
+      
+          array_node :managed_authorities, 'managedAuthority', :class => AuthorityID,
+            :optional => true, :default_values => []
+        end
+    
+        # An abstract capability that fixes the standardID to the IVOA ID for the Registry standard.
+        class RegCapRestriction
+          def standard_id=(id)
+            @standard_id = URI.parse('ivo://ivoa.net/std/Registry')
+          end
+        end
+    
+        # The capabilities of the Registry Harvest implementation.
+        class Harvest
+          numeric_node :max_records, 'maxRecords', :optional => false, :default_value => 0
+        end
+    
+        # The level of support provided for searching against metadata defined in a legal VOResource extension schema.
+        class ExtensionSearchSupport
+          include XML::Mapping
+      
+          text_enumeration_node :value, '', :optional => false,
+            :choices => ['core', 'partial', 'full']
+        end
+    
+        # The name of an optional advanced search protocol supported.
+        class OptionalProtocol
+          include XML::Mapping
+      
+          text_enumeration_node :value, '', :optional => false,
+            :choices => ['XQuery']
+        end
+    
+        # A description of the standard OAI PMH interface using HTTP (GET or POST) queries.
+        class OAIHTTP
+          #
+        end
+    
+        # A description of the standard OAI PMH interface using a SOAP Web Service interface.
+        class OAISOAP
+          #
+        end
+    
+        # A naming authority; an assertion of control over a namespace represented by an authority identifier.
+        class Authority
+          object_node :managing_org, 'managingOrg', :class => ResourceName, :optional => true
+        end
+    
+        # The capabilities of the Registry Search implementation.
+        class Search
+          numeric_node :max_records, 'maxRecords', :optional => false, :default_value => 0
+      
+          object_node :extension_search_support, 'extensionSearchSupport', :class => ExtensionSearchSupport, :optional => false
+      
+          array_node :optional_protocol, 'optionalProtocol', :class => OptionalProtocol,
+            :optional => true, :default_values => []
+        end
+        
+      end
+    end
+  end
+end

data/lib/voruby/resources/voresource/loader.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'xml/mapping'
+require 'uri'
+
+require 'voruby/resources/loader'
+require 'voruby/resources/nodes'
+
+# Register specialized node types.
+XML::Mapping.add_node_class(VORuby::VOResource::Mapping::DateTimeNode)
+XML::Mapping.add_node_class(VORuby::VOResource::Mapping::JulianDateTimeNode)
+XML::Mapping.add_node_class(VORuby::VOResource::Mapping::UtcTimestampNode)
+XML::Mapping.add_node_class(VORuby::VOResource::Mapping::UtcDateTimeNode)
+XML::Mapping.add_node_class(VORuby::VOResource::Mapping::TextEnumerationNode)
+XML::Mapping.add_node_class(VORuby::VOResource::Mapping::NumericEnumerationNode)
+XML::Mapping.add_node_class(VORuby::VOResource::Mapping::FullObjectNode)
+XML::Mapping.add_node_class(VORuby::VOResource::Mapping::FullArrayNode)
+XML::Mapping.add_node_class(VORuby::VOResource::Mapping::TextFloatArrayNode)

data/lib/voruby/resources/voresource/voresource.rb

@@ -0,0 +1,9 @@
+require 'voruby/resources/voresource/voresource_v1_0'
+
+module VORuby
+  module Resources
+    module VOResource
+      #include VOResource::V1_0
+    end
+  end
+end