Changes between Version 1 and Version 2 of DataProviderInheritable
- Timestamp:
- 07/05/05 14:00:31 (19 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
DataProviderInheritable
v1 v2 29 29 == DESCRIPTION == 30 30 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.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. 32 32 33 33 For more information about this project, please visit the VSO website: … … 37 37 == USAGE == 38 38 39 The VSO:: DataProvider module contains functions to handle the encoding39 The VSO::!DataProvider module contains functions to handle the encoding 40 40 and decoding of VSO messages. VSO::DataProvider will perform some 41 41 basic sanity checks on the message, and then call specific functons to … … 57 57 ==== _Search() ==== 58 58 The _Search function handles the main processing for a VSO Query. 59 59 60 60 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 62 62 Two helper functions are provided to handle the encapsulation of the response, _ThrowError() and _PackageResults() 63 63 64 64 Please see the VSO website for an explaination of the formatting of a search request: 65 65 66 66 http://www.virtualsolar.org/ 67 67 … … 85 85 ==== _ProcessDataRequest() ==== 86 86 87 The _ ProcessDataRequest function handles the main processing for a VSOGetData request.87 The _!ProcessDataRequest function handles the main processing for a VSO !GetData request. 88 88 89 89 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 91 91 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 95 95 http://www.virtualsolar.org/ 96 96 … … 185 185 ==== new() ==== 186 186 187 Creates a new VSO:: DataProvider object.187 Creates a new VSO::!DataProvider object. 188 188 189 189 ==== Query() ==== … … 217 217 ==== _NegotiateReturnMethod() ==== 218 218 219 Given a VSO GetData request, it will return a hashref containing a219 Given a VSO !GetData request, it will return a hashref containing a 220 220 subset of the data transfer methods that the Data Provider supports. 221 221 222 222 The function will return a hashref containing one of the following: 223 223 224 224 * A single hash element, containing an empty array 225 225 226 226 The key of the hash element is a mutually agreed upon data 227 227 transfer method, and the client has supplied all required 228 228 information for the method. 229 229 230 230 * A single hash element, containg a non-empty array 231 231 232 232 The key of the hash element is a mutually agreed upon data 233 233 transfer method, but the client is missing required information 234 234 to the method. 235 235 236 236 * Multiple hash elements 237 237 238 238 The keys of the hash are data transfer methods that the client 239 239 may be interested in. The list is generated by comparing the