Class Record

java.lang.Object
ca.phon.extensions.ExtendableObject
ca.phon.session.Record
All Implemented Interfaces:
IExtendable
public final class Record extends ExtendableObject
Record for phon Sessions composed of a number of tiers. By default, every record has the following tier:
  • Orthography - orthography transcription of utterance in the CHAT transcription format
  • IPA Target - model transcription of words in the utterance
  • IPA Actual - actual transcription of words
  • Segment - media segment time for record
As of Phon 4.0 the Notes tiers has been deprecated, use UserTierType.Comments instead. Additional tiers, called user-defined tiers, may also be added to the record.

  • Field Details

  • Method Details

    • getUuid

      @Deprecated public UUID getUuid()
      Deprecated.
      Unique id for record
      Returns:
      id

    • setUuid

      @Deprecated public void setUuid(UUID id)
      Deprecated.
      Parameters:
      id -

    • getSpeaker

      public Participant getSpeaker()
      Speaker for record, default Participant.UNKNOWN
      Returns:
      speaker

    • setSpeaker

      public void setSpeaker(Participant participant)

    • getLanguage

      public Language getLanguage()
      Language for record (if specified). Record language is written in orthography as '[- lang]' at the beginning of the utterance.
      Returns:
      language or null not specified

    • setLanguage

      public void setLanguage(Language language)

    • getMediaSegment

      public MediaSegment getMediaSegment()
      Get media segment for record
      Returns:
      media segment

    • setMediaSegment

      public void setMediaSegment(MediaSegment segment)
      Set media segment for record
      Parameters:
      segment -

    • getSegmentTier

      public Tier<MediaSegment> getSegmentTier()
      Get media segment tier
      Returns:
      segment tier

    • isExcludeFromSearches

      public boolean isExcludeFromSearches()
      Should we exclude this record from searches? This will be true if utterance-level annotations in the Orthography tier include 
      [e]
      (exclude) or 
      [* error]
      (error).
      Returns:
      true if record should be excluded

    • getOrthography

      public Orthography getOrthography()
      Get orthographic transcription for record. Utterances are written in the CHAT tanscription format.
      Returns:
      utterance

    • setOrthography

      public void setOrthography(Orthography orthography)

    • getOrthographyTier

      public Tier<Orthography> getOrthographyTier()
      Get orthography tier
      Returns:
      orthography tier

    • getIPATarget

      public IPATranscript getIPATarget()
      Get validated value of IPA Target tier
      Returns:
      ipa target

    • setIPATarget

      public void setIPATarget(IPATranscript ipa)
      Set validated value of IPA Target tier
      Parameters:
      ipa -

    • getIPATargetTier

      public Tier<IPATranscript> getIPATargetTier()
      Get IPA Target tier
      Returns:
      ipa target tier

    • getIPAActual

      public IPATranscript getIPAActual()
      Get validated value of IPA Actual tier
      Returns:
      ipa target

    • setIPAActual

      public void setIPAActual(IPATranscript ipa)
      Set validated value of IPA Actual tier
      Parameters:
      ipa -

    • getIPAActualTier

      public Tier<IPATranscript> getIPAActualTier()
      Get IPA Actual tier
      Returns:
      IPA Actual tier

    • getPhoneAlignment

      public PhoneAlignment getPhoneAlignment()
      Get validated phone alignment between IPA Target and IPA Actual
      Returns:
      phone alignment

    • setPhoneAlignment

      public void setPhoneAlignment(PhoneAlignment phoneAlignment)
      Set validated phone alignment between IPA Target and IPA Actual
      Parameters:
      phoneAlignment -

    • getPhoneAlignmentTier

      public Tier<PhoneAlignment> getPhoneAlignmentTier()
      Get phone alignment tier
      Returns:
      phone alignment tier

    • getNotes

      @Deprecated public TierData getNotes()
      Deprecated.
      since Phon 4.0, use 'Comments' tier instead
      Set validated value of Notes tier
      Returns:
      notes value

    • setNotes

      @Deprecated public void setNotes(TierData tierData)
      Deprecated.
      since Phon 4.0, use 'Comments' tier instead
      Get validated value of Notes tier
      Parameters:
      tierData -

    • getNotesTier

      @Deprecated public Tier<TierData> getNotesTier()
      Deprecated.
      since Phon 4.0, use 'Comments' tier instead
      Get Notes tier
      Returns:
      notes tier

    • getUserTiers

      public List<Tier<?>> getUserTiers()
      Get an unmodifiable list of all user tiers
      Returns:
      list of all user-defined tiers in record

    • getTierType

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

    • getTier

      public <T> Tier<T> getTier(String name, Class<T> type)
      Get the given tier with the expected type. Optional will be empty if tier does not exist in the record or the incorrect type was specified.
      Parameters:
      name -
      type -
      Returns:
      optional tier

    • getTier

      public Tier<?> getTier(String name)
      Get the given tier (type unspecified)
      Returns:
      name

    • getUserDefinedTierNames

      public Set<String> getUserDefinedTierNames()
      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

      public <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

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

    • setTierValue

      public <T> void setTierValue(String name, Class<T> type, T value)
      Set value for tier with name and type. No effect if the specified tier was not found.
      Type Parameters:
      T -
      Parameters:
      name -
      type -
      value -

    • getTierValue

      public Object getTierValue(String tierName)
      Get value for tier with type unspecified
      Parameters:
      tierName -
      Returns:
      tier value if present, null otherwise

    • getTierValue

      public <T> T getTierValue(String tierName, Class<T> type)
      Get value for tier with name and type. No effect if the specified tier was not found.
      Type Parameters:
      T -
      Parameters:
      tierName -
      type -
      Returns:
      value for tier or null if specified tier was not found

    • putTier

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

    • removeTier

      public void removeTier(String name)
      Remove user-defined tier from record
      Parameters:
      name -