Interface SessionSPI

All Known Implementing Classes:
FilteredSession, 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

    • getLanguages

      List<Language> getLanguages()
      Get the list of (unmodifiable) languages (if any) for the session

    • setLanguages

      void setLanguages(List<Language> languages)
      Set the list of languages for the session
      Parameters:
      languages -

    • getMediaLocation

      String getMediaLocation()
      Get/Set the media file location

    • getTierView

      List<TierViewItem> getTierView()
      Get the tier view
      Returns:
      tier view (unmodifiable)

    • setTierView

      void setTierView(List<TierViewItem> view)
      Set tier view
      Parameters:
      view -

    • getTiers

      List<TierDescription> getTiers()
      Get list of all tiers including system tiers
      Returns:
      list of all tiers including system tiers and user defined tiers

    • getSystemTierParameters

      Map<String,String> getSystemTierParameters(SystemTierType systemTier)
      Get tier parameters for system tier
      Parameters:
      systemTier -
      Returns:
      unmodifiable tier params for given system tier

    • putSystemTierParam

      void putSystemTierParam(SystemTierType systemTier, String key, String value)
      Set tier parameter for system tier
      Parameters:
      systemTier -
      key -
      value -

    • 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)

    • getTierAlignmentRules

      List<TierAlignmentRules> getTierAlignmentRules()

    • getTierAlignmentRules

      TierAlignmentRules getTierAlignmentRules(String tier1, String tier2)

    • putTierAlignmentRules

      void putTierAlignmentRules(TierAlignmentRules tierAlignmentRules)

    • deleteTierAlignmentRules

      void deleteTierAlignmentRules(String tier1, String tier2)

    • getBlindTiers

      List<String> getBlindTiers()
      Get list of blind tier names
      Returns:
      blind tier names

    • setBlindTiers

      void setBlindTiers(List<String> blindTiers)
      Set list of blind tier names
      Parameters:
      list - of tier names
      Throws:
      IllegalArgumentException - if tier names in list cannot be found in the list of tiers returned by getTiers

    • 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

      Map<String,String> getMetadata()
      Get the metadata
      Returns:
      Metadata

    • 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

    • setMediaLocation

      void setMediaLocation(String mediaLocation)
      Media location

    • addTranscriber

      void addTranscriber(Transcriber t)
      Add a new transcriber

    • removeTranscriber

      void removeTranscriber(Transcriber t)
      Remove a transcriber

    • removeTranscriber

      void removeTranscriber(String username)

    • removeParticipant

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

    • removeParticipant

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

    • getTranscript

      Transcript getTranscript()
      Get the transcript object which is the collection of all comments, gems and records.
      Returns:
      transcript object

    • getTimeline

      IntervalTiers getTimeline()
      Get the timeline object which is the collection of all timeline tiers.
      Returns:
      timeline object