Package com._1c.g5.v8.dt.bsl.documentation.comment

Class LinkPart

    • Field Detail

      • MD_OBJECT_MANAGERS

        public static final Map<CaseInsensitiveString,​org.eclipse.emf.ecore.EReference> MD_OBJECT_MANAGERS
        Correspondence between keywords of Bsl language properties of manager types container and EReference to the configuration object collection

      • MD_OBJECT_MANAGERS_RU

        public static final Map<CaseInsensitiveString,​org.eclipse.emf.ecore.EReference> MD_OBJECT_MANAGERS_RU
        Correspondence between keywords in Russian of Bsl language properties of manager types container and EReference to the configuration object collection

      • SUPPORTED_MD_OBJECT_REFERENCES

        public static final Set<org.eclipse.emf.ecore.EReference> SUPPORTED_MD_OBJECT_REFERENCES
        Collection of the supporting EReference to the configuration object collection available for linking

      • SUBOBJECT_FEATURES

        public static final Map<org.eclipse.emf.ecore.EReference,​Collection<org.eclipse.emf.ecore.EStructuralFeature>> SUBOBJECT_FEATURES
        Correspondence between reference to the object that can be used in documentation comment and their sub objects

      • FORMS_FEATURES

        public static final Map<org.eclipse.emf.ecore.EReference,​org.eclipse.emf.ecore.EStructuralFeature> FORMS_FEATURES
        Correspondence between reference to the object that can be used in documentation comment and their forms

      • TEMPLATES_FEATURES

        public static final Map<org.eclipse.emf.ecore.EReference,​org.eclipse.emf.ecore.EStructuralFeature> TEMPLATES_FEATURES
        Correspondence between reference to the object that can be used in documentation comment and their templates

      • EXTERNAL_DATA_SOURCE_DIMENSION_TABLE

        public static final String EXTERNAL_DATA_SOURCE_DIMENSION_TABLE
        See Also:
        Constant Field Values

      • EXTERNAL_DATA_SOURCE_DIMENSION_TABLE_RU

        public static final String EXTERNAL_DATA_SOURCE_DIMENSION_TABLE_RU
        See Also:
        Constant Field Values

      • EXTERNAL_DATA_SOURCE_DIMENSION_TABLES

        public static final String EXTERNAL_DATA_SOURCE_DIMENSION_TABLES
        See Also:
        Constant Field Values

      • EXTERNAL_DATA_SOURCE_DIMENSION_TABLES_RU

        public static final String EXTERNAL_DATA_SOURCE_DIMENSION_TABLES_RU
        See Also:
        Constant Field Values

    • Constructor Detail

      • LinkPart

        public LinkPart​(IDescriptionPart parent,
                int lineNumber,
                int offset,
                String initialContent,
                String linkText)
        Constructor.
        Parameters:
        parent - the parent object, cannot be null.
        lineNumber - line nubmer corresponding to part
        offset - offset of the begining part
        initialContent - full content of the IDescriptionPart, cannot be null
        linkText - content of the link, cannot be null

      • LinkPart

        public LinkPart​(IDescriptionPart parent,
                int lineNumber,
                String linkText)
        Constructor.
        Parameters:
        parent - the parent object, cannot be null.
        lineNumber - line nubmer corresponding to part
        linkText - content of the link, cannot be null

    • Method Detail

      • getLinkText

        public String getLinkText()
        Gets content of the link
        Returns:
        content of the link, never null

      • setLinkText

        public void setLinkText​(String linkText)
        Sets content of the link
        Parameters:
        linkText - content of the link, cannot be null

      • setLinkTextOffset

        public void setLinkTextOffset​(int offset)
        Sets offset on the line of the begining link text content
        Parameters:
        offset - offset on the line of the begining link text content

      • getLinkTextOffset

        public int getLinkTextOffset()
        Gets offset on the line of the begining link text content
        Returns:
        offset on the line of the begining link text content

      • getPartsWithOffset

        public List<org.eclipse.xtext.util.Pair<String,​Integer>> getPartsWithOffset()
        Gets content of the link devided by the '.' and start offset of each part on the comment line
        Returns:
        collection of the parts of link content devided by '.' with their line offsets, never null

      • match

        public boolean match​(int lineNumber,
                     int offset)
        Description copied from interface: IDescriptionPart
        Checks that this description part corresponding to the concrete line number and offset
        Parameters:
        lineNumber - number of the documentation comment line
        offset - local offset on the comment line
        Returns:
        true if this description part corresponding to the send line number and offset, false otherwise

      • getMdObjectFirstSegment

        public Map<CaseInsensitiveString,​org.eclipse.emf.ecore.EReference> getMdObjectFirstSegment​(boolean isRu)
        Gets the first segment and EReference to the object collection for linking to the configuration object
        Parameters:
        isRu - true if the first segment should be in Russian, false in English
        Returns:
        map with the first segments and EReference to the object collection, never null

      • getMdObjectManagers

        public Map<CaseInsensitiveString,​org.eclipse.emf.ecore.EReference> getMdObjectManagers​(boolean isRu)
        Gets the first segment and EReference to the object collection for linking to the managers type collection
        Parameters:
        isRu - true if the first segment should be in Russian, false in English
        Returns:
        map with the first segments and EReference to the managers type collection, never null

      • getActualObjectForPart

        public org.eclipse.emf.ecore.EObject getActualObjectForPart​(int partNumber,
                                                            org.eclipse.xtext.scoping.IScopeProvider scopeProvider,
                                                            org.eclipse.emf.ecore.EObject contextObject)
        Try to get actual configuration object or method corresponding to the part of the linking content
        Parameters:
        partNumber - number of the linking text part for getting real object, see getPartsWithOffset(), range 0..getPartsWithOffset().size()
        scopeProvider - actual IScopeProvider, cannot be null
        contextObject - actual object for resolving, cannot be null
        Returns:
        actual configuration object or method corresponding to the part of the linking content, can be null if object cannot be found

      • getExportedMethods

        public List<Method> getExportedMethods​(org.eclipse.emf.ecore.EObject actualMdObject,
                                       org.eclipse.emf.ecore.EStructuralFeature moduleFeature)
        Gets Methods of module from actualMdObject and its moduleFeature
        Parameters:
        actualMdObject - for getting module with Methods, cannot be null
        moduleFeature - EStructuralFeature of the module for getting Methods, cannot be null
        Returns:
        Methods of module from actualMdObject and its moduleFeature, never null