Interface ISymbolicLinkLocalizer

  • All Known Implementing Classes:
    FormSymbolicLinkLocalizer, MdSymbolicLinkLocalizer

    public interface ISymbolicLinkLocalizer
    The interface of the component responsible for localizing symbolic link names from the English representation to another representation, for example, to Russian. The English representation of the symbolic link means that names of types and references are in English. The term of the Russian representation is defined similarly. Examples of the English and Russian representation are given below.

    English representation:

    • CatalogRef.Products
    • CatalogRef.Продукты
    Russian representation:
    • СправочникСсылка.Products
    • СправочникСсылка.Продукты

    • Method Detail

      • canLocalizeSymbolicLink

        boolean canLocalizeSymbolicLink​(String symbolicLink,
                                        org.eclipse.emf.ecore.EObject contextObject,
                                        org.eclipse.emf.ecore.EStructuralFeature feature,
                                        Locale locale)
        Tests whether the ISymbolicLinkLocalizer can localize the symbolicLink used for the referencing feature to the target locale. The symbolic links are not always unique in a global context, so in that cases you need to know the context the symbolic link is used for.
        Parameters:
        symbolicLink - the symbolic link, can not be null
        contextObject - the referencing object, may be null
        feature - the referencing feature, may be null
        locale - the target locale, can not be null
        Returns:
        true if the ISymbolicLinkLocalizer can localize the symbolicLink or false otherwise
      • localizeSymbolicLink

        String localizeSymbolicLink​(String symbolicLink,
                                    org.eclipse.emf.ecore.EObject contextObject,
                                    org.eclipse.emf.ecore.EStructuralFeature feature,
                                    Locale locale)
        Localizes the symbolicLink used for the referencing feature to the target locale. The symbolic links are not always unique in a global context, so in that cases you need to know the context the symbolic link is used for.
        Parameters:
        symbolicLink - the symbolic link, can not be null
        contextObject - the referencing object, may be null
        feature - the referencing feature, may be null
        locale - the target locale, can not be null
        Returns:
        the localized symbolic link or the original symbolic link, never null
      • canLocalizeSymbolicLink

        boolean canLocalizeSymbolicLink​(String symbolicLink,
                                        org.eclipse.emf.ecore.EObject contextObject,
                                        org.eclipse.emf.ecore.EStructuralFeature feature,
                                        ScriptVariant scriptVariant)
        Tests whether the ISymbolicLinkLocalizer can localize the symbolicLink used for the referencing feature to the target locale. The symbolic links are not always unique in a global context, so in that cases you need to know the context the symbolic link is used for.
        Parameters:
        symbolicLink - the symbolic link, can not be null
        contextObject - the referencing object, may be null
        feature - the referencing feature, may be null
        scriptVariant - the target ScriptVariant, can not be null
        Returns:
        true if the ISymbolicLinkLocalizer can localize the symbolicLink or false otherwise
      • localizeSymbolicLink

        String localizeSymbolicLink​(String symbolicLink,
                                    org.eclipse.emf.ecore.EObject contextObject,
                                    org.eclipse.emf.ecore.EStructuralFeature feature,
                                    ScriptVariant scriptVariant)
        Localizes the symbolicLink used for the referencing feature to the target ScriptVariant. The symbolic links are not always unique in a global context, so in that cases you need to know the context the symbolic link is used for.
        Parameters:
        symbolicLink - the symbolic link, can not be null
        contextObject - the referencing object, may be null
        feature - the referencing feature, may be null
        scriptVariant - the target ScriptVariant, can not be null
        Returns:
        the localized symbolic link or the original symbolic link, never null