Package com._1c.g5.v8.dt.search.core.refactoring

Interface FullTextSearchRefactoringParticipant.IFullTextSearchRefactoringSupplier

All Superinterfaces:

IFullTextSearchSupplier

All Known Implementing Classes:

AbstractFullTextSearchRefactoringSupplierForQlSemanticLanguage, BasicHtmlFullTextSearchRefactoringSupplier, BslFullTextSearchRefactoringSupplier, CharacteristicDescriptionFullTextSearchRefactoringSupplier, DcsQueryFullTextSearchRefactoringSupplier, HtmlDocumentMdReferenceFullTextSearchRefactoringSupplier, RightQlFullTextSearchRefactoringSupplier, RightTemplateFullTextSearchRefactoringSupplier

Enclosing class:

FullTextSearchRefactoringParticipant

public static interface FullTextSearchRefactoringParticipant.IFullTextSearchRefactoringSupplier
extends IFullTextSearchSupplier

Special supplier for refactoring by results of full text search. Contains special methods for generating search strings, filtering search results and creating concrete changes for one IFile in project. Users should implement it for creating own refactoring logic.

Method Summary

Modifier and Type	Method	Description
Collection<org.eclipse.ltk.core.refactoring.Change>	createChanges(IBmObject bmObject, org.eclipse.ltk.core.refactoring.Change normalRefactoringChange, Collection<IDtMatchProvider> matches, String oldName, String newName)	Creates Changes for concrete IBmObject if there is no IFile for it and collection of DtMatch corresponding to the this object
Collection<org.eclipse.ltk.core.refactoring.Change>	createChanges(org.eclipse.core.resources.IFile file, org.eclipse.ltk.core.refactoring.Change normalRefactoringChange, Collection<IDtMatchProvider> matches, String oldName, String newName)	Creates Changes for concrete IFile in project and collection of DtMatch corresponding to the file
default IBmObject	getGroupingBmObject(DtMatch searchResult)	Gets object for grouping search result for refactoring
Collection<IDtMatchProvider>	getMatches(org.eclipse.ltk.core.refactoring.Change change, RefactoringFullTextSearchResultCollector collector)	Gets all found DtMatch in full text search except matches intersect with change
SearchType	getSearchType()	The target search type for the FTS search

Methods inherited from interface com._1c.g5.v8.dt.search.core.IFullTextSearchSupplier

filterSearchResult, getSearchStrings, isObjectTextAttribute

Method Detail

createChanges

Collection<org.eclipse.ltk.core.refactoring.Change> createChanges(org.eclipse.core.resources.IFile file,
                                                                  org.eclipse.ltk.core.refactoring.Change normalRefactoringChange,
                                                                  Collection<IDtMatchProvider> matches,
                                                                  String oldName,
                                                                  String newName)

Creates Changes for concrete IFile in project and collection of DtMatch corresponding to the file

Parameters:

file - concrete IFile in project containing search results, cannot be null

normalRefactoringChange - refactoring change, if we found correct full text search match in file with normal refactoring changes, we should add full text search changes to exiting change, cannot be null

matches - collection of DtMatch corresponding to the file, cannot be null

oldName - original name, cannot be null

newName - new name of the renaming element, cannot be null

Returns:

created Changes for concrete IFile in project and collection of DtMatch corresponding to the file

createChanges

Collection<org.eclipse.ltk.core.refactoring.Change> createChanges(IBmObject bmObject,
                                                                  org.eclipse.ltk.core.refactoring.Change normalRefactoringChange,
                                                                  Collection<IDtMatchProvider> matches,
                                                                  String oldName,
                                                                  String newName)

Creates Changes for concrete IBmObject if there is no IFile for it and collection of DtMatch corresponding to the this object

Parameters:

bmObject - concrete IBmObject containing search results, cannot be null

normalRefactoringChange - refactoring change, if we found correct full text search match in file with normal refactoring changes, we should add full text search changes to exiting change, cannot be null

matches - collection of DtMatch corresponding to the file, cannot be null

oldName - original name, cannot be null

newName - new name of the renaming element, cannot be null

Returns:

created Changes for concrete IBmObject in project and collection of DtMatch corresponding to the object

getMatches

Collection<IDtMatchProvider> getMatches(org.eclipse.ltk.core.refactoring.Change change,
                                        RefactoringFullTextSearchResultCollector collector)

Gets all found DtMatch in full text search except matches intersect with change

Parameters:

change - refactoring change for filtering matches which intersect with them, cannot be null

collector - RefactoringFullTextSearchResultCollector full text search collector, cannot be null

Returns:

all found DtMatch in full text search except matches intersect with change, never null

getSearchType

SearchType getSearchType()

The target search type for the FTS search

Returns:

The index type. May not be nulla

getGroupingBmObject

default IBmObject getGroupingBmObject(DtMatch searchResult)

Gets object for grouping search result for refactoring

Parameters:

searchResult - actual DtMatch for refactoring, cannot be null

Returns:

grouping IBmObject, never null