Blame view

README.md 1.23 KB
ff1c1b4c   Nathanael Jourdane   Initial commit on...
1
2
# VOTable

2d66da02   Jean-Michel Glorian   move readme to ro...
3
## Context
ff1c1b4c   Nathanael Jourdane   Initial commit on...
4

2d66da02   Jean-Michel Glorian   move readme to ro...
5
6
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.
ff1c1b4c   Nathanael Jourdane   Initial commit on...
7

2d66da02   Jean-Michel Glorian   move readme to ro...
8
## Usage in command-line interface
ff1c1b4c   Nathanael Jourdane   Initial commit on...
9

2d66da02   Jean-Michel Glorian   move readme to ro...
10
### 1. Reading a VOTable from an XML file
ff1c1b4c   Nathanael Jourdane   Initial commit on...
11

2d66da02   Jean-Michel Glorian   move readme to ro...
12
    VOtableApp pathToVOTable
ff1c1b4c   Nathanael Jourdane   Initial commit on...
13

2d66da02   Jean-Michel Glorian   move readme to ro...
14
- `pathToVOTable`: The path to your VOTable, ie `~/dowloads/my_votable.xml`.
ff1c1b4c   Nathanael Jourdane   Initial commit on...
15

2d66da02   Jean-Michel Glorian   move readme to ro...
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
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.

- `targetURL`: The URL of the service or registry to ask, ie `http://voparis-tap.obspm.fr/__system__/tap/run/tap`;
- `language`: The language of the query, ie `ADQL`;
- `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`

## Usage from a Java library

Here is a start:

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

See the Javadoc for more informations.