Blame view

src/main/java/eu/omp/irap/vespa/epntapclient/votable/README.md 1.23 KB
5105d11b   Nathanael Jourdane   Add readme for VO...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# VOTable

## Context

This library aims to provide a simple way to parse and view VOTables. The goal is to make the code 
reusable and as light as possible.

## Usage in command-line interface

### 1. Reading a VOTable from an XML file

    VOtableApp pathToVOTable

- `pathToVOTable`: The path to your VOTable, ie `~/dowloads/my_votable.xml`.

This will display the VOTable stored in the specified XML file, through a minimalist window.

### 2. Reading a VOTable from an on-line service

    VOtableApp targetURL type language query

This will display the VOTable resulting the service or registry request.

0be39b76   Nathanael Jourdane   Update query example
24
- `targetURL`: The URL of the service or registry to ask, ie `http://voparis-tap.obspm.fr/__system__/tap/run/tap`;
5105d11b   Nathanael Jourdane   Add readme for VO...
25
- `language`: The language of the query, ie `ADQL`;
0be39b76   Nathanael Jourdane   Update query example
26
27
28
- `query`: The query in the specified language in double quotes, ie. `SELECT TOP 3 * FROM apis.epn_core"`

The examples above send this query: `http://voparis-tap.obspm.fr/__system__/tap/run/tap/sync?REQUEST=doQuery&LANG=ADQL&FORMAT=votable&QUERY=SELECT%20TOP%201%2A%20FROM%20apis%2Eepn%5Fcore`
5105d11b   Nathanael Jourdane   Add readme for VO...
29
30
31
32
33
34
35
36

## Usage from a Java library

Here is a start:

    VOTableController myVOTableController = new VOTableController(REGISTRY_URL, "ADQL", QUERY);

See the Javadoc for more informations.