Class IntervalTiers

java.lang.Object
ca.phon.extensions.ExtendableObject
ca.phon.session.IntervalTiers
All Implemented Interfaces:
IExtendable
public final class IntervalTiers extends ExtendableObject
Class which holds information about session interval tiers including:
  • length invalid input: '&' media unit
  • list of record tiers displayed in the timeline
  • list of session-level interval tiers

  • Method Details

    • getLength

      public float getLength()
      Return the length of the timeline as a float, unit is provided by getMediaUnit()
      Returns:
      length of timeline, this may be different from the actual media length

    • setLength

      public void setLength(float length)
      Set the length of the timeline
      Parameters:
      length - length of timeline, this may be different from the actual media length

    • getMediaUnit

      public MediaUnit getMediaUnit()
      Get media unit for value provided by getLength()
      Returns:
      media unit

    • setMediaUnit

      public void setMediaUnit(MediaUnit mediaUnit)
      Set media unit for value provided by getLength()
      Parameters:
      mediaUnit -

    • getRecordIntervalTiers

      public List<String> getRecordIntervalTiers()
      Return the list of record data tiers displayed in the timeline view of the session editor.
      Returns:
      list of record data tier names as an unmodifiable list

    • addRecordIntervalTier

      public boolean addRecordIntervalTier(String tierName)
      Add record interval tier
      Parameters:
      tierName -
      Returns:
      true if added, false if already exists

    • removeRecordIntervalTier

      public boolean removeRecordIntervalTier(String tierName)
      Remove record interval tier
      Parameters:
      tierName -
      Returns:
      true if removed, false if not found

    • getTiers

      public List<IntervalTier> getTiers()
      Get session level interval tiers as an unmodifiable list
      Returns:
      list of interval tiers

    • getTierNames

      public List<String> getTierNames()
      Get list of interval tier names
      Returns:
      list of session level interval tier names

    • getTier

      public IntervalTier getTier(String tierName)
      Get interval tier with given name
      Parameters:
      tierName -
      Returns:
      interval tier if exists, null otherwise

    • removeTier

      public IntervalTier removeTier(String tierName)
      Remove session level interval tier
      Parameters:
      tierName -
      Returns:
      the removed interval tier or null if not found or not removed

    • removeTier

      public boolean removeTier(IntervalTier tier)
      Remove session level interval tier
      Parameters:
      tier -
      Returns:
      true if removed, false if not found in tier list

    • addTier

      public IntervalTier addTier(String tierName)
      Add session level interval tier
      Parameters:
      tierName -
      Returns:
      new IntervalTierImpl if the given name does not exist, existing IntervalTierImpl if it does

    • addTier

      public boolean addTier(IntervalTier tier)
      Add session level interval tier
      Parameters:
      tier -
      Returns:
      true if added, false if tier with given name already exists