OV-GSO-DC / VOTableLib

Commit 2d66da02df7d2ad78a3401285fca86e57311770f

Authored by Jean-Michel Glorian
1 parent 923f0ad3
Exists in master and in 1 other branch b6.0.X

move readme to root location

Showing 2 changed files with 28 additions and 43 deletions   Show diff stats
Inline Side-by-side
README.md
  Diff comments   View file @2d66da0
1 1 # VOTable
2 2  
3   -The VOTable library aims to provide methods to get and manage VOTables.
  3 +## Context
4 4  
5   -## Dependencies
  5 +This library aims to provide a simple way to parse and view VOTables. The goal is to make the code
  6 +reusable and as light as possible.
6 7  
7   -You need java 7 to execute EpnTAPClient.
  8 +## Usage in command-line interface
8 9  
9   -## GUI usage
  10 +### 1. Reading a VOTable from an XML file
10 11  
11   -Simply right-click on the jar and select *Open with* -> *Oracle Java 7 RunTime* (for example).
  12 + VOtableApp pathToVOTable
12 13  
13   -## CLI usage
  14 +- `pathToVOTable`: The path to your VOTable, ie `~/dowloads/my_votable.xml`.
14 15  
15   -No CLI usage are provided for now but this is planned.
16 16 \ No newline at end of file
  17 +This will display the VOTable stored in the specified XML file, through a minimalist window.
  18 +
  19 +### 2. Reading a VOTable from an on-line service
  20 +
  21 + VOtableApp targetURL type language query
  22 +
  23 +This will display the VOTable resulting the service or registry request.
  24 +
  25 +- `targetURL`: The URL of the service or registry to ask, ie `http://voparis-tap.obspm.fr/__system__/tap/run/tap`;
  26 +- `language`: The language of the query, ie `ADQL`;
  27 +- `query`: The query in the specified language in double quotes, ie. `SELECT TOP 3 * FROM apis.epn_core"`
  28 +
  29 +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`
  30 +
  31 +## Usage from a Java library
  32 +
  33 +Here is a start:
  34 +
  35 + VOTableController myVOTableController = new VOTableController(REGISTRY_URL, "ADQL", QUERY);
  36 +
  37 +See the Javadoc for more informations.
17 38 \ No newline at end of file
... ...
src/main/java/eu/omp/irap/vespa/votable/README.md deleted
View file @923f0ad
... ... @@ -1,36 +0,0 @@
1   -# VOTable
2   -
3   -## Context
4   -
5   -This library aims to provide a simple way to parse and view VOTables. The goal is to make the code
6   -reusable and as light as possible.
7   -
8   -## Usage in command-line interface
9   -
10   -### 1. Reading a VOTable from an XML file
11   -
12   - VOtableApp pathToVOTable
13   -
14   -- `pathToVOTable`: The path to your VOTable, ie `~/dowloads/my_votable.xml`.
15   -
16   -This will display the VOTable stored in the specified XML file, through a minimalist window.
17   -
18   -### 2. Reading a VOTable from an on-line service
19   -
20   - VOtableApp targetURL type language query
21   -
22   -This will display the VOTable resulting the service or registry request.
23   -
24   -- `targetURL`: The URL of the service or registry to ask, ie `http://voparis-tap.obspm.fr/__system__/tap/run/tap`;
25   -- `language`: The language of the query, ie `ADQL`;
26   -- `query`: The query in the specified language in double quotes, ie. `SELECT TOP 3 * FROM apis.epn_core"`
27   -
28   -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`
29   -
30   -## Usage from a Java library
31   -
32   -Here is a start:
33   -
34   - VOTableController myVOTableController = new VOTableController(REGISTRY_URL, "ADQL", QUERY);
35   -
36   -See the Javadoc for more informations.
37 0 \ No newline at end of file