Class Upload


  • public class Upload
    extends Object
    Information about a transcript or fragment upload in progress.
    Author:
    Robert Fromont robert@fromont.net.nz
    • Constructor Summary

      Constructors 
      Constructor Description
      Upload()
      Default constructor.
      Upload​(javax.json.JsonObject json)
      Constructor from JSON.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Double getEnd()
      Getter for end: The end offset of the fragment (if the upload is for a fragment).
      String getId()
      Getter for id: Unique upload identifier.
      nzilbb.configure.ParameterSet getParameters()
      Getter for parameters: Parameters that are required to complete the upload.
      Double getStart()
      Getter for start: The start offset of the fragment (if the upload is for a fragment).
      String getTranscript()
      Getter for transcript: The name of the full transcript (if the upload is for a fragment).
      Map<String,​String> getTranscripts()
      Getter for transcripts: A map of transcript IDs to thread IDs, if any transcripts are already being processed.
      String getUrl()
      Getter for url: The URL of the fragment in the context of the whole transcript (if the upload is for a fragment).
      Upload setEnd​(Double newEnd)
      Setter for end: The end offset of the fragment (if the upload is for a fragment).
      Upload setId​(String newId)
      Setter for id: Unique upload identifier.
      Upload setParameters​(nzilbb.configure.ParameterSet newParameters)
      Setter for parameters: Parameters that are required to complete the upload.
      Upload setStart​(Double newStart)
      Setter for start: The start offset of the fragment (if the upload is for a fragment).
      Upload setTranscript​(String newTranscript)
      Setter for transcript: The name of the full transcript (if the upload is for a fragment).
      Upload setTranscripts​(Map<String,​String> newTranscripts)
      Setter for transcripts: A map of transcript IDs to thread IDs, if any transcripts are already being processed.
      Upload setUrl​(String newUrl)
      Setter for url: The URL of the fragment in the context of the whole transcript (if the upload is for a fragment).
    • Constructor Detail

      • Upload

        public Upload()
        Default constructor.
      • Upload

        public Upload​(javax.json.JsonObject json)
        Constructor from JSON.
        Parameters:
        json - A JSON representation of the object to construct.
    • Method Detail

      • getId

        public String getId()
        Getter for id: Unique upload identifier.
        Returns:
        Unique upload identifier.
      • setId

        public Upload setId​(String newId)
        Setter for id: Unique upload identifier.
        Parameters:
        newId - Unique upload identifier.
        Returns:
        A reference to this object, so that setters can be chained.
      • getParameters

        public nzilbb.configure.ParameterSet getParameters()
        Getter for parameters: Parameters that are required to complete the upload.
        Returns:
        Parameters that are required to complete the upload.
      • setParameters

        public Upload setParameters​(nzilbb.configure.ParameterSet newParameters)
        Setter for parameters: Parameters that are required to complete the upload.
        Parameters:
        newParameters - Parameters that are required to complete the upload.
        Returns:
        A reference to this object, so that setters can be chained.
      • getTranscripts

        public Map<String,​String> getTranscripts()
        Getter for transcripts: A map of transcript IDs to thread IDs, if any transcripts are already being processed.
        Returns:
        A map of transcript IDs to thread IDs, if any transcripts are already being processed.
      • setTranscripts

        public Upload setTranscripts​(Map<String,​String> newTranscripts)
        Setter for transcripts: A map of transcript IDs to thread IDs, if any transcripts are already being processed.
        Parameters:
        newTranscripts - A map of transcript IDs to thread IDs, if any transcripts are already being processed.
        Returns:
        A reference to this object, so that setters can be chained.
      • getTranscript

        public String getTranscript()
        Getter for transcript: The name of the full transcript (if the upload is for a fragment).
        Returns:
        The name of the full transcript (if the upload is for a fragment).
      • setTranscript

        public Upload setTranscript​(String newTranscript)
        Setter for transcript: The name of the full transcript (if the upload is for a fragment).
        Parameters:
        newTranscript - The name of the full transcript (if the upload is for a fragment).
      • getStart

        public Double getStart()
        Getter for start: The start offset of the fragment (if the upload is for a fragment).
        Returns:
        The start offset of the fragment (if the upload is for a fragment).
      • setStart

        public Upload setStart​(Double newStart)
        Setter for start: The start offset of the fragment (if the upload is for a fragment).
        Parameters:
        newStart - The start offset of the fragment (if the upload is for a fragment).
      • getEnd

        public Double getEnd()
        Getter for end: The end offset of the fragment (if the upload is for a fragment).
        Returns:
        The end offset of the fragment (if the upload is for a fragment).
      • setEnd

        public Upload setEnd​(Double newEnd)
        Setter for end: The end offset of the fragment (if the upload is for a fragment).
        Parameters:
        newEnd - The end offset of the fragment (if the upload is for a fragment).
      • getUrl

        public String getUrl()
        Getter for url: The URL of the fragment in the context of the whole transcript (if the upload is for a fragment).
        Returns:
        The URL of the fragment in the context of the whole transcript (if the upload is for a fragment).
      • setUrl

        public Upload setUrl​(String newUrl)
        Setter for url: The URL of the fragment in the context of the whole transcript (if the upload is for a fragment).
        Parameters:
        newUrl - The URL of the fragment in the context of the whole transcript (if the upload is for a fragment).