Dictionary (LaBB-CAT backend 1.0.7 API)

java.lang.Object
- nzilbb.labbcat.server.api.APIRequestHandler
- - nzilbb.labbcat.server.api.results.Dictionary

```
public class Dictionary
extends APIRequestHandler
```
/api/results/dictionary : Generates a dictionary from search results.
Input HTTP parameters:
- threadId - The search task ID returned by a previous call to /api/search.
- definitionLayerId - (Optional) ID of the layer that provides the 'definition' of each entry. If not specified, a word-list is returned.
Output: A plain text file containing a dictionary generated from the given search results, with repeat words numbered in parentheses, e.g.
```
 tea    ti
 teach  tiJ
 teacher        tiJ@
 teacher(2)     tiJ@r
 teachers       tiJ@z
 teaching       tiJIN
 team   tim
 teams  timz
 tears  t7z
 tears(2)       t8z
```
Author:

Robert Fromont

Field Summary
- Fields inherited from class nzilbb.labbcat.server.api.APIRequestHandler
  SC_BAD_REQUEST, SC_CONFLICT, SC_FORBIDDEN, SC_INTERNAL_SERVER_ERROR, SC_METHOD_NOT_ALLOWED, SC_NOT_FOUND, SC_OK, SC_UNPROCESSABLE_CONTENT, SC_UNSUPPORTED_MEDIA_TYPE

Constructor Summary

Constructors
Constructor Description

Dictionary()
Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`get(RequestParameters parameters, OutputStream out, Consumer<String> fileName, Consumer<Integer> httpStatus)`	The GET method for the servlet.

Methods inherited from class nzilbb.labbcat.server.api.APIRequestHandler
GetSystemAttribute, init, writeResponse

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Dictionary
```
public Dictionary()
```
    Constructor
- Method Detail
  - get
```
public void get(RequestParameters parameters,
                OutputStream out,
                Consumer<String> fileName,
                Consumer<Integer> httpStatus)
```
    The GET method for the servlet.
    
    Parameters:
    
    parameters - Request parameter map.
    
    out - Response body output stream.
    
    fileName - Receives the filename for specification in the response headers.
    
    httpStatus - Receives the response status code, in case or error.