Changes between Version 1 and Version 2 of DataProviderInheritable


Ignore:
Timestamp:
07/05/05 14:00:31 (17 years ago)
Author:
joe
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • DataProviderInheritable

    v1 v2  
    2929== DESCRIPTION == 
    3030 
    31 VSO::DataProvider is an inheritable to allow organizations with archives of solar physics data to more easily create a web service to participate in the Virtual Solar Observatory project. 
     31VSO::!DataProvider is an inheritable to allow organizations with archives of solar physics data to more easily create a web service to participate in the Virtual Solar Observatory project. 
    3232 
    3333For more information about this project, please visit the VSO website: 
     
    3737== USAGE == 
    3838 
    39 The VSO::DataProvider module contains functions to handle the encoding 
     39The VSO::!DataProvider module contains functions to handle the encoding 
    4040and decoding of VSO messages.  VSO::DataProvider will perform some 
    4141basic sanity checks on the message, and then call specific functons to 
     
    5757==== _Search() ==== 
    5858   The _Search function handles the main processing for a VSO Query. 
    59     
     59 
    6060   The input is a hashref containing the search parameters.  The output should be either a VSO error message, or a VSO query response. 
    61     
     61 
    6262   Two helper functions are provided to handle the encapsulation of the response, _ThrowError() and _PackageResults() 
    63     
     63 
    6464   Please see the VSO website for an explaination of the formatting of a search request: 
    65     
     65 
    6666   http://www.virtualsolar.org/ 
    6767 
     
    8585==== _ProcessDataRequest() ==== 
    8686 
    87    The _ProcessDataRequest function handles the main processing for a VSO GetData request. 
     87   The _!ProcessDataRequest function handles the main processing for a VSO !GetData request. 
    8888 
    8989   The input is a hashref containing the search parameters.  The output should be either a VSO error message, or a VSO query response. 
    90     
     90 
    9191   Two helper functions are provided to handle the encapsulation of the response, _ThrowError() and _PackageData() 
    92     
    93    Please see the VSO website for an explaination of the formatting of a GetData request: 
    94     
     92 
     93   Please see the VSO website for an explaination of the formatting of a !GetData request: 
     94 
    9595   http://www.virtualsolar.org/ 
    9696 
     
    185185==== new() ==== 
    186186 
    187    Creates a new VSO::DataProvider object. 
     187   Creates a new VSO::!DataProvider object. 
    188188 
    189189==== Query() ==== 
     
    217217==== _NegotiateReturnMethod() ==== 
    218218 
    219    Given a VSO GetData request, it will return a hashref containing a 
     219   Given a VSO !GetData request, it will return a hashref containing a 
    220220   subset of the data transfer methods that the Data Provider supports. 
    221     
     221 
    222222   The function will return a hashref containing one of the following: 
    223     
     223 
    224224   * A single hash element, containing an empty array 
    225     
     225 
    226226      The key of the hash element is a mutually agreed upon data 
    227227      transfer method, and the client has supplied all required 
    228228      information for the method. 
    229     
     229 
    230230   * A single hash element, containg a non-empty array 
    231     
     231 
    232232      The key of the hash element is a mutually agreed upon data 
    233233      transfer method, but the client is missing required information 
    234234      to the method. 
    235     
     235 
    236236   * Multiple hash elements 
    237     
     237 
    238238      The keys of the hash are data transfer methods that the client 
    239239      may be interested in.  The list is generated by comparing the