javadoc
[mkjsf-moved-to-github.git] / src / main / java / com / indexdata / mkjsf / pazpar2 / data / package-info.java
1 /**\r
2  * Pazpar2 responses produced by Pazpar2 commands are parsed by the\r
3  * ResponseParser, which outputs response data objects that are accessible to the UI\r
4  * through the class Responses. \r
5  * \r
6  * <p>Responses is exposed to the UI as <code>pzresp</code></p>\r
7  * \r
8  * <p>Examples:</p>\r
9  * <ul>\r
10  *  <li><code>pzresp.show.hits<code> returns a list of hits from the most recent show command</li>\r
11  *  <li><code>pzresp.show.hits.[0]</code> returns the first hit</li>\r
12  *  <li><code>pzresp.show.hits.[0].author</code> returns the author attribute of the first hit</li>\r
13  *  <li><code>pzresp.show.hits.[0].getOneValue("my-hit-field")</code> returns an arbitrary attribute of the data object</li>\r
14  * </ul>  \r
15  * \r
16  */\r
17 package com.indexdata.mkjsf.pazpar2.data;