Package ca.phon.session.spi

Interface SessionSPI

All Known Implementing Classes:
SessionImpl
public interface SessionSPI
service provider interface for sessions

  • Method Details

    • getCorpus

      String getCorpus()
      Get the corpus

    • getName

      String getName()
      Get the transcript name

    • getDate

      LocalDate getDate()
      Get the transcript date

    • getLanguage

      String getLanguage()
      Get the language

    • getMediaLocation

      String getMediaLocation()
      Get/Set the media file location

    • getTierView

      List<TierViewItem> getTierView()
      Get/Set the tier view

    • getUserTierCount

      int getUserTierCount()
      Number of user-defined tiers for this session

    • getUserTier

      TierDescription getUserTier(int idx)
      Get user tier for the specified index.
      Parameters:
      idx -
      Returns:
      tier description

    • removeUserTier

      TierDescription removeUserTier(int idx)
      Remove user tier
      Parameters:
      idx -

    • removeUserTier

      TierDescription removeUserTier(TierDescription tierDescription)

    • addUserTier

      void addUserTier(TierDescription tierDescription)
      Add a user tier

    • addUserTier

      void addUserTier(int idx, TierDescription tierDescription)

    • getTranscriberCount

      int getTranscriberCount()
      Get the number of transcribers

    • getTranscriber

      Transcriber getTranscriber(String username)
      Get transcriber for the specified username
      Parameters:
      username -
      Returns:

    • getTranscriber

      Transcriber getTranscriber(int i)
      Get the ith transcriber.
      Parameters:
      i -
      Returns:

    • removeTranscriber

      void removeTranscriber(int i)
      Remove the ith transcriber
      Parameters:
      i -

    • getMetadata

      SessionMetadata getMetadata()
      Get the metadata
      Returns:
      Metadata

    • getRecord

      Record getRecord(int pos)
      Return the record at the given index.
      Parameters:
      pos -
      Returns:
      the specified record

    • getRecordCount

      int getRecordCount()
      Return the number of records.
      Returns:
      the number of records

    • getRecordPosition

      int getRecordPosition(Record record)
      Get the position of the given record.
      Parameters:
      record -

    • setRecordPosition

      void setRecordPosition(Record record, int position)
      Set the position of the given record
      Parameters:
      record -
      position -

    • getParticipantCount

      int getParticipantCount()
      Get the number of participants
      Returns:
      the number of participants

    • addParticipant

      void addParticipant(Participant participant)
      Add a new participant
      Parameters:
      participant -

    • addParticipant

      void addParticipant(int idx, Participant participant)
      Add participant at given index
      Parameters:
      idx -
      participant -

    • getParticipant

      Participant getParticipant(int idx)
      Get the participant at the given index
      Parameters:
      idx -
      Returns:
      the specified participant

    • getParticipantIndex

      int getParticipantIndex(Participant participant)
      Get the index of the given participant
      Returns:
      index of participant or -1 if not found

    • setCorpus

      void setCorpus(String corpus)
      Set the corpus

    • setName

      void setName(String name)
      Set the transcript name

    • setDate

      void setDate(LocalDate date)
      Get the transcript date

    • setLanguage

      void setLanguage(String language)
      Set the language

    • setMediaLocation

      void setMediaLocation(String mediaLocation)
      Media location

    • setTierView

      void setTierView(List<TierViewItem> view)
      Tier view

    • addTranscriber

      void addTranscriber(Transcriber t)
      Add a new transcriber

    • removeTranscriber

      void removeTranscriber(Transcriber t)
      Remove a transcriber

    • removeTranscriber

      void removeTranscriber(String username)

    • addRecord

      void addRecord(Record record)
      Add a new record to the session
      Parameters:
      record -

    • addRecord

      void addRecord(int pos, Record record)
      Add a new record to the list in the given position.
      Parameters:
      pos -
      record -

    • removeRecord

      void removeRecord(Record record)
      Remove a record from the session.
      Parameters:
      record -

    • removeRecord

      void removeRecord(int pos)
      Remove a record from the session
      Parameters:
      pos -

    • removeParticipant

      void removeParticipant(Participant participant)
      Remove a participant.
      Parameters:
      participant -

    • removeParticipant

      void removeParticipant(int idx)
      Remove a participant
      Parameters:
      idx -