Class SyllabifierOptions

java.lang.Object
ca.phon.session.SyllabifierOptions
public final class SyllabifierOptions extends Object
Useful methods for finding the correct syllabifier in different situations

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    TIER_SYLLABIFIER
    IPA Transcript tier parameters key used for custom syllabifier settings

  • Constructor Summary

    Constructors
    Constructor
    Description
    SyllabifierOptions()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static Syllabifier
    findSyllabifier(Session session, Record record, Tier<IPATranscript> tier)
    Return syllabifier based on the following rules: If tier parameters has a value for key TIER_SYLLABIFIER, use syllabifier for that language if found If record language is set, attempt to find syllabifier for that language If session language is set, attempt to find syllabifier for that language Finally, return default syllabifier
    static Syllabifier
    findSyllabifier(Session session, Record record, String tierName)
    Return syllabifier based on the following rules: If tier parameters has a value for key TIER_SYLLABIFIER, use syllabifier for that language if found If record language is set, attempt to find syllabifier for that language If session language is set, attempt to find syllabifier for that language Finally, return default syllabifier
    static String
    getSyllabifierForTier(Session session, String tierName)
    Gets the custom syllabifier language for the given tier in the provided session.
    static void
    setSyllabifierForTier(Session session, String tierName, Syllabifier syllabifier)
    Set syllabifier language for tier in the provided session.
    static void
    setSyllabifierForTier(Session session, String tierName, String syllabifierLanguage)
    Set syllabifier language for tier in the provided session.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • TIER_SYLLABIFIER

      public static final String TIER_SYLLABIFIER
      IPA Transcript tier parameters key used for custom syllabifier settings
      See Also:

  • Constructor Details

    • SyllabifierOptions

      public SyllabifierOptions()

  • Method Details

    • findSyllabifier

      public static Syllabifier findSyllabifier(Session session, Record record, Tier<IPATranscript> tier)
      Return syllabifier based on the following rules:
          If tier parameters has a value for key TIER_SYLLABIFIER, use syllabifier for that language if found
          If record language is set, attempt to find syllabifier for that language
          If session language is set, attempt to find syllabifier for that language
          Finally, return default syllabifier
      Parameters:
      session - session, may be null
      record - record, may be null
      tier - tier, may be null
      Returns:
      syllabifier based on rules

    • findSyllabifier

      public static Syllabifier findSyllabifier(Session session, Record record, String tierName)
      Return syllabifier based on the following rules:
          If tier parameters has a value for key TIER_SYLLABIFIER, use syllabifier for that language if found
          If record language is set, attempt to find syllabifier for that language
          If session language is set, attempt to find syllabifier for that language
          Finally, return default syllabifier
      Parameters:
      session - session, may be null
      record - record, may be null
      tierName - tier name, may be null
      Returns:
      syllabifier based on rules

    • getSyllabifierForTier

      public static String getSyllabifierForTier(Session session, String tierName)
      Gets the custom syllabifier language for the given tier in the provided session. If the tier does not have a custom syllabifier set, this will return null.
      Parameters:
      session - session to get syllabifier for
      tierName - name of tier to get syllabifier for
      Returns:
      syllabifier language for tier, or null if not set

    • setSyllabifierForTier

      public static void setSyllabifierForTier(Session session, String tierName, Syllabifier syllabifier)
      Set syllabifier language for tier in the provided session. This will set the TIER_SYLLABIFIER property in the tier parameters for the session.
      Parameters:
      session - session to set syllabifier for
      tierName - name of tier to set syllabifier for
      syllabifier - language of syllabifier to set (may be null)

    • setSyllabifierForTier

      public static void setSyllabifierForTier(Session session, String tierName, String syllabifierLanguage)
      Set syllabifier language for tier in the provided session. This will set the TIER_SYLLABIFIER property in the tier parameters for the session.
      Parameters:
      session - session to set syllabifier for
      tierName - name of tier to set syllabifier for
      syllabifierLanguage - language of syllabifier to set (may be null)