Package ca.phon.session.spi

Interface RecordSPI

All Known Implementing Classes:
LazyRecord, LazyRecord, RecordImpl
public interface RecordSPI

  • Method Details

    • getUuid

      UUID getUuid()
      Record id
      Parameters:
      unique - id for this record

    • setUuid

      void setUuid(UUID id)
      Set id for the record

    • getSpeaker

      Participant getSpeaker()
      The participant (speaker). As of Phon 2.2, this method will return Participant.UNKNOWN instead of null
      Returns:
      IParticipant

    • setSpeaker

      void setSpeaker(Participant participant)
      Set the participant

    • getSegment

      Tier<MediaSegment> getSegment()
      Get media segment
      Returns:
      IMedia

    • setSegment

      void setSegment(Tier<MediaSegment> media)
      Set media segment
      Parameters:
      media -

    • isExcludeFromSearches

      boolean isExcludeFromSearches()
      Should we exclude this record from searches?

    • setExcludeFromSearches

      void setExcludeFromSearches(boolean excluded)
      Set exclusion from searches.
      Parameters:
      excluded -

    • getOrthography

      Tier<Orthography> getOrthography()
      Get the orthography tier.
      Returns:
      orthography tier

    • setOrthography

      void setOrthography(Tier<Orthography> ortho)
      Set the value of the orthography tier.
      Parameters:
      orthography -

    • getIPATarget

      Tier<IPATranscript> getIPATarget()
      Get the IPA Target tier
      Returns:
      the ipa target tier

    • setIPATarget

      void setIPATarget(Tier<IPATranscript> ipa)
      Set the value of the IPA Actual tier
      Parameters:
      ipa -

    • getIPAActual

      Tier<IPATranscript> getIPAActual()
      Get the IPA Actual tier
      Returns:
      the ipa actual tier

    • setIPAActual

      void setIPAActual(Tier<IPATranscript> ipa)
      Set the IPA Actual tier
      Parameters:
      ipa -

    • getPhoneAlignment

      Tier<PhoneMap> getPhoneAlignment()
      Get the phone alignment between IPA Target and IPA Actual
      Returns:
      phone alignment

    • setPhoneAlignment

      void setPhoneAlignment(Tier<PhoneMap> phoneAlignment)
      Set the phone alignment
      Parameters:
      phoneAlignment -

    • getNotes

      Tier<TierString> getNotes()
      Get the value of the notes tier
      Returns:
      the notes tier

    • setNotes

      void setNotes(Tier<TierString> notes)
      Set the value of the notes tier
      Parameters:
      notes -

    • getTierType

      Class<?> getTierType(String name)
      Get the register type of the given tier.
      Parameters:
      tier - name
      Returns:
      the tier type

    • getTier

      <T> Tier<T> getTier(String name, Class<T> type)
      Get the given tier with the expected type.
      Parameters:
      name -
      type -
      Returns:
      the specified tier or null if a tier with the given name and type are not found.

    • getTier

      Tier<?> getTier(String name)
      Get the given tier with unspecified typing.
      Returns:
      name

    • getExtraTierNames

      Set<String> getExtraTierNames()
      Return a list of user-defined tiers that are present in this record.
      Returns:
      the list of tier user-defined tier names present in this record

    • getTiersOfType

      <T> List<Tier<T>> getTiersOfType(Class<T> type)
      Return a list of all present tiers which have the given type.
      Parameters:
      type -
      Returns:
      list of tiers

    • hasTier

      boolean hasTier(String name)
      Parameters:
      tier - name
      Returns:
      true if this record contains the specified tier

    • putTier

      void putTier(Tier<?> tier)
      Add/set the given tier to the list of user defined tiers.
      Parameters:
      tier -

    • removeTier

      void removeTier(String name)
      Remove the dependent tier with the given name.
      Parameters:
      name -

    • getNumberOfComments

      int getNumberOfComments()
      number of comments
      Returns:
      number of comments

    • getComment

      Comment getComment(int idx)
      get comment at given index
      Parameters:
      idx -
      Returns:
      comment
      Throws:
      ArrayIndexOutOfBoundsException

    • addComment

      void addComment(Comment comment)
      Add comment
      Parameters:
      comment -

    • removeComment

      void removeComment(Comment comment)
      Remove comment
      Parameters:
      comment -

    • removeComment

      void removeComment(int idx)