Package nzilbb.labbcat.model

Class AnnotatorDescriptorWrapper

java.lang.Object
nzilbb.ag.automation.util.AnnotatorDescriptor
nzilbb.labbcat.model.AnnotatorDescriptorWrapper
All Implemented Interfaces:
Comparable, nzilbb.util.CloneableBean
public class AnnotatorDescriptorWrapper extends nzilbb.ag.automation.util.AnnotatorDescriptor
Client-side annotator descriptor that can be deserialized from JSON.
Author:
Robert Fromont robert@fromont.net.nz

  • Constructor Summary

    Constructors
    Constructor
    Description
    AnnotatorDescriptorWrapper()
    Default constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAnnotatorId()
    Getter for annotatorId: Annotator ID.
    String
    getConfigParameterInfo()
    Getter for 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.
    String
    getExtApiInfo()
    Getter for 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.
    Boolean
    getHasConfigWebapp()
    Getter for hasConfigWebapp: Whether the annotator includes a web-app for installation or general configuration.
    Boolean
    getHasExtWebapp()
    Getter for hasExtWebapp: Whether the annotator includes an extras web-app.
    Boolean
    getHasTaskWebapp()
    Getter for hasTaskWebapp: Whether the annotator includes a web-app for task parameter configuration.
    String
    getInfo()
    Getter for info: HTML-encoded description of the function of the annotator, for displaying to the user.
    String
    getMinimumApiVersion()
    Getter for minimumApiVersion: Get the minimum version of the nzilbb.ag API supported by the serializer.
    String
    getTaskParameterInfo()
    Getter for 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.
    String
    getVersion()
    Getter for version: Version of this implementation; versions will typically be numeric, but this is not a requirement.
    boolean
    hasConfigWebapp()
    Determines whether the annotator includes a web-app for installation or general configuration.
    boolean
    hasExtWebapp()
    Determines whether the annotator includes an extras web-app.
    boolean
    hasTaskWebapp()
    Determines whether the annotator includes a web-app for task parameter configuration.
    AnnotatorDescriptorWrapper
    setAnnotatorId(String newAnnotatorId)
    Setter for annotatorId: Annotator ID.
    AnnotatorDescriptorWrapper
    setConfigParameterInfo(String newConfigParameterInfo)
    Setter for 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.
    AnnotatorDescriptorWrapper
    setExtApiInfo(String newExtApiInfo)
    Setter for 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.
    AnnotatorDescriptorWrapper
    setHasConfigWebapp(Boolean newHasConfigWebapp)
    Setter for hasConfigWebapp: Whether the annotator includes a web-app for installation or general configuration.
    AnnotatorDescriptorWrapper
    setHasExtWebapp(Boolean newHasExtWebapp)
    Setter for hasExtWebapp: Whether the annotator includes an extras web-app.
    AnnotatorDescriptorWrapper
    setHasTaskWebapp(Boolean newHasTaskWebapp)
    Setter for hasTaskWebapp: Whether the annotator includes a web-app for task parameter configuration.
    AnnotatorDescriptorWrapper
    setInfo(String newInfo)
    Setter for info: HTML-encoded description of the function of the annotator, for displaying to the user.
    AnnotatorDescriptorWrapper
    setMinimumApiVersion(String newMinimumApiVersion)
    Setter for minimumApiVersion: Get the minimum version of the nzilbb.ag API supported by the serializer.
    AnnotatorDescriptorWrapper
    setTaskParameterInfo(String newTaskParameterInfo)
    Setter for 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.
    AnnotatorDescriptorWrapper
    setVersion(String newVersion)
    Setter for version: Version of this implementation; versions will typically be numeric, but this is not a requirement.

    Methods inherited from class nzilbb.ag.automation.util.AnnotatorDescriptor

    compareTo, getAnnotatorClass, getAnnotatorClassLoader, getAnnotatorClassName, getInstance, getResource, toString

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface nzilbb.util.CloneableBean

    addExtraJsonAttributes, clonePropertiesFrom, fromJson, getClonedAttributes, getter, setter, toJson

  • Constructor Details

    • AnnotatorDescriptorWrapper

      public AnnotatorDescriptorWrapper()
      Default constructor.

  • Method Details

    • getAnnotatorId

      @ClonedProperty public String getAnnotatorId()
      Getter for annotatorId: Annotator ID.
      Overrides:
      getAnnotatorId in class nzilbb.ag.automation.util.AnnotatorDescriptor
      Returns:
      Annotator ID.

    • setAnnotatorId

      public AnnotatorDescriptorWrapper setAnnotatorId(String newAnnotatorId)
      Setter for annotatorId: Annotator ID.
      Parameters:
      newAnnotatorId - Annotator ID.
      Returns:
      A reference to this object, so that setters can be chained.

    • getVersion

      @ClonedProperty public String getVersion()
      Getter for version: Version of this implementation; versions will typically be numeric, but this is not a requirement.
      Overrides:
      getVersion in class nzilbb.ag.automation.util.AnnotatorDescriptor
      Returns:
      Version of this implementation; versions will typically be numeric, but this is not a requirement.

    • setVersion

      public AnnotatorDescriptorWrapper setVersion(String newVersion)
      Setter for version: Version of this implementation; versions will typically be numeric, but this is not a requirement.
      Parameters:
      newVersion - Version of this implementation; versions will typically be numeric, but this is not a requirement.
      Returns:
      A reference to this object, so that setters can be chained.

    • getMinimumApiVersion

      @ClonedProperty public String getMinimumApiVersion()
      Getter for minimumApiVersion: Get the minimum version of the nzilbb.ag API supported by the serializer.
      Overrides:
      getMinimumApiVersion in class nzilbb.ag.automation.util.AnnotatorDescriptor
      Returns:
      Get the minimum version of the nzilbb.ag API supported by the serializer.

    • setMinimumApiVersion

      public AnnotatorDescriptorWrapper setMinimumApiVersion(String newMinimumApiVersion)
      Setter for minimumApiVersion: Get the minimum version of the nzilbb.ag API supported by the serializer.
      Parameters:
      newMinimumApiVersion - Get the minimum version of the nzilbb.ag API supported by the serializer.
      Returns:
      A reference to this object, so that setters can be chained.

    • getInfo

      @ClonedProperty public String getInfo()
      Getter for info: HTML-encoded description of the function of the annotator, for displaying to the user.
      Overrides:
      getInfo in class nzilbb.ag.automation.util.AnnotatorDescriptor
      Returns:
      HTML-encoded description of the function of the annotator, for displaying to the user.

    • setInfo

      public AnnotatorDescriptorWrapper setInfo(String newInfo)
      Setter for info: HTML-encoded description of the function of the annotator, for displaying to the user.
      Parameters:
      newInfo - HTML-encoded description of the function of the annotator, for displaying to the user.
      Returns:
      A reference to this object, so that setters can be chained.

    • getTaskParameterInfo

      @ClonedProperty public String getTaskParameterInfo()
      Getter for 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.
      Overrides:
      getTaskParameterInfo in class nzilbb.ag.automation.util.AnnotatorDescriptor
      Returns:
      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.

    • setTaskParameterInfo

      public AnnotatorDescriptorWrapper setTaskParameterInfo(String newTaskParameterInfo)
      Setter for 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.
      Parameters:
      newTaskParameterInfo - 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.
      Returns:
      A reference to this object, so that setters can be chained.

    • getConfigParameterInfo

      @ClonedProperty public String getConfigParameterInfo()
      Getter for 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.
      Overrides:
      getConfigParameterInfo in class nzilbb.ag.automation.util.AnnotatorDescriptor
      Returns:
      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.

    • setConfigParameterInfo

      public AnnotatorDescriptorWrapper setConfigParameterInfo(String newConfigParameterInfo)
      Setter for 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.
      Parameters:
      newConfigParameterInfo - 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.
      Returns:
      A reference to this object, so that setters can be chained.

    • getExtApiInfo

      @ClonedProperty public String getExtApiInfo()
      Getter for 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.
      Overrides:
      getExtApiInfo in class nzilbb.ag.automation.util.AnnotatorDescriptor
      Returns:
      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.

    • setExtApiInfo

      public AnnotatorDescriptorWrapper setExtApiInfo(String newExtApiInfo)
      Setter for 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.
      Parameters:
      newExtApiInfo - 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.
      Returns:
      A reference to this object, so that setters can be chained.

    • hasConfigWebapp

      public boolean hasConfigWebapp()
      Determines whether the annotator includes a web-app for installation or general configuration.
      Overrides:
      hasConfigWebapp in class nzilbb.ag.automation.util.AnnotatorDescriptor
      Returns:
      true if the class includes a web-app at config/index.html, false otherwise.

    • getHasConfigWebapp

      @ClonedProperty public Boolean getHasConfigWebapp()
      Getter for hasConfigWebapp: Whether the annotator includes a web-app for installation or general configuration.
      Overrides:
      getHasConfigWebapp in class nzilbb.ag.automation.util.AnnotatorDescriptor
      Returns:
      Whether the annotator includes a web-app for installation or general configuration.

    • setHasConfigWebapp

      public AnnotatorDescriptorWrapper setHasConfigWebapp(Boolean newHasConfigWebapp)
      Setter for hasConfigWebapp: Whether the annotator includes a web-app for installation or general configuration.
      Parameters:
      newHasConfigWebapp - Whether the annotator includes a web-app for installation or general configuration.
      Returns:
      A reference to this object, so that setters can be chained.

    • hasTaskWebapp

      public boolean hasTaskWebapp()
      Determines whether the annotator includes a web-app for task parameter configuration.
      Overrides:
      hasTaskWebapp in class nzilbb.ag.automation.util.AnnotatorDescriptor
      Returns:
      true if the class includes a web-app at task/index.html, false otherwise.

    • getHasTaskWebapp

      @ClonedProperty public Boolean getHasTaskWebapp()
      Getter for hasTaskWebapp: Whether the annotator includes a web-app for task parameter configuration.
      Overrides:
      getHasTaskWebapp in class nzilbb.ag.automation.util.AnnotatorDescriptor
      Returns:
      Whether the annotator includes a web-app for task parameter configuration.

    • setHasTaskWebapp

      public AnnotatorDescriptorWrapper setHasTaskWebapp(Boolean newHasTaskWebapp)
      Setter for hasTaskWebapp: Whether the annotator includes a web-app for task parameter configuration.
      Parameters:
      newHasTaskWebapp - Whether the annotator includes a web-app for task parameter configuration.
      Returns:
      A reference to this object, so that setters can be chained.

    • hasExtWebapp

      public boolean hasExtWebapp()
      Determines whether the annotator includes an extras web-app.
      Overrides:
      hasExtWebapp in class nzilbb.ag.automation.util.AnnotatorDescriptor
      Returns:
      true if the class includes a web-app at ext/index.html, false otherwise.

    • getHasExtWebapp

      @ClonedProperty public Boolean getHasExtWebapp()
      Getter for hasExtWebapp: Whether the annotator includes an extras web-app.
      Overrides:
      getHasExtWebapp in class nzilbb.ag.automation.util.AnnotatorDescriptor
      Returns:
      Whether the annotator includes an extras web-app.

    • setHasExtWebapp

      public AnnotatorDescriptorWrapper setHasExtWebapp(Boolean newHasExtWebapp)
      Setter for hasExtWebapp: Whether the annotator includes an extras web-app.
      Parameters:
      newHasExtWebapp - Whether the annotator includes an extras web-app.
      Returns:
      A reference to this object, so that setters can be chained.