Package nzilbb.labbcat.server.api

Class Attributes

java.lang.Object

nzilbb.labbcat.server.api.APIRequestHandler

nzilbb.labbcat.server.api.Attributes

public class Attributes
extends APIRequestHandler

/api/attributes : Exports selected attributes for specified transcripts to CSV.

The request method can be GET or POST

Parameters:

id - One or more graph IDs.

query - AGQL expression to identify the graph IDs, if no id parameter is supplied.

layer - One or more layer IDs, representing transcript attribute layers, or "transcript", "epsiode", or "corpus" .

name - Optional name of the file.

csvFieldDelimiter - Optional delimiter for CSV file (comma is used by default).

Output: A CSV file with a column for each attribute, and a row for each transcript.

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
Attributes()	Constructor

Method Summary

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

Attributes

public Attributes()

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 stream.

fileName - Receives the filename for specification in the response headers.

httpStatus - Receives the response status code, in case or error.