Package org.silverpeas.core.webapi.pdc

Interface LocalizedValue

  • All Known Implementing Classes:
    LocalizedClassifyValue, LocalizedPdcAxisValue
    public interface LocalizedValue
    A value of a PdC's axis either used in a position of a classification the PdC or in as a axis value. This value has the particularity to be localized according to the language of the user to which it has to be displayed.

    • Field Detail

      • MAX_NUMBER_OF_RENDERED_PATH_NODE

        static final int MAX_NUMBER_OF_RENDERED_PATH_NODE
        Maximum number of value terms to render in the value rendering. If the path of value is greater than this number, then it is truncated. An axis value is in fact a path of terms, each of them refining the parent term. In order to avoid a long value rendering, the path is usually truncated between the first terms and the last ones. This parameter indicates the maximum number of terms in a path to display.
        See Also:
        Constant Field Values

      • NUMBER_OF_RENDERED_PATH_NODE_IN_TRUNCATION

        static final int NUMBER_OF_RENDERED_PATH_NODE_IN_TRUNCATION
        Number of value terms to render before and after the the truncation separator in a truncated axis value rendering. An axis value is in fact a path of terms, each of them refining the parent term. In order to avoid a long value rendering, the path is usually truncated between the first terms and the last ones. This parameter indicates the number of terms to print out before and after the truncation.
        See Also:
        Constant Field Values

      • TRUNCATION_SEPARATOR

        static final String TRUNCATION_SEPARATOR
        The truncator symbol to use in a truncated value rendering.
        See Also:
        Constant Field Values

      • SEPARATOR_PATH

        static final String SEPARATOR_PATH
        The path separator to use in an axis value rendering.
        See Also:
        Constant Field Values

    • Method Detail

      • getLocalizedPath

        String getLocalizedPath()
        Gets the path of the value whose the terms are translated in a given language.
        Returns:
        the translated path to render.

      • getLanguage

        String getLanguage()
        Gets the language in which the path of the value is localized.
        Returns: