Index
All Classes and Interfaces|All Packages|Serialized Form
A
- addColumn() - Method in class nzilbb.labbcat.PatternBuilder
-
Adds a column to the search matrix.
- addColumn(int) - Method in class nzilbb.labbcat.PatternBuilder
-
Adds a column to the search matrix.
- addDictionaryEntry(String, String, String, String) - Method in class nzilbb.labbcat.LabbcatEdit
-
Adds an entry to a dictionary.
- addLayerDictionaryEntry(String, String, String) - Method in class nzilbb.labbcat.LabbcatEdit
-
Adds an entry to a layer dictionary.
- addMatchLayer(String, String) - Method in class nzilbb.labbcat.PatternBuilder
-
Adds a layer for matching a regular expression.
- addMaxLayer(String, double) - Method in class nzilbb.labbcat.PatternBuilder
-
Adds a layer for matching a maximum value.
- addMaxLayer(String, int) - Method in class nzilbb.labbcat.PatternBuilder
-
Adds a layer for matching a maximum value.
- addMinLayer(String, double) - Method in class nzilbb.labbcat.PatternBuilder
-
Adds a layer for matching a minimum value.
- addMinLayer(String, int) - Method in class nzilbb.labbcat.PatternBuilder
-
Adds a layer for matching a minimum value.
- addNotMatchLayer(String, String) - Method in class nzilbb.labbcat.PatternBuilder
-
Adds a layer for not matching a regular expression.
- addRangeLayer(String, double, double) - Method in class nzilbb.labbcat.PatternBuilder
-
Adds a layer for matching a minimum to maximum range.
- addRangeLayer(String, int, int) - Method in class nzilbb.labbcat.PatternBuilder
-
Adds a layer for matching a minimum to maximum range.
- adminUrl(String) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Constructs a store URL for the given resource.
- aggregateMatchingAnnotations(String, String) - Method in class nzilbb.labbcat.LabbcatView
-
Identifies a list of annotations that match a particular pattern, and aggregates their labels.
- AnnotatorDescriptorWrapper - Class in nzilbb.labbcat.model
-
Client-side annotator descriptor that can be deserialized from JSON.
- AnnotatorDescriptorWrapper() - Constructor for class nzilbb.labbcat.model.AnnotatorDescriptorWrapper
-
Default constructor.
- annotatorExt(String, String) - Method in class nzilbb.labbcat.LabbcatEdit
-
Retrieve an annotator's given "ext" resource.
- annotatorExt(String, String, String[]) - Method in class nzilbb.labbcat.LabbcatEdit
-
Retrieve an annotator's given "ext" resource.
B
- build() - Method in class nzilbb.labbcat.PatternBuilder
-
Construct a valid pattern object for passing to
LabbcatView.search(JsonObject,String[],String[],boolean,Integer,Integer,Integer)
.
C
- cancel() - Method in class nzilbb.labbcat.http.HttpRequestPostMultipart
-
Cancel the current request
- cancel() - Method in class nzilbb.labbcat.LabbcatView
-
Cancel the current request, if possible.
- cancelTask(String) - Method in class nzilbb.labbcat.LabbcatView
-
Cancels a running task.
- Category - Class in nzilbb.labbcat.model
-
Attribute category record.
- Category() - Constructor for class nzilbb.labbcat.model.Category
-
Default constructor.
- Category(JsonObject) - Constructor for class nzilbb.labbcat.model.Category
-
Constructor from JSON.
- checkForErrors() - Method in class nzilbb.labbcat.Response
-
Convenience method for checking whether the response any errors.
- CommandLine - Class in nzilbb.labbcat.util
-
Command-line utility for making ad-hoc LaBB-CAT API calls.
- CommandLine() - Constructor for class nzilbb.labbcat.util.CommandLine
-
Default constructor.
- Corpus - Class in nzilbb.labbcat.model
-
Corpus record.
- Corpus() - Constructor for class nzilbb.labbcat.model.Corpus
-
Default constructor.
- Corpus(JsonObject) - Constructor for class nzilbb.labbcat.model.Corpus
-
Constructor from JSON.
- countAnnotations(String, String, Integer) - Method in class nzilbb.labbcat.LabbcatView
-
Gets the number of annotations on the given layer of the given transcript, but only those with an ordinal less than or equal to the given maximum.
- countMatchingAnnotations(String) - Method in class nzilbb.labbcat.LabbcatView
-
Counts the number of annotations that match a particular pattern.
- countMatchingParticipantIds(String) - Method in class nzilbb.labbcat.LabbcatView
-
Counts the number of participants that match a particular pattern.
- countMatchingTranscriptIds(String) - Method in class nzilbb.labbcat.LabbcatView
-
Counts the number of transcripts that match a particular pattern.
- createAnnotation(String, String, String, String, String, Integer, String) - Method in class nzilbb.labbcat.LabbcatEdit
-
Creates an annotation starting at from and ending at to.
- createCategory(Category) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Creates a new category record.
- createCorpus(Corpus) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Creates a new corpus record.
- createMediaTrack(MediaTrack) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Creates a new media track record.
- createProject(Project) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Deprecated, for removal: This API element is subject to removal in a future version.
- createRole(Role) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Creates a new role record.
- createRolePermission(RolePermission) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Creates a new role permission record.
- createUser(User) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Creates a new user record.
D
- delete(String) - Method in class nzilbb.labbcat.LabbcatView
-
Constructs a DELETE request for the given resource.
- deleteCategory(String, String) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Deletes an existing category record.
- deleteCategory(Category) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Deletes an existing category record.
- deleteCorpus(String) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Deletes an existing corpus record.
- deleteCorpus(Corpus) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Deletes an existing corpus record.
- deleteLayer(String) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Deletes the given layer, and all associated annotations.
- deleteLexicon(String) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Delete a previously loaded lexicon.
- deleteMatchingAnnotations(String) - Method in class nzilbb.labbcat.LabbcatEdit
-
Deletes all annotations that match a particular pattern
- deleteMedia(String, String) - Method in class nzilbb.labbcat.LabbcatEdit
-
Delete a given media or episode document file.
- deleteMediaTrack(String) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Deletes an existing media track record.
- deleteMediaTrack(MediaTrack) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Deletes an existing media track record.
- deleteParticipant(String) - Method in class nzilbb.labbcat.LabbcatEdit
-
Deletes the given participant, and all associated meta-data.
- deleteProject(String) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Deprecated, for removal: This API element is subject to removal in a future version.Projects are now layer categories - a type of
Category
with classId = "layer". UseLabbcatAdmin.deleteCategory(String,String)
instead. - deleteProject(Project) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Deprecated, for removal: This API element is subject to removal in a future version.Projects are now layer categories - a type of
Category
with classId = "layer". UseLabbcatAdmin.deleteCategory(Category)
instead - deleteRole(String) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Deletes an existing role record.
- deleteRole(Role) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Deletes an existing role record.
- deleteRolePermission(String, String) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Deletes an existing role permission record.
- deleteRolePermission(RolePermission) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Deletes an existing role permission record.
- deleteTranscript(String) - Method in class nzilbb.labbcat.LabbcatEdit
-
Deletes the given transcript, and all associated files.
- deleteUser(String) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Deletes an existing user record.
- deleteUser(User) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Deletes an existing user record.
- deregisterDeserializer(GraphDeserializer) - Method in class nzilbb.labbcat.LabbcatAdmin
-
NOT YET IMPLEMENTED - De-registers a transcript deserializer.
- deregisterSerializer(GraphSerializer) - Method in class nzilbb.labbcat.LabbcatAdmin
-
NOT YET IMPLEMENTED - De-registers a transcript serializer.
- deserializerForFilesSuffix(String) - Method in class nzilbb.labbcat.LabbcatView
-
NOT YET IMPLEMENTED - Gets the deserializer for the given file suffix (extension).
- deserializerForMimeType(String) - Method in class nzilbb.labbcat.LabbcatView
-
NOT YET IMPLEMENTED - Gets the deserializer for the given MIME type.
- destroyAnnotation(String, String) - Method in class nzilbb.labbcat.LabbcatEdit
-
Destroys the annotation with the given ID.
E
- editUrl(String) - Method in class nzilbb.labbcat.LabbcatEdit
-
Constructs a URL for the given resource.
F
- FileNameFromContentDisposition(String) - Static method in class nzilbb.labbcat.LabbcatView
-
Infers the filename from a given Content-Disposition header.
G
- generateLayer(String) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Generates annotations on a given layer for all transcripts in the corpus.
- get() - Method in class nzilbb.labbcat.http.HttpRequestGet
-
Fetches the request response
- get(String) - Method in class nzilbb.labbcat.LabbcatView
-
Constructs a GET request for the given resource.
- getAfterMatch() - Method in class nzilbb.labbcat.model.Match
-
Getter for
Match.AfterMatch
: The context after the match. - getAnchors(String, String[]) - Method in class nzilbb.labbcat.LabbcatView
-
Gets the given anchors in the given transcript.
- getAnnotations(String, String, Integer, Integer, Integer) - Method in class nzilbb.labbcat.LabbcatView
-
Gets the annotations on the given layer of the given transcript, but only those with an ordinal less than or equal to the given maximum.
- getAnnotatorDescriptor(String) - Method in class nzilbb.labbcat.LabbcatView
-
Gets a descriptor of the annotator with the given ID.
- getAnnotatorId() - Method in class nzilbb.labbcat.model.AnnotatorDescriptorWrapper
-
Getter for
AnnotatorDescriptorWrapper.annotatorId
: Annotator ID. - getAttribute() - Method in class nzilbb.labbcat.model.SystemAttribute
-
Getter for
SystemAttribute.attribute
: ID of the attribute. - getAttributes() - Method in class nzilbb.labbcat.model.MatchId
-
Getter for
attributes
: Other attributes in the MatchId. - getAuthorization() - Method in class nzilbb.labbcat.http.HttpRequestGet
-
Getter for
HttpRequestGet.sAuthorization
: The HTTP authorization string, or null if not required. - getAvailableMedia(String) - Method in class nzilbb.labbcat.LabbcatView
-
List the media available for the given transcript.
- getBaseUrl() - Method in class nzilbb.labbcat.http.HttpRequestGet
-
Getter for
HttpRequestGet.urlBaseUrl
: Base URL for the request - getBatchMode() - Method in class nzilbb.labbcat.LabbcatView
-
Getter for
LabbcatView.batchMode
: Whether to run in batch mode or not. - getBeforeMatch() - Method in class nzilbb.labbcat.model.Match
-
Getter for
Match.BeforeMatch
: The context before the match. - getCategory() - Method in class nzilbb.labbcat.model.Category
-
Getter for
Category.category
: The name/id of the category. - getClassId() - Method in class nzilbb.labbcat.model.Category
-
Getter for
Category.classId
: What kind of attributes are categorised - "transcript", "speaker", or "layer". - getClientDelay() - Method in class nzilbb.labbcat.util.LoadTester
-
Getter for
LoadTester.clientDelay
: Number of seconds to wait before starting each new client. - getClients() - Method in class nzilbb.labbcat.util.LoadTester
-
Getter for
LoadTester.clients
: Number of clients to simulate. - getCode() - Method in class nzilbb.labbcat.Response
-
Getter for
Response.code
: The request code. - getConfigParameterInfo() - Method in class nzilbb.labbcat.model.AnnotatorDescriptorWrapper
-
Getter for
AnnotatorDescriptorWrapper.configParameterInfo
: HTML-encoded definition of the installation config parameters, including a list of all parameters, and the encoding of the parameter string, for displaying to users who wish to configure the annotator programmatically. - getConnection() - Method in class nzilbb.labbcat.http.HttpRequestGet
-
Fetches the request response
- getCorpus() - Method in class nzilbb.labbcat.model.Match
-
Getter for
Match.Corpus
: The corpus the match comes from - getCorpusId() - Method in class nzilbb.labbcat.model.Corpus
-
Getter for
Corpus.corpusId
: Database key value. - getCorpusIds() - Method in class nzilbb.labbcat.LabbcatView
-
Gets a list of corpus IDs.
- getDescription() - Method in class nzilbb.labbcat.model.Category
-
Getter for
Category.description
: The description of the category. - getDescription() - Method in class nzilbb.labbcat.model.Corpus
-
Getter for
Corpus.description
: Description of corpus. - getDescription() - Method in class nzilbb.labbcat.model.MediaTrack
-
Getter for
MediaTrack.description
: Description of the media track. - getDescription() - Method in class nzilbb.labbcat.model.Role
-
Getter for
Role.description
: Description of the role. - getDescription() - Method in class nzilbb.labbcat.model.SystemAttribute
-
Getter for
SystemAttribute.description
: User-facing (long) description of the attribute. - getDeserializerDescriptors() - Method in class nzilbb.labbcat.LabbcatAdmin
-
NOT YET IMPLEMENTED - Lists the descriptors of all registered deserializers.
- getDeserializerDescriptors() - Method in class nzilbb.labbcat.LabbcatView
-
Lists the descriptors of all registered deserializers.
- getDictionaries() - Method in class nzilbb.labbcat.LabbcatView
-
List dictionaries available.
- getDictionaryEntries(String, String, String[]) - Method in class nzilbb.labbcat.LabbcatView
-
Lookup entries in a dictionary.
- getDisplayOrder() - Method in class nzilbb.labbcat.model.Category
-
Getter for
Category.displayOrder
: Where the category appears among other categories. - getDisplayOrder() - Method in class nzilbb.labbcat.model.MediaTrack
-
Getter for
MediaTrack.displayOrder
: The position of the media track amongst other tracks. - getDuration() - Method in class nzilbb.labbcat.model.TaskStatus
-
Getter for
TaskStatus.duration
: Duration in seconds. - getEmail() - Method in class nzilbb.labbcat.model.User
-
Getter for
User.email
: Email address. - getEndAnchorId() - Method in class nzilbb.labbcat.model.MatchId
-
Getter for
endAnchorId
: ID of the end anchor. - getEndOffset() - Method in class nzilbb.labbcat.model.MatchId
-
Getter for
endOffset
: Offset of the end anchor. - getEntity() - Method in class nzilbb.labbcat.model.RolePermission
-
Getter for
RolePermission.entity
: The media entity this permission applies to - a string made up of "t" (transcript), "a" (audio), "v" (video), or "i" (image). - getEpisodeDocuments(String) - Method in class nzilbb.labbcat.LabbcatView
-
Get a list of documents associated with the episode of the given transcript.
- getErrors() - Method in class nzilbb.labbcat.Response
-
Getter for
Response.errors
: Errors returned. - getExtApiInfo() - Method in class nzilbb.labbcat.model.AnnotatorDescriptorWrapper
-
Getter for
AnnotatorDescriptorWrapper.extApiInfo
: HTML-encoded document containing information about what endpoints are published by the ext web-app, for displaying to users who wish to use it programmatically. - getFragment(String, double, double, String[]) - Method in class nzilbb.labbcat.LabbcatView
-
NOT YET IMPLEMENTED - Gets a fragment of a transcript, given its ID and the start/end offsets that define the desired fragment, and containing only the given layers.
- getFragment(String, String) - Method in class nzilbb.labbcat.LabbcatView
-
NOT YET IMPLEMENTED - Gets a fragment of a transcript, given its ID and the ID of an annotation in it that defines the desired fragment.
- getFragment(String, String, String[]) - Method in class nzilbb.labbcat.LabbcatView
-
NOT YET IMPLEMENTED - Gets a fragment of a graph, given its ID and the ID of an annotation in it that defines the desired fragment, and containing only the given layers.
- getFragments() - Method in class nzilbb.labbcat.util.LoadTester
-
Getter for
LoadTester.fragments
: Call getFragments as part of the test. - getFragments(String[], Double[], Double[], String[], String, File) - Method in class nzilbb.labbcat.LabbcatView
-
Get transcript fragments in a specified format.
- getFragments(Match[], String[], String, File) - Method in class nzilbb.labbcat.LabbcatView
-
Get transcript fragments in a specified format.
- getFragmentSeries(String, String[]) - Method in class nzilbb.labbcat.LabbcatView
-
NOT YET IMPLEMENTED - Gets a series of fragments, given the series' ID, and only the given layers.
- getHasConfigWebapp() - Method in class nzilbb.labbcat.model.AnnotatorDescriptorWrapper
-
Getter for
AnnotatorDescriptorWrapper.hasConfigWebapp
: Whether the annotator includes a web-app for installation or general configuration. - getHasExtWebapp() - Method in class nzilbb.labbcat.model.AnnotatorDescriptorWrapper
-
Getter for
AnnotatorDescriptorWrapper.hasExtWebapp
: Whether the annotator includes an extras web-app. - getHasTaskWebapp() - Method in class nzilbb.labbcat.model.AnnotatorDescriptorWrapper
-
Getter for
AnnotatorDescriptorWrapper.hasTaskWebapp
: Whether the annotator includes a web-app for task parameter configuration. - getHeaders() - Method in class nzilbb.labbcat.http.HttpRequestGet
-
Getter for
HttpRequestGet.mHeaders
: HTTP request headers. - getHttpStatus() - Method in class nzilbb.labbcat.Response
-
Getter for
Response.httpStatus
: The HTTP status code, or -1 if not known. - getId() - Method in class nzilbb.labbcat.LabbcatView
-
Gets the store's ID.
- getId() - Method in class nzilbb.labbcat.model.Upload
-
Getter for
Upload.id
: Unique upload identifier. - getIndent() - Method in class nzilbb.labbcat.util.CommandLine
-
Getter for
CommandLine.indent
: Whether to indent JSON for readability. - getInfo() - Method in class nzilbb.labbcat.LabbcatView
-
Gets the store's information document.
- getInfo() - Method in class nzilbb.labbcat.model.AnnotatorDescriptorWrapper
-
Getter for
AnnotatorDescriptorWrapper.info
: HTML-encoded description of the function of the annotator, for displaying to the user. - getLabbcatUrl() - Method in class nzilbb.labbcat.LabbcatView
-
Getter for
LabbcatView.labbcatUrl
: The base URL of the LaBB-CAT server - e.g. - getLabbcatUrl() - Method in class nzilbb.labbcat.util.CommandLine
-
Getter for
CommandLine.labbcatUrl
: Base URL for the LaBB-CAT server. - getLabbcatUrl() - Method in class nzilbb.labbcat.util.LoadTester
-
Getter for
LoadTester.labbcatUrl
: Base URL for the LaBB-CAT server. - getLabel() - Method in class nzilbb.labbcat.model.SystemAttribute
-
Getter for
SystemAttribute.label
: User-facing label for the attribute. - getLanguage() - Method in class nzilbb.labbcat.LabbcatView
-
Getter for
LabbcatView.language
: The language code for server message localization, e.g. - getLanguage() - Method in class nzilbb.labbcat.model.Corpus
-
Getter for
Corpus.language
: The ISO 639-1 code for the default language. - getLayer(String) - Method in class nzilbb.labbcat.LabbcatView
-
Gets a layer definition.
- getLayerId() - Method in class nzilbb.labbcat.model.RolePermission
-
Getter for
RolePermission.layerId
: ID of the layer for which the label determines access. - getLayerIds() - Method in class nzilbb.labbcat.LabbcatView
-
Gets a list of layer IDs (annotation 'types').
- getLayers() - Method in class nzilbb.labbcat.LabbcatView
-
Gets a list of layer definitions.
- getLine() - Method in class nzilbb.labbcat.model.Match
-
Getter for
Match.Line
: The start time of the utterance. - getLineEnd() - Method in class nzilbb.labbcat.model.Match
-
Getter for
Match.LineEnd
: The end time of the utterance. - getMatchAnnotations() - Method in class nzilbb.labbcat.util.LoadTester
-
Getter for
LoadTester.matchAnnotations
: Call getMatchAnnotations as part of the test. - getMatchAnnotations(String[], String[], int, int) - Method in class nzilbb.labbcat.LabbcatView
-
Gets annotations on selected layers related to search results returned by a previous call to
LabbcatView.getMatches(String,int)
,LabbcatView.taskStatus(String)
. - getMatchAnnotations(Iterator<String>, String[], int, int, Consumer<Annotation[]>) - Method in class nzilbb.labbcat.LabbcatView
-
NOT YET IMPLEMENTED - Gets the annotations on given layers for a set of match IDs.
- getMatchAnnotations(Match[], String[], int, int) - Method in class nzilbb.labbcat.LabbcatView
-
Gets annotations on selected layers related to search results returned by a previous call to
LabbcatView.getMatches(String,int)
. - getMatches(String, int) - Method in class nzilbb.labbcat.LabbcatView
-
Gets a list of tokens that were matched by
LabbcatView.search(JsonObject,String[],String[],boolean,Integer,Integer,Integer)
. - getMatches(String, int, Integer, Integer) - Method in class nzilbb.labbcat.LabbcatView
-
Gets a list of tokens that were matched by
LabbcatView.search(JsonObject,String[],String[],boolean,Integer,Integer,Integer)
. - getMatches(JsonObject, String[], String[], boolean, Integer, Integer, Integer, int) - Method in class nzilbb.labbcat.LabbcatView
-
Searches for tokens that match the givem pattern and returns a list of matches.
- getMatches(JsonObject, String[], String[], boolean, Integer, Integer, Integer, int, Integer) - Method in class nzilbb.labbcat.LabbcatView
-
Searches for tokens that match the given pattern and returns the first maxMatches matches.
- getMatchId() - Method in class nzilbb.labbcat.model.Match
-
Getter for
Match.MatchId
: The match ID, which encodes which token in which utterance by which participant of which transcript matched. - getMatchingAnnotations(String, Integer, Integer) - Method in class nzilbb.labbcat.LabbcatView
-
Gets a list of annotations that match a particular pattern.
- getMatchingParticipantIds(String, Integer, Integer) - Method in class nzilbb.labbcat.LabbcatView
-
Gets a list of IDs of participants that match a particular pattern.
- getMatchingTranscriptIds(String, Integer, Integer, String) - Method in class nzilbb.labbcat.LabbcatView
-
Gets a list of IDs of transcripts that match a particular pattern.
- getMaxMatches() - Method in class nzilbb.labbcat.util.LoadTester
-
Getter for
LoadTester.maxMatches
: The maximum number of matches to process (for annotations and fragments). - getMedia(String, String, String) - Method in class nzilbb.labbcat.LabbcatView
-
Gets a given media track for a given transcript.
- getMedia(String, String, String, Double, Double) - Method in class nzilbb.labbcat.LabbcatView
-
Gets a given media track for a given transcript.
- getMediaFile(String, String, String, File) - Method in class nzilbb.labbcat.LabbcatView
-
Gets a given media track for a given transcript.
- getMediaTracks() - Method in class nzilbb.labbcat.LabbcatView
-
List the predefined media tracks available for transcripts.
- getMessages() - Method in class nzilbb.labbcat.Response
-
Getter for
Response.messages
: Messages returned. - getMethod() - Method in class nzilbb.labbcat.http.HttpRequestGet
-
Getter for
HttpRequestGet.method
: HTTP method. - getMinimumApiVersion() - Method in class nzilbb.labbcat.model.AnnotatorDescriptorWrapper
-
Getter for
AnnotatorDescriptorWrapper.minimumApiVersion
: Get the minimum version of the nzilbb.ag API supported by the serializer. - getMinLabbcatVersion() - Method in class nzilbb.labbcat.LabbcatView
-
Getter for
LabbcatView.minLabbcatVersion
: Minimum server version required for this API to work properly. - getModel() - Method in class nzilbb.labbcat.Response
-
Getter for
Response.model
: The model or result returned. - getName() - Method in class nzilbb.labbcat.model.Corpus
-
Getter for
Corpus.name
: Corpus name. - getOptions() - Method in class nzilbb.labbcat.model.SystemAttribute
-
Getter for
SystemAttribute.options
: IfSystemAttribute.type
is "select", these are the valid options for the attribute, where the map key is the attribute value and the map value is the user-facing label for the option. - getOtherLayer() - Method in class nzilbb.labbcat.util.LoadTester
-
Getter for
LoadTester.otherLayer
: ID of other layer (apart from orthography) to get annotations from (default is "phonemes"). - getParameters() - Method in class nzilbb.labbcat.http.HttpRequestGet
-
Getter for
HttpRequestGet.mParameters
: Resuest parameters - getParameters() - Method in class nzilbb.labbcat.model.Upload
-
Getter for
Upload.parameters
: Parameters that are required to complete the upload. - getParticipant() - Method in class nzilbb.labbcat.model.Match
-
Getter for
Match.Participant
: The name of the participant who uttered the match. - getParticipant(String, String[]) - Method in class nzilbb.labbcat.LabbcatView
-
Gets the participant record specified by the given identifier.
- getParticipantAttributes(String[], String[]) - Method in class nzilbb.labbcat.LabbcatView
-
Gets participant attribute values for given participant IDs.
- getParticipantIds() - Method in class nzilbb.labbcat.LabbcatView
-
Gets a list of participant IDs.
- getPassword() - Method in class nzilbb.labbcat.LabbcatView
-
Getter for
LabbcatView.password
: LaBB-CAT password. - getPassword() - Method in class nzilbb.labbcat.util.CommandLine
-
Getter for
CommandLine.password
: Password for LaBB-CAT. - getPassword() - Method in class nzilbb.labbcat.util.LoadTester
-
Getter for
LoadTester.password
: Password for LaBB-CAT. - getPercentComplete() - Method in class nzilbb.labbcat.model.TaskStatus
-
Getter for
TaskStatus.percentComplete
: Percent complete. - getPrefix() - Method in class nzilbb.labbcat.model.MatchId
-
Getter for
prefix
: Match prefix for fragments. - getProject() - Method in class nzilbb.labbcat.model.Project
-
Deprecated.Getter for the name of the project.
- getProjectId() - Method in class nzilbb.labbcat.model.Project
-
Deprecated, for removal: This API element is subject to removal in a future version.
- getQueryString() - Method in class nzilbb.labbcat.http.HttpRequestGet
-
Generates the query string.
- getRaw() - Method in class nzilbb.labbcat.Response
-
Getter for
Response.raw
: Raw response text. - getRefreshSeconds() - Method in class nzilbb.labbcat.model.TaskStatus
-
Getter for
TaskStatus.refreshSeconds
: Suggested status refresh interval. - getRepetitions() - Method in class nzilbb.labbcat.util.LoadTester
-
Getter for
LoadTester.repetitions
: Number of times each client should repeat the test task. - getRequest() - Method in exception class nzilbb.labbcat.http.RequestCancelledException
-
Getter for
RequestCancelledException.rRequest
: The request that was cancelled - getRequiredHttpAuthorization() - Method in class nzilbb.labbcat.LabbcatView
-
Determines whether an authorization string is required for HTTP requests (i.e.
- getResetPassword() - Method in class nzilbb.labbcat.model.User
-
Getter for
User.resetPassword
: Whether the user must reset their password when they next log in. - getResponse() - Method in class nzilbb.labbcat.LabbcatView
-
Getter for
LabbcatView.response
: The last response received from the server. - getResponse() - Method in exception class nzilbb.labbcat.ResponseException
-
Getter for
ResponseException.response
: The response. - getResultText() - Method in class nzilbb.labbcat.model.TaskStatus
-
Getter for
TaskStatus.resultText
: The label for the results. - getResultUrl() - Method in class nzilbb.labbcat.model.TaskStatus
-
Getter for
TaskStatus.resultUrl
: URL for task results, if any. - getRoleId() - Method in class nzilbb.labbcat.model.Role
-
Getter for
Role.roleId
: Role name/ID. - getRoleId() - Method in class nzilbb.labbcat.model.RolePermission
-
Getter for
RolePermission.roleId
: The ID of the role this permission applies to. - getRoles() - Method in class nzilbb.labbcat.model.User
-
Getter for
User.roles
: Roles or groups the user belongs to. - getRunning() - Method in class nzilbb.labbcat.model.TaskStatus
-
Getter for
TaskStatus.running
: Whether the task is currently running (true) or complete (false). - getSchema() - Method in class nzilbb.labbcat.LabbcatView
-
NOT YET IMPLEMENTED - Gets the layer schema.
- getSearchFor() - Method in class nzilbb.labbcat.util.LoadTester
-
Getter for
LoadTester.searchFor
: The orthography to search for when running searches. - getSerializerDescriptors() - Method in class nzilbb.labbcat.LabbcatAdmin
-
NOT YET IMPLEMENTED - Lists the descriptors of all registered serializers.
- getSerializerDescriptors() - Method in class nzilbb.labbcat.LabbcatView
-
Lists the descriptors of all registered serializers.
- getSoundFragments() - Method in class nzilbb.labbcat.util.LoadTester
-
Getter for
LoadTester.soundFragments
: Call getSoundFragments as part of the test. - getSoundFragments(String[], Double[], Double[], Integer, File) - Method in class nzilbb.labbcat.LabbcatView
-
Downloads WAV sound fragments.
- getSoundFragments(Match[], Integer, File) - Method in class nzilbb.labbcat.LabbcatView
-
Downloads WAV sound fragments.
- getStartAnchorId() - Method in class nzilbb.labbcat.model.MatchId
-
Getter for
startAnchorId
: ID of the start anchor. - getStartOffset() - Method in class nzilbb.labbcat.model.MatchId
-
Getter for
startOffset
: Offset of the start anchor. - getStatus() - Method in class nzilbb.labbcat.model.TaskStatus
-
Getter for
TaskStatus.status
: Last status message. - getStyle() - Method in class nzilbb.labbcat.model.SystemAttribute
-
Getter for
SystemAttribute.style
: Style definition which depends onSystemAttribute.type
- e.g. - getSuffix() - Method in class nzilbb.labbcat.model.MediaTrack
-
Getter for
MediaTrack.suffix
: The suffix associated with the media track. - getSystemAttribute(String) - Method in class nzilbb.labbcat.LabbcatView
-
Gets the value of the given system attribute.
- getTargetId() - Method in class nzilbb.labbcat.model.MatchId
-
Getter for
targetId
: ID of the match target annotation. - getTaskParameterInfo() - Method in class nzilbb.labbcat.model.AnnotatorDescriptorWrapper
-
Getter for
AnnotatorDescriptorWrapper.taskParameterInfo
: HTML-encoded definition of the task parameters, including a list of all parameters, and the encoding of the parameter string, for displaying to users who wish to configure annotator tasks programmatically. - getTasks() - Method in class nzilbb.labbcat.LabbcatView
-
Gets a list of all tasks on the server.
- getText() - Method in class nzilbb.labbcat.model.Match
-
Getter for
Match.Text
: The match text. - getThreadId() - Method in class nzilbb.labbcat.model.TaskStatus
-
Getter for
TaskStatus.threadId
: ID of the task. - getThreadName() - Method in class nzilbb.labbcat.model.TaskStatus
-
Getter for
TaskStatus.threadName
: Name of the task. - getTitle() - Method in class nzilbb.labbcat.Response
-
Getter for
Response.title
: Server title. - getTranscriberDescriptors() - Method in class nzilbb.labbcat.LabbcatView
-
Lists descriptors of all transcribers that are installed.
- getTranscript() - Method in class nzilbb.labbcat.model.Match
-
Getter for
Match.Transcript
: The name of the transcript document that the match is from. - getTranscript(String) - Method in class nzilbb.labbcat.LabbcatView
-
Gets a transcript given its ID.
- getTranscript(String, String[]) - Method in class nzilbb.labbcat.LabbcatView
-
Gets a transcript given its ID, containing only the given layers.
- getTranscriptAttributes(String[], String[]) - Method in class nzilbb.labbcat.LabbcatView
-
Gets transcript attribute values for given transcript IDs.
- getTranscriptId() - Method in class nzilbb.labbcat.model.MatchId
-
Getter for
transcriptId
: The transcript identifier. - getTranscriptIds() - Method in class nzilbb.labbcat.LabbcatView
-
Gets a list of transcript IDs.
- getTranscriptIdsInCorpus(String) - Method in class nzilbb.labbcat.LabbcatView
-
Gets a list of transcript IDs in the given corpus.
- getTranscriptIdsWithParticipant(String) - Method in class nzilbb.labbcat.LabbcatView
-
Gets a list of IDs of transcripts that include the given participant.
- getTranscripts() - Method in class nzilbb.labbcat.model.Upload
-
Getter for
Upload.transcripts
: A map of transcript IDs to thread IDs, if any transcripts are already being processed. - getType() - Method in class nzilbb.labbcat.model.SystemAttribute
-
Getter for
SystemAttribute.type
: The type of the attribute - "string", "integer", "boolean", "select", etc. - getUser() - Method in class nzilbb.labbcat.model.User
-
Getter for
User.user
: User ID. - getUserInfo() - Method in class nzilbb.labbcat.LabbcatView
-
Gets information about the current user, including the roles or groups they are in.
- getUsername() - Method in class nzilbb.labbcat.LabbcatView
-
Getter for
LabbcatView.username
: LaBB-CAT username. - getUsername() - Method in class nzilbb.labbcat.util.CommandLine
-
Getter for
CommandLine.username
: Username for LaBB-CAT. - getUsername() - Method in class nzilbb.labbcat.util.LoadTester
-
Getter for
LoadTester.username
: Username for LaBB-CAT. - getUtteranceId() - Method in class nzilbb.labbcat.model.MatchId
-
Getter for
utteranceId
: ID of the match utterance. - getValue() - Method in class nzilbb.labbcat.model.SystemAttribute
-
Getter for
SystemAttribute.value
: The value of the attribute. - getValuePattern() - Method in class nzilbb.labbcat.model.RolePermission
-
Getter for
RolePermission.valuePattern
: Regular expression for matching against the layerId label. - getVerbose() - Method in class nzilbb.labbcat.LabbcatView
-
Getter for
LabbcatView.verbose
: Whether to print verbose output or not. - getVerbose() - Method in class nzilbb.labbcat.Response
-
Getter for
Response.verbose
: Whether to print verbose output or not. - getVerbose() - Method in class nzilbb.labbcat.util.CommandLine
-
Getter for
CommandLine.verbose
: Whether to produce verbose logging. - getVerbose() - Method in class nzilbb.labbcat.util.LoadTester
-
Getter for
LoadTester.verbose
: Whether to produce verbose logging. - getVersion() - Method in class nzilbb.labbcat.model.AnnotatorDescriptorWrapper
-
Getter for
AnnotatorDescriptorWrapper.version
: Version of this implementation; versions will typically be numeric, but this is not a requirement. - getVersion() - Method in class nzilbb.labbcat.Response
-
Getter for
Response.version
: Server version.
H
- hasConfigWebapp() - Method in class nzilbb.labbcat.model.AnnotatorDescriptorWrapper
-
Determines whether the annotator includes a web-app for installation or general configuration.
- hasExtWebapp() - Method in class nzilbb.labbcat.model.AnnotatorDescriptorWrapper
-
Determines whether the annotator includes an extras web-app.
- hasTaskWebapp() - Method in class nzilbb.labbcat.model.AnnotatorDescriptorWrapper
-
Determines whether the annotator includes a web-app for task parameter configuration.
- HttpRequestGet - Class in nzilbb.labbcat.http
-
GET HTTP request, using ordinary default request encoding, and encoding all arguments in the URL string
- HttpRequestGet(String) - Constructor for class nzilbb.labbcat.http.HttpRequestGet
-
Constructor.
- HttpRequestGet(String, String) - Constructor for class nzilbb.labbcat.http.HttpRequestGet
-
Constructor.
- HttpRequestGet(URL) - Constructor for class nzilbb.labbcat.http.HttpRequestGet
-
Constructor.
- HttpRequestGet(URL, String) - Constructor for class nzilbb.labbcat.http.HttpRequestGet
-
Constructor.
- HttpRequestPost - Class in nzilbb.labbcat.http
-
POST HTTP request.
- HttpRequestPost(String, String) - Constructor for class nzilbb.labbcat.http.HttpRequestPost
-
Creates a new POST HTTP request for a specified URL string
- HttpRequestPost(HttpURLConnection, String) - Constructor for class nzilbb.labbcat.http.HttpRequestPost
-
Creates a new POST HTTP request on a freshly opened URLConnection
- HttpRequestPost(URL, String) - Constructor for class nzilbb.labbcat.http.HttpRequestPost
-
Creates a new POST HTTP request for a specified URL
- HttpRequestPostMultipart - Class in nzilbb.labbcat.http
-
Multpart POST HTTP Request class
- HttpRequestPostMultipart(String, String) - Constructor for class nzilbb.labbcat.http.HttpRequestPostMultipart
-
Creates a new multipart POST HTTP request for a specified URL string
- HttpRequestPostMultipart(HttpURLConnection, String) - Constructor for class nzilbb.labbcat.http.HttpRequestPostMultipart
-
Creates a new multipart POST HTTP request on a freshly opened URLConnection
- HttpRequestPostMultipart(URL, String) - Constructor for class nzilbb.labbcat.http.HttpRequestPostMultipart
-
Creates a new multipart POST HTTP request for a specified URL
I
- isCancelling() - Method in class nzilbb.labbcat.http.HttpRequestPostMultipart
-
Determines whether or not the request is being cancelled.
- isCancelling() - Method in class nzilbb.labbcat.LabbcatView
-
Determines whether or not the request is being cancelled.
- isModelNull() - Method in class nzilbb.labbcat.Response
-
Determines whether the model is null.
L
- LabbcatAdmin - Class in nzilbb.labbcat
-
Client-side implementation of nzilbb.ag.GraphStoreAdminitration.
- LabbcatAdmin() - Constructor for class nzilbb.labbcat.LabbcatAdmin
-
Default constructor.
- LabbcatAdmin(String) - Constructor for class nzilbb.labbcat.LabbcatAdmin
-
Constructor from string URL.
- LabbcatAdmin(String, String, String) - Constructor for class nzilbb.labbcat.LabbcatAdmin
-
Constructor with String attributes.
- LabbcatAdmin(URL) - Constructor for class nzilbb.labbcat.LabbcatAdmin
-
Constructor from URL.
- LabbcatAdmin(URL, String, String) - Constructor for class nzilbb.labbcat.LabbcatAdmin
-
Constructor with attributes.
- LabbcatEdit - Class in nzilbb.labbcat
-
Client-side implementation of nzilbb.ag.GraphStore.
- LabbcatEdit() - Constructor for class nzilbb.labbcat.LabbcatEdit
-
Default constructor.
- LabbcatEdit(String) - Constructor for class nzilbb.labbcat.LabbcatEdit
-
Constructor from string URL.
- LabbcatEdit(String, String, String) - Constructor for class nzilbb.labbcat.LabbcatEdit
-
Constructor with String attributes.
- LabbcatEdit(URL) - Constructor for class nzilbb.labbcat.LabbcatEdit
-
Constructor from URL.
- LabbcatEdit(URL, String, String) - Constructor for class nzilbb.labbcat.LabbcatEdit
-
Constructor with attributes.
- LabbcatView - Class in nzilbb.labbcat
-
Client-side implementation of nzilbb.ag.GraphStoreQuery.
- LabbcatView() - Constructor for class nzilbb.labbcat.LabbcatView
-
Default constructor.
- LabbcatView(String) - Constructor for class nzilbb.labbcat.LabbcatView
-
Constructor from string URL.
- LabbcatView(String, String, String) - Constructor for class nzilbb.labbcat.LabbcatView
-
Constructor with String attributes.
- LabbcatView(URL) - Constructor for class nzilbb.labbcat.LabbcatView
-
Constructor from URL.
- LabbcatView(URL, String, String) - Constructor for class nzilbb.labbcat.LabbcatView
-
Constructor with attributes.
- load(InputStream) - Method in class nzilbb.labbcat.Response
-
Loads the response from the given stream.
- load(String) - Method in class nzilbb.labbcat.Response
-
Loads the response from the given stream.
- loadLexicon(File, String, String, String, String, String, boolean) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Upload a flat lexicon file for lexical tagging.
- LoadTester - Class in nzilbb.labbcat.util
-
Command-line utility for load-testing LaBB-CAT servers.
- LoadTester() - Constructor for class nzilbb.labbcat.util.LoadTester
-
Default constructor.
M
- main(String[]) - Static method in class nzilbb.labbcat.util.CommandLine
-
Main entrypoint.
- main(String[]) - Static method in class nzilbb.labbcat.util.LoadTester
-
Main entrypoint.
- makeUrl(String) - Method in class nzilbb.labbcat.LabbcatView
-
Constructs a URL for the given resource.
- Match - Class in nzilbb.labbcat.model
-
Represents a single match from search results.
- Match() - Constructor for class nzilbb.labbcat.model.Match
-
Default constructor.
- Match(JsonObject) - Constructor for class nzilbb.labbcat.model.Match
-
Constructor from JSON.
- MatchId - Class in nzilbb.labbcat.model
-
Interpreter for match ID strings.
- MatchId() - Constructor for class nzilbb.labbcat.model.MatchId
-
Default constructor.
- MatchId(String) - Constructor for class nzilbb.labbcat.model.MatchId
-
String constructor.
- MatchId(Match) - Constructor for class nzilbb.labbcat.model.MatchId
-
Constructor.
- MediaTrack - Class in nzilbb.labbcat.model
-
MediaTrack record.
- MediaTrack() - Constructor for class nzilbb.labbcat.model.MediaTrack
-
Default constructor.
- MediaTrack(JsonObject) - Constructor for class nzilbb.labbcat.model.MediaTrack
-
Constructor from JSON.
N
- newLayer(Layer) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Adds a new layer.
- newTranscript(File, File[], String, String, String, String) - Method in class nzilbb.labbcat.LabbcatEdit
-
Upload a new transcript.
- nzilbb.labbcat - package nzilbb.labbcat
-
LaBB-CAT client library.
- nzilbb.labbcat.http - package nzilbb.labbcat.http
-
Helper classes for making HTTP requests.
- nzilbb.labbcat.model - package nzilbb.labbcat.model
-
LaBB-CAT client models.
- nzilbb.labbcat.util - package nzilbb.labbcat.util
-
Command line utilities.
P
- parseId(String) - Method in class nzilbb.labbcat.model.MatchId
-
Parses the given match ID string.
- PatternBuilder - Class in nzilbb.labbcat
-
Helper class for building layered search patterns for
LabbcatView.search(JsonObject,String[],String[],boolean,Integer,Integer,Integer)
. - PatternBuilder() - Constructor for class nzilbb.labbcat.PatternBuilder
-
Default constructor.
- post() - Method in class nzilbb.labbcat.http.HttpRequestPost
-
posts the requests to the server, with all the cookies and parameters that were added
- post() - Method in class nzilbb.labbcat.http.HttpRequestPostMultipart
-
posts the requests to the server, with all the cookies and parameters that were added
- post(Object[]) - Method in class nzilbb.labbcat.http.HttpRequestPost
-
posts the requests to the server, with all the cookies and parameters that were added before (if any), and with parameters that are passed in the argument
- post(Object[]) - Method in class nzilbb.labbcat.http.HttpRequestPostMultipart
-
posts the requests to the server, with all the cookies and parameters that were added before (if any), and with parameters that are passed in the argument
- post(String) - Method in class nzilbb.labbcat.http.HttpRequestPost
-
posts the requests to the server, with all the cookies and parameters that were added
- post(String) - Method in class nzilbb.labbcat.LabbcatView
-
Constructs a POST request for the given resource.
- post(String[], Object[]) - Method in class nzilbb.labbcat.http.HttpRequestPost
-
posts the requests to the server, with all the cookies and parameters that were added before (if any), and with cookies and parameters that are passed in the arguments
- post(String[], Object[]) - Method in class nzilbb.labbcat.http.HttpRequestPostMultipart
-
posts the requests to the server, with all the cookies and parameters that were added before (if any), and with cookies and parameters that are passed in the arguments
- post(String, Object) - Method in class nzilbb.labbcat.http.HttpRequestPost
-
post the POST request to the server, with the specified parameter
- post(String, Object) - Method in class nzilbb.labbcat.http.HttpRequestPostMultipart
-
post the POST request to the server, with the specified parameter
- post(String, Object, String, Object) - Method in class nzilbb.labbcat.http.HttpRequestPost
-
post the POST request to the server, with the specified parameters
- post(String, Object, String, Object) - Method in class nzilbb.labbcat.http.HttpRequestPostMultipart
-
post the POST request to the server, with the specified parameters
- post(String, Object, String, Object, String, Object) - Method in class nzilbb.labbcat.http.HttpRequestPost
-
post the POST request to the server, with the specified parameters
- post(String, Object, String, Object, String, Object) - Method in class nzilbb.labbcat.http.HttpRequestPostMultipart
-
post the POST request to the server, with the specified parameters
- post(String, Object, String, Object, String, Object, String, Object) - Method in class nzilbb.labbcat.http.HttpRequestPost
-
post the POST request to the server, with the specified parameters
- post(String, Object, String, Object, String, Object, String, Object) - Method in class nzilbb.labbcat.http.HttpRequestPostMultipart
-
post the POST request to the server, with the specified parameters
- post(URL, String, Object[]) - Static method in class nzilbb.labbcat.http.HttpRequestPost
-
posts a new request to specified URL, with parameters that are passed in the argument
- post(URL, String, Object[]) - Static method in class nzilbb.labbcat.http.HttpRequestPostMultipart
-
posts a new request to specified URL, with parameters that are passed in the argument
- post(URL, String, String[], Object[]) - Static method in class nzilbb.labbcat.http.HttpRequestPost
-
posts a new request to specified URL, with cookies and parameters that are passed in the argument
- post(URL, String, String[], Object[]) - Static method in class nzilbb.labbcat.http.HttpRequestPostMultipart
-
posts a new request to specified URL, with cookies and parameters that are passed in the argument
- post(URL, String, String, Object) - Static method in class nzilbb.labbcat.http.HttpRequestPost
-
post the POST request specified URL, with the specified parameter
- post(URL, String, String, Object) - Static method in class nzilbb.labbcat.http.HttpRequestPostMultipart
-
post the POST request specified URL, with the specified parameter
- post(URL, String, String, Object, String, Object) - Static method in class nzilbb.labbcat.http.HttpRequestPost
-
post the POST request to specified URL, with the specified parameters
- post(URL, String, String, Object, String, Object) - Static method in class nzilbb.labbcat.http.HttpRequestPostMultipart
-
post the POST request to specified URL, with the specified parameters
- post(URL, String, String, Object, String, Object, String, Object) - Static method in class nzilbb.labbcat.http.HttpRequestPost
-
post the POST request to specified URL, with the specified parameters
- post(URL, String, String, Object, String, Object, String, Object) - Static method in class nzilbb.labbcat.http.HttpRequestPostMultipart
-
post the POST request to specified URL, with the specified parameters
- post(URL, String, String, Object, String, Object, String, Object, String, Object) - Static method in class nzilbb.labbcat.http.HttpRequestPost
-
post the POST request to specified URL, with the specified parameters
- post(URL, String, String, Object, String, Object, String, Object, String, Object) - Static method in class nzilbb.labbcat.http.HttpRequestPostMultipart
-
post the POST request to specified URL, with the specified parameters
- post(URL, String, Map<String, String>) - Static method in class nzilbb.labbcat.http.HttpRequestPost
-
posts a new request to specified URL, with parameters that are passed in the argument
- post(URL, String, Map<String, String>) - Static method in class nzilbb.labbcat.http.HttpRequestPostMultipart
-
posts a new request to specified URL, with parameters that are passed in the argument
- post(URL, String, Map<String, String>, Map<String, String>) - Static method in class nzilbb.labbcat.http.HttpRequestPost
-
posts a new request to specified URL, with cookies and parameters that are passed in the argument
- post(URL, String, Map<String, String>, Map<String, String>) - Static method in class nzilbb.labbcat.http.HttpRequestPostMultipart
-
posts a new request to specified URL, with cookies and parameters that are passed in the argument
- post(Map<String, String>) - Method in class nzilbb.labbcat.http.HttpRequestPost
-
posts the requests to the server, with all the cookies and parameters that were added before (if any), and with parameters that are passed in the argument
- post(Map<String, String>) - Method in class nzilbb.labbcat.http.HttpRequestPostMultipart
-
posts the requests to the server, with all the cookies and parameters that were added before (if any), and with parameters that are passed in the argument
- post(Map<String, String>, Map<String, String>) - Method in class nzilbb.labbcat.http.HttpRequestPost
-
posts the requests to the server, with all the cookies and parameters that were added before (if any), and with cookies and parameters that are passed in the arguments
- post(Map<String, String>, Map<String, String>) - Method in class nzilbb.labbcat.http.HttpRequestPostMultipart
-
posts the requests to the server, with all the cookies and parameters that were added before (if any), and with cookies and parameters that are passed in the arguments
- post(JsonObject) - Method in class nzilbb.labbcat.http.HttpRequestPost
-
posts the requests to the server, with all the cookies and parameters that were added
- postMultipart(String) - Method in class nzilbb.labbcat.LabbcatView
-
Constructs a multipart POST request for the given resource.
- processWithPraat(String[], Double[], Double[], String, Double, String[]) - Method in class nzilbb.labbcat.LabbcatView
-
Executes Praat on the server in order to perform acoustic analysis on a given collection of sound fragments.
- processWithPraat(String[], String[], Double[], Double[], String, Double, String[]) - Method in class nzilbb.labbcat.LabbcatView
-
Executes Praat on the server in order to perform acoustic analysis on a given collection of sound fragments.
- Project - Class in nzilbb.labbcat.model
-
Deprecated, for removal: This API element is subject to removal in a future version.Projects are now layer categories - a type of
Category
with classId = "layer" - Project() - Constructor for class nzilbb.labbcat.model.Project
-
Deprecated.Default constructor.
- Project(JsonObject) - Constructor for class nzilbb.labbcat.model.Project
-
Deprecated.Constructor from JSON.
- Project(Category) - Constructor for class nzilbb.labbcat.model.Project
-
Deprecated.Constructor from Category object.
- put(String) - Method in class nzilbb.labbcat.LabbcatView
-
Constructs a PUT request for the given resource.
R
- readCategories(String) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Reads a list of category records.
- readCategories(String, Integer, Integer) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Reads a list of category records.
- readCorpora() - Method in class nzilbb.labbcat.LabbcatAdmin
-
Reads a list of corpus records.
- readCorpora(Integer, Integer) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Reads a list of corpus records.
- readMediaTracks() - Method in class nzilbb.labbcat.LabbcatAdmin
-
Reads a list of mediaTrack records.
- readMediaTracks(Integer, Integer) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Reads a list of media track records.
- readProjects() - Method in class nzilbb.labbcat.LabbcatAdmin
-
Deprecated, for removal: This API element is subject to removal in a future version.Projects are now layer categories - a type of
Category
with classId = "layer". UseLabbcatAdmin.readCategories(String)
instead. - readProjects(Integer, Integer) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Deprecated, for removal: This API element is subject to removal in a future version.Projects are now layer categories - a type of
Category
with classId = "layer". UseLabbcatAdmin.readCategories(String,Integer,Integer)
instead. - readRolePermissions(String) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Reads a list of role permission records.
- readRolePermissions(String, Integer, Integer) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Reads a list of role permission records.
- readRoles() - Method in class nzilbb.labbcat.LabbcatAdmin
-
Reads a list of role records.
- readRoles(Integer, Integer) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Reads a list of role records.
- readSystemAttributes() - Method in class nzilbb.labbcat.LabbcatAdmin
-
Reads a list of system_attribute records.
- readUsers() - Method in class nzilbb.labbcat.LabbcatAdmin
-
Reads a list of user records.
- readUsers(Integer, Integer) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Reads a list of user records.
- registerDeserializer(GraphDeserializer) - Method in class nzilbb.labbcat.LabbcatAdmin
-
NOT YET IMPLEMENTED - Registers a transcript deserializer.
- registerSerializer(GraphSerializer) - Method in class nzilbb.labbcat.LabbcatAdmin
-
NOT YET IMPLEMENTED - Registers a transcript serializer.
- releaseTask(String) - Method in class nzilbb.labbcat.LabbcatView
-
Release a finished task, to free up server resources.
- removeDictionaryEntry(String, String, String, String) - Method in class nzilbb.labbcat.LabbcatEdit
-
Removes an entry from a dictionary.
- removeLayerDictionaryEntry(String, String, String) - Method in class nzilbb.labbcat.LabbcatEdit
-
Removes an entry from a layer dictionary.
- RequestCancelledException - Exception Class in nzilbb.labbcat.http
-
Exception thrown when an HttpRequestPostMultipart is cancelled by the user.
- RequestCancelledException() - Constructor for exception class nzilbb.labbcat.http.RequestCancelledException
-
Default constructor
- RequestCancelledException(String) - Constructor for exception class nzilbb.labbcat.http.RequestCancelledException
-
Constructor
- RequestCancelledException(HttpRequestPostMultipart) - Constructor for exception class nzilbb.labbcat.http.RequestCancelledException
-
Default constructor
- Response - Class in nzilbb.labbcat
-
A class representing the JSON response of a LaBB-CAT request.
- Response() - Constructor for class nzilbb.labbcat.Response
-
Default constructor.
- Response(InputStream) - Constructor for class nzilbb.labbcat.Response
-
Constructor from InputStream.
- Response(InputStream, boolean) - Constructor for class nzilbb.labbcat.Response
-
Constructor from InputStream.
- Response(HttpURLConnection, boolean) - Constructor for class nzilbb.labbcat.Response
-
Constructor from HttpURLConnection.
- ResponseException - Exception Class in nzilbb.labbcat
-
An object representing an error returned by the server.
- ResponseException(Response) - Constructor for exception class nzilbb.labbcat.ResponseException
-
Constructor.
- Role - Class in nzilbb.labbcat.model
-
User role record.
- Role() - Constructor for class nzilbb.labbcat.model.Role
-
Default constructor.
- Role(JsonObject) - Constructor for class nzilbb.labbcat.model.Role
-
Constructor from JSON.
- RolePermission - Class in nzilbb.labbcat.model
-
User role permission record.
- RolePermission() - Constructor for class nzilbb.labbcat.model.RolePermission
-
Default constructor.
- RolePermission(JsonObject) - Constructor for class nzilbb.labbcat.model.RolePermission
-
Constructor from JSON.
S
- saveEpisodeDocument(String, String) - Method in class nzilbb.labbcat.LabbcatEdit
-
Saves the given document for the episode of the given transcript.
- saveLayer(Layer) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Saves changes to a layer.
- saveMedia(String, String, String) - Method in class nzilbb.labbcat.LabbcatEdit
-
Saves the given media for the given transcript.
- saveParticipant(Annotation) - Method in class nzilbb.labbcat.LabbcatEdit
-
Saves a participant, and all its tags, to the database.
- saveSource(String, String) - Method in class nzilbb.labbcat.LabbcatEdit
-
NOT YET IMPLEMENTED - Saves the given source file for the given transcript.
- saveTranscript(Graph) - Method in class nzilbb.labbcat.LabbcatEdit
-
Saves the given transcript.
- search(JsonObject, String[], String[], boolean, Integer, Integer, Integer) - Method in class nzilbb.labbcat.LabbcatView
-
Searches for tokens that match the given pattern.
- seconds - Static variable in class nzilbb.labbcat.util.LoadTester
-
Decimal format for seconds.
- serializerForFilesSuffix(String) - Method in class nzilbb.labbcat.LabbcatView
-
NOT YET IMPLEMENTED - Gets the serializer for the given file suffix (extension).
- serializerForMimeType(String) - Method in class nzilbb.labbcat.LabbcatView
-
NOT YET IMPLEMENTED - Gets the serializer for the given MIME type.
- setAfterMatch(String) - Method in class nzilbb.labbcat.model.Match
-
Setter for
Match.AfterMatch
: The context after the match. - setAnnotatorId(String) - Method in class nzilbb.labbcat.model.AnnotatorDescriptorWrapper
-
Setter for
AnnotatorDescriptorWrapper.annotatorId
: Annotator ID. - setAttribute(String) - Method in class nzilbb.labbcat.model.SystemAttribute
-
Setter for
SystemAttribute.attribute
: ID of the attribute. - setAuthorization(String) - Method in class nzilbb.labbcat.http.HttpRequestGet
-
Setter for
HttpRequestGet.sAuthorization
: The HTTP authorization string, or null if not required. - setBaseUrl(URL) - Method in class nzilbb.labbcat.http.HttpRequestGet
-
Setter for
HttpRequestGet.urlBaseUrl
: Base URL for the request - setBatchMode(boolean) - Method in class nzilbb.labbcat.LabbcatView
-
Setter for
LabbcatView.batchMode
: Whether to run in batch mode or not. - setBeforeMatch(String) - Method in class nzilbb.labbcat.model.Match
-
Setter for
Match.BeforeMatch
: The context before the match. - setCategory(String) - Method in class nzilbb.labbcat.model.Category
-
Setter for
Category.category
: The name/id of the category. - setClassId(String) - Method in class nzilbb.labbcat.model.Category
-
Setter for
Category.classId
: What kind of attributes are categorised - "transcript", "speaker", or "layer". - setClientDelay(Integer) - Method in class nzilbb.labbcat.util.LoadTester
-
Setter for
LoadTester.clientDelay
: Number of seconds to wait before starting each new client. - setClients(Integer) - Method in class nzilbb.labbcat.util.LoadTester
-
Setter for
LoadTester.clients
: Number of clients to simulate. - setConfigParameterInfo(String) - Method in class nzilbb.labbcat.model.AnnotatorDescriptorWrapper
-
Setter for
AnnotatorDescriptorWrapper.configParameterInfo
: HTML-encoded definition of the installation config parameters, including a list of all parameters, and the encoding of the parameter string, for displaying to users who wish to configure the annotator programmatically. - setCookie(String, String) - Method in class nzilbb.labbcat.http.HttpRequestPost
-
adds a cookie to the requst
- setCookie(String, String) - Method in class nzilbb.labbcat.http.HttpRequestPostMultipart
-
adds a cookie to the requst
- setCookies(String[]) - Method in class nzilbb.labbcat.http.HttpRequestPost
-
adds cookies to the request
- setCookies(String[]) - Method in class nzilbb.labbcat.http.HttpRequestPostMultipart
-
adds cookies to the request
- setCookies(Map<String, String>) - Method in class nzilbb.labbcat.http.HttpRequestPost
-
adds cookies to the request
- setCookies(Map<String, String>) - Method in class nzilbb.labbcat.http.HttpRequestPostMultipart
-
adds cookies to the request
- setCorpus(String) - Method in class nzilbb.labbcat.model.Match
-
Setter for
Match.Corpus
: The corpus the match comes from - setCorpusId(int) - Method in class nzilbb.labbcat.model.Corpus
-
Setter for
Corpus.corpusId
: Database key value. - setDescription(String) - Method in class nzilbb.labbcat.model.Category
-
Setter for
Category.description
: The description of the category. - setDescription(String) - Method in class nzilbb.labbcat.model.Corpus
-
Setter for
Corpus.description
: Description of corpus. - setDescription(String) - Method in class nzilbb.labbcat.model.MediaTrack
-
Setter for
MediaTrack.description
: Description of the media track. - setDescription(String) - Method in class nzilbb.labbcat.model.Role
-
Setter for
Role.description
: Description of the role. - setDescription(String) - Method in class nzilbb.labbcat.model.SystemAttribute
-
Setter for
SystemAttribute.description
: User-facing (long) description of the attribute. - setDisplayOrder(int) - Method in class nzilbb.labbcat.model.Category
-
Setter for
Category.displayOrder
: Where the category appears among other categories. - setDisplayOrder(int) - Method in class nzilbb.labbcat.model.MediaTrack
-
Setter for
MediaTrack.displayOrder
: The position of the media track amongst other tracks. - setDuration(int) - Method in class nzilbb.labbcat.model.TaskStatus
-
Setter for
TaskStatus.duration
: Duration in seconds. - setEmail(String) - Method in class nzilbb.labbcat.model.User
-
Setter for
User.email
: Email address. - setEntity(String) - Method in class nzilbb.labbcat.model.RolePermission
-
Setter for
RolePermission.entity
: The media entity this permission applies to - a string made up of "t" (transcript), "a" (audio), "v" (video), or "i" (image). - setExtApiInfo(String) - Method in class nzilbb.labbcat.model.AnnotatorDescriptorWrapper
-
Setter for
AnnotatorDescriptorWrapper.extApiInfo
: HTML-encoded document containing information about what endpoints are published by the ext web-app, for displaying to users who wish to use it programmatically. - setFragments(Boolean) - Method in class nzilbb.labbcat.util.LoadTester
-
Setter for
LoadTester.fragments
: Call getFragments as part of the test. - setHasConfigWebapp(Boolean) - Method in class nzilbb.labbcat.model.AnnotatorDescriptorWrapper
-
Setter for
AnnotatorDescriptorWrapper.hasConfigWebapp
: Whether the annotator includes a web-app for installation or general configuration. - setHasExtWebapp(Boolean) - Method in class nzilbb.labbcat.model.AnnotatorDescriptorWrapper
-
Setter for
AnnotatorDescriptorWrapper.hasExtWebapp
: Whether the annotator includes an extras web-app. - setHasTaskWebapp(Boolean) - Method in class nzilbb.labbcat.model.AnnotatorDescriptorWrapper
-
Setter for
AnnotatorDescriptorWrapper.hasTaskWebapp
: Whether the annotator includes a web-app for task parameter configuration. - setHeader(String, String) - Method in class nzilbb.labbcat.http.HttpRequestGet
-
Sets a request parameter value
- setHeader(String, String) - Method in class nzilbb.labbcat.http.HttpRequestPost
-
Sets a request parameter value
- setHeader(String, String) - Method in class nzilbb.labbcat.http.HttpRequestPostMultipart
-
Sets a request parameter value
- setHeaders(HashMap<String, String>) - Method in class nzilbb.labbcat.http.HttpRequestGet
-
Setter for
HttpRequestGet.mHeaders
: HTTP request headers. - setId(String) - Method in class nzilbb.labbcat.model.Upload
-
Setter for
Upload.id
: Unique upload identifier. - setIndent(Boolean) - Method in class nzilbb.labbcat.util.CommandLine
-
Setter for
CommandLine.indent
: Whether to indent JSON for readability. - setInfo(String) - Method in class nzilbb.labbcat.model.AnnotatorDescriptorWrapper
-
Setter for
AnnotatorDescriptorWrapper.info
: HTML-encoded description of the function of the annotator, for displaying to the user. - setLabbcatUrl(String) - Method in class nzilbb.labbcat.util.CommandLine
-
Setter for
CommandLine.labbcatUrl
: Base URL for the LaBB-CAT server. - setLabbcatUrl(String) - Method in class nzilbb.labbcat.util.LoadTester
-
Setter for
LoadTester.labbcatUrl
: Base URL for the LaBB-CAT server. - setLabbcatUrl(URL) - Method in class nzilbb.labbcat.LabbcatView
-
Setter for
LabbcatView.labbcatUrl
: The base URL of the LaBB-CAT server - e.g. - setLabel(String) - Method in class nzilbb.labbcat.model.SystemAttribute
-
Setter for
SystemAttribute.label
: User-facing label for the attribute. - setLanguage(String) - Method in class nzilbb.labbcat.http.HttpRequestGet
-
Set the Accept-Language header with the given language code, if any.,
- setLanguage(String) - Method in class nzilbb.labbcat.http.HttpRequestPost
-
Set the Accept-Language header with the given language code, if any.,
- setLanguage(String) - Method in class nzilbb.labbcat.http.HttpRequestPostMultipart
-
Set the Accept-Language header with the given language code, if any.,
- setLanguage(String) - Method in class nzilbb.labbcat.LabbcatView
-
Setter for
LabbcatView.language
: The language code for server message localization, e.g. - setLanguage(String) - Method in class nzilbb.labbcat.model.Corpus
-
Setter for
Corpus.language
: The ISO 639-1 code for the default language. - setLayerId(String) - Method in class nzilbb.labbcat.model.RolePermission
-
Setter for
RolePermission.layerId
: ID of the layer for which the label determines access. - setLine(Double) - Method in class nzilbb.labbcat.model.Match
-
Setter for
Match.Line
: The start time of the utterance. - setLineEnd(Double) - Method in class nzilbb.labbcat.model.Match
-
Setter for
Match.LineEnd
: The end time of the utterance. - setMatchAnnotations(Boolean) - Method in class nzilbb.labbcat.util.LoadTester
-
Setter for
LoadTester.matchAnnotations
: Call getMatchAnnotations as part of the test. - setMatchId(String) - Method in class nzilbb.labbcat.model.Match
-
Setter for
Match.MatchId
: The match ID, which encodes which token in which utterance by which participant of which transcript matched. - setMaxMatches(Integer) - Method in class nzilbb.labbcat.util.LoadTester
-
Setter for
LoadTester.maxMatches
: The maximum number of matches to process (for annotations and fragments). - setMethod(String) - Method in class nzilbb.labbcat.http.HttpRequestGet
-
Setter for
HttpRequestGet.method
: HTTP method. - setMethod(String) - Method in class nzilbb.labbcat.http.HttpRequestPost
-
Sets the HTTP method to use.
- setMinimumApiVersion(String) - Method in class nzilbb.labbcat.model.AnnotatorDescriptorWrapper
-
Setter for
AnnotatorDescriptorWrapper.minimumApiVersion
: Get the minimum version of the nzilbb.ag API supported by the serializer. - setModel(Object) - Method in class nzilbb.labbcat.Response
-
Setter for
Response.model
: The model or result returned. - setName(String) - Method in class nzilbb.labbcat.model.Corpus
-
Setter for
Corpus.name
: Corpus name. - setOptions(Map<String, String>) - Method in class nzilbb.labbcat.model.SystemAttribute
-
Setter for
SystemAttribute.options
: IfSystemAttribute.type
is "select", these are the valid options for the attribute, where the map key is the attribute value and the map value is the user-facing label for the option. - setOtherLayer(String) - Method in class nzilbb.labbcat.util.LoadTester
-
Setter for
LoadTester.otherLayer
: ID of other layer (apart from orthography) to get annotations from (default is "phonemes"). - setParameter(String, File) - Method in class nzilbb.labbcat.http.HttpRequestPostMultipart
-
adds a file parameter to the request
- setParameter(String, Object) - Method in class nzilbb.labbcat.http.HttpRequestGet
-
Sets a request parameter value
- setParameter(String, Object) - Method in class nzilbb.labbcat.http.HttpRequestPost
-
adds a parameter to the request; if the parameter is a File, the file is uploaded, otherwise the string value of the parameter is passed in the request
- setParameter(String, Object) - Method in class nzilbb.labbcat.http.HttpRequestPostMultipart
-
adds a parameter to the request; if the parameter is a File, the file is uploaded, otherwise the string value of the parameter is passed in the request
- setParameter(String, String) - Method in class nzilbb.labbcat.http.HttpRequestPost
-
adds a string parameter to the request
- setParameter(String, String) - Method in class nzilbb.labbcat.http.HttpRequestPostMultipart
-
adds a string parameter to the request
- setParameter(String, String, InputStream) - Method in class nzilbb.labbcat.http.HttpRequestPostMultipart
-
adds a file parameter to the request
- setParameters(Object[]) - Method in class nzilbb.labbcat.http.HttpRequestPost
-
adds parameters to the request
- setParameters(Object[]) - Method in class nzilbb.labbcat.http.HttpRequestPostMultipart
-
adds parameters to the request
- setParameters(HashMap<String, Object>) - Method in class nzilbb.labbcat.http.HttpRequestGet
-
Setter for
HttpRequestGet.mParameters
: Resuest parameters - setParameters(Map<String, String>) - Method in class nzilbb.labbcat.http.HttpRequestPost
-
adds parameters to the request
- setParameters(Map<String, String>) - Method in class nzilbb.labbcat.http.HttpRequestPostMultipart
-
adds parameters to the request
- setParameters(ParameterSet) - Method in class nzilbb.labbcat.model.Upload
-
Setter for
Upload.parameters
: Parameters that are required to complete the upload. - setParticipant(String) - Method in class nzilbb.labbcat.model.Match
-
Setter for
Match.Participant
: The name of the participant who uttered the match. - setPassword(String) - Method in class nzilbb.labbcat.LabbcatView
-
Setter for
LabbcatView.password
: LaBB-CAT password. - setPassword(String) - Method in class nzilbb.labbcat.util.CommandLine
-
Setter for
CommandLine.password
: Password for LaBB-CAT. - setPassword(String) - Method in class nzilbb.labbcat.util.LoadTester
-
Setter for
LoadTester.password
: Password for LaBB-CAT. - setPassword(String, String, boolean) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Sets a given user's password.
- setPercentComplete(int) - Method in class nzilbb.labbcat.model.TaskStatus
-
Setter for
TaskStatus.percentComplete
: Percent complete. - setProject(String) - Method in class nzilbb.labbcat.model.Project
-
Deprecated.Setter for the name of the project.
- setProjectId(int) - Method in class nzilbb.labbcat.model.Project
-
Deprecated, for removal: This API element is subject to removal in a future version.
- setRefreshSeconds(int) - Method in class nzilbb.labbcat.model.TaskStatus
-
Setter for
TaskStatus.refreshSeconds
: Suggested status refresh interval. - setRepetitions(Integer) - Method in class nzilbb.labbcat.util.LoadTester
-
Setter for
LoadTester.repetitions
: Number of times each client should repeat the test task. - setRequest(HttpRequestPostMultipart) - Method in exception class nzilbb.labbcat.http.RequestCancelledException
-
Setter for
RequestCancelledException.rRequest
: The request that was cancelled - setResetPassword(Boolean) - Method in class nzilbb.labbcat.model.User
-
Setter for
User.resetPassword
: Whether the user must reset their password when they next log in. - setResponse(Response) - Method in class nzilbb.labbcat.LabbcatView
-
Setter for
LabbcatView.response
: The last response received from the server. - setResultText(String) - Method in class nzilbb.labbcat.model.TaskStatus
-
Setter for
TaskStatus.resultText
: The label for the results. - setResultUrl(String) - Method in class nzilbb.labbcat.model.TaskStatus
-
Setter for
TaskStatus.resultUrl
: URL for task results, if any. - setRoleId(String) - Method in class nzilbb.labbcat.model.Role
-
Setter for
Role.roleId
: Role name/ID. - setRoleId(String) - Method in class nzilbb.labbcat.model.RolePermission
-
Setter for
RolePermission.roleId
: The ID of the role this permission applies to. - setRoles(String[]) - Method in class nzilbb.labbcat.model.User
-
Setter for
User.roles
: Roles or groups the user belongs to. - setRunning(boolean) - Method in class nzilbb.labbcat.model.TaskStatus
-
Setter for
TaskStatus.running
: Whether the task is currently running (true) or complete (false). - setSearchFor(String) - Method in class nzilbb.labbcat.util.LoadTester
-
Setter for
LoadTester.searchFor
: The orthography to search for when running searches. - setSoundFragments(Boolean) - Method in class nzilbb.labbcat.util.LoadTester
-
Setter for
LoadTester.soundFragments
: Call getSoundFragments as part of the test. - setStatus(String) - Method in class nzilbb.labbcat.model.TaskStatus
-
Setter for
TaskStatus.status
: Last status message. - setStyle(String) - Method in class nzilbb.labbcat.model.SystemAttribute
-
Setter for
SystemAttribute.style
: Style definition which depends onSystemAttribute.type
- e.g. - setSuffix(String) - Method in class nzilbb.labbcat.model.MediaTrack
-
Setter for
MediaTrack.suffix
: The suffix associated with the media track. - setTaskParameterInfo(String) - Method in class nzilbb.labbcat.model.AnnotatorDescriptorWrapper
-
Setter for
AnnotatorDescriptorWrapper.taskParameterInfo
: HTML-encoded definition of the task parameters, including a list of all parameters, and the encoding of the parameter string, for displaying to users who wish to configure annotator tasks programmatically. - setText(String) - Method in class nzilbb.labbcat.model.Match
-
Setter for
Match.Text
: The match text. - setThreadId(String) - Method in class nzilbb.labbcat.model.TaskStatus
-
Setter for
TaskStatus.threadId
: ID of the task. - setThreadName(String) - Method in class nzilbb.labbcat.model.TaskStatus
-
Setter for
TaskStatus.threadName
: Name of the task. - setTranscript(String) - Method in class nzilbb.labbcat.model.Match
-
Setter for
Match.Transcript
: The name of the transcript document that the match is from. - setTranscripts(Map<String, String>) - Method in class nzilbb.labbcat.model.Upload
-
Setter for
Upload.transcripts
: A map of transcript IDs to thread IDs, if any transcripts are already being processed. - setType(String) - Method in class nzilbb.labbcat.model.SystemAttribute
-
Setter for
SystemAttribute.type
: The type of the attribute - "string", "integer", "boolean", "select", etc. - setUser(String) - Method in class nzilbb.labbcat.model.User
-
Setter for
User.user
: User ID. - setUserAgent() - Method in class nzilbb.labbcat.http.HttpRequestGet
-
Sets the user-agent header to indicate the name/version of the library.
- setUserAgent() - Method in class nzilbb.labbcat.http.HttpRequestPost
-
Sets the user-agent header to indicate the name/version of the library.
- setUserAgent() - Method in class nzilbb.labbcat.http.HttpRequestPostMultipart
-
Sets the user-agent header to indicate the name/version of the library.
- setUsername(String) - Method in class nzilbb.labbcat.LabbcatView
-
Setter for
LabbcatView.username
: LaBB-CAT username. - setUsername(String) - Method in class nzilbb.labbcat.util.CommandLine
-
Setter for
CommandLine.username
: Username for LaBB-CAT. - setUsername(String) - Method in class nzilbb.labbcat.util.LoadTester
-
Setter for
LoadTester.username
: Username for LaBB-CAT. - setValue(String) - Method in class nzilbb.labbcat.model.SystemAttribute
-
Setter for
SystemAttribute.value
: The value of the attribute. - setValuePattern(String) - Method in class nzilbb.labbcat.model.RolePermission
-
Setter for
RolePermission.valuePattern
: Regular expression for matching against the layerId label. - setVerbose(boolean) - Method in class nzilbb.labbcat.LabbcatView
-
Setter for
LabbcatView.verbose
: Whether to print verbose output or not. - setVerbose(Boolean) - Method in class nzilbb.labbcat.util.CommandLine
-
Setter for
CommandLine.verbose
: Whether to produce verbose logging. - setVerbose(Boolean) - Method in class nzilbb.labbcat.util.LoadTester
-
Setter for
LoadTester.verbose
: Whether to produce verbose logging. - setVersion(String) - Method in class nzilbb.labbcat.model.AnnotatorDescriptorWrapper
-
Setter for
AnnotatorDescriptorWrapper.version
: Version of this implementation; versions will typically be numeric, but this is not a requirement. - setVersion(String) - Method in class nzilbb.labbcat.Response
-
Setter for
Response.version
: Server version. - start() - Method in class nzilbb.labbcat.util.CommandLine
-
Start the utility
- start() - Method in class nzilbb.labbcat.util.LoadTester
-
Start the utility
- SystemAttribute - Class in nzilbb.labbcat.model
-
system_attribute record.
- SystemAttribute() - Constructor for class nzilbb.labbcat.model.SystemAttribute
-
Default constructor.
- SystemAttribute(JsonObject) - Constructor for class nzilbb.labbcat.model.SystemAttribute
-
Constructor from JSON.
T
- tagMatchingAnnotations(String, String, String, Integer) - Method in class nzilbb.labbcat.LabbcatEdit
-
Identifies a list of annotations that match a particular pattern, and tags them on the given layer with the given label.
- taskStatus(String) - Method in class nzilbb.labbcat.LabbcatView
-
Gets the current state of the given task.
- TaskStatus - Class in nzilbb.labbcat.model
-
The status of a server-side task.
- TaskStatus() - Constructor for class nzilbb.labbcat.model.TaskStatus
-
Default constructor.
- TaskStatus(JsonObject) - Constructor for class nzilbb.labbcat.model.TaskStatus
-
Constructor from JSON.
- toJson() - Method in class nzilbb.labbcat.model.Category
-
Serializes the object to JSON.
- toJson() - Method in class nzilbb.labbcat.model.Corpus
-
Serializes the object to JSON.
- toJson() - Method in class nzilbb.labbcat.model.MediaTrack
-
Serializes the object to JSON.
- toJson() - Method in class nzilbb.labbcat.model.Role
-
Serializes the object to JSON.
- toJson() - Method in class nzilbb.labbcat.model.RolePermission
-
Serializes the object to JSON.
- toJson() - Method in class nzilbb.labbcat.model.SystemAttribute
-
Serializes the object to JSON.
- toJson() - Method in class nzilbb.labbcat.model.User
-
Serializes the object to JSON.
- toString() - Method in class nzilbb.labbcat.http.HttpRequestGet
-
String representation of the request, for logging.
- toString() - Method in class nzilbb.labbcat.http.HttpRequestPost
-
String representation of the request, for logging.
- toString() - Method in class nzilbb.labbcat.http.HttpRequestPostMultipart
-
String representation of the request, for logging.
- toString() - Method in class nzilbb.labbcat.model.Match
-
String represtation for logging.
- toString() - Method in class nzilbb.labbcat.model.TaskStatus
-
Represents the object as a String, for logging.
- toString() - Method in class nzilbb.labbcat.PatternBuilder
-
A String representation of the JSON pattern object.
- transcriptUpload(File, boolean) - Method in class nzilbb.labbcat.LabbcatEdit
-
Upload a transcript file as the first stage in adding or modifying a transcript to LaBB-CAT.
- transcriptUpload(File, File[], boolean) - Method in class nzilbb.labbcat.LabbcatEdit
-
Upload a transcript file and associated media files, as the first stage in adding or modifying a transcript to LaBB-CAT.
- transcriptUpload(File, Map<String, File[]>, boolean) - Method in class nzilbb.labbcat.LabbcatEdit
-
Upload a transcript file and associated media files, as the first stage in adding or modifying a transcript to LaBB-CAT.
- transcriptUploadDelete(String) - Method in class nzilbb.labbcat.LabbcatEdit
-
Delete an upload made by
LabbcatEdit.transcriptUpload(File,Map,boolean)
. - transcriptUploadDelete(Upload) - Method in class nzilbb.labbcat.LabbcatEdit
-
Delete an upload made by
LabbcatEdit.transcriptUpload(File,Map,boolean)
. - transcriptUploadParameters(Upload) - Method in class nzilbb.labbcat.LabbcatEdit
-
The second part of a transcript upload process started by a call to
LabbcatEdit.transcriptUpload(File,Map,boolean)
, which specifies values for the parameters required to save the uploaded transcript to LaBB-CAT's database.
U
- updateCategory(Category) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Updates an existing category record.
- updateCorpus(Corpus) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Updates an existing corpus record.
- updateInfo(String) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Saves the store's information document.
- updateMediaTrack(MediaTrack) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Updates an existing media track record.
- updateProject(Project) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Deprecated, for removal: This API element is subject to removal in a future version.Projects are now layer categories - a type of
Category
with classId = "layer". UseLabbcatAdmin.updateCategory(Category)
isntead. - updateRole(Role) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Updates an existing role record.
- updateRolePermission(RolePermission) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Updates an existing role permission record.
- updateSystemAttribute(String, String) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Updates an existing systemAttribute record.
- updateSystemAttribute(SystemAttribute) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Updates an existing systemAttribute record.
- updateTranscript(File) - Method in class nzilbb.labbcat.LabbcatEdit
-
Uploads a new version of an existing transcript.
- updateTranscript(File, boolean) - Method in class nzilbb.labbcat.LabbcatEdit
-
Uploads a new version of an existing transcript.
- updateUser(User) - Method in class nzilbb.labbcat.LabbcatAdmin
-
Updates an existing user record.
- Upload - Class in nzilbb.labbcat.model
-
Information about a transcript upload in progress.
- Upload() - Constructor for class nzilbb.labbcat.model.Upload
-
Default constructor.
- Upload(JsonObject) - Constructor for class nzilbb.labbcat.model.Upload
-
Constructor from JSON.
- url(String) - Method in class nzilbb.labbcat.LabbcatView
-
Constructs a URL for the given resource.
- User - Class in nzilbb.labbcat.model
-
Model of a user record, including roles.
- User() - Constructor for class nzilbb.labbcat.model.User
-
Default constructor.
- User(JsonObject) - Constructor for class nzilbb.labbcat.model.User
-
Constructor from JSON.
W
- waitForTask(String, int) - Method in class nzilbb.labbcat.LabbcatView
-
Wait for the given task to finish.
All Classes and Interfaces|All Packages|Serialized Form
Category
with classId = "layer". UseLabbcatAdmin.createCategory(Category)
instead.