Package com._1c.g5.v8.dt.html.refactoring

Class BasicHtmlFullTextSearchRefactoringSupplier

java.lang.Object

com._1c.g5.v8.dt.html.refactoring.BasicHtmlFullTextSearchRefactoringSupplier

All Implemented Interfaces:

IFullTextSearchSupplier, FullTextSearchRefactoringParticipant.IFullTextSearchRefactoringSupplier

Direct Known Subclasses:

HtmlDocumentMdReferenceFullTextSearchRefactoringSupplier

public class BasicHtmlFullTextSearchRefactoringSupplier
extends Object
implements FullTextSearchRefactoringParticipant.IFullTextSearchRefactoringSupplier

Basic FullTextSearchRefactoringParticipant.IFullTextSearchRefactoringSupplier for HTML files

Clients may extend this class, when defining their own search result filter (filterExtension(IDtMatchProvider)).

Constructor Summary

Constructors

Constructor	Description
BasicHtmlFullTextSearchRefactoringSupplier()

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
protected boolean	filterExtension(IDtMatchProvider matchProvider)	Extend filter for every IDtMatchProvider from search result collection
Collection<IDtMatchProvider>	filterSearchResult(org.eclipse.emf.ecore.EObject context, String oldName, Collection<IDtMatchProvider> results)	Filters search results
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
Collection<String>	getSearchStrings(org.eclipse.emf.ecore.EObject context, String oldName)	Generates strings for full text search by renaming element and its original name
SearchType	getSearchType()	The target search type for the FTS search
boolean	isObjectTextAttribute(IBmObject bmObject)	Checks that refactoring for this object does not link with IFile corresponding to the bmObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface com._1c.g5.v8.dt.search.core.refactoring.FullTextSearchRefactoringParticipant.IFullTextSearchRefactoringSupplier

getGroupingBmObject

Constructor Detail

BasicHtmlFullTextSearchRefactoringSupplier

public BasicHtmlFullTextSearchRefactoringSupplier()

Method Detail

getSearchStrings

public Collection<String> getSearchStrings(org.eclipse.emf.ecore.EObject context,
                                           String oldName)

Description copied from interface: IFullTextSearchSupplier

Generates strings for full text search by renaming element and its original name

Specified by:

getSearchStrings in interface IFullTextSearchSupplier

Parameters:

context - renaming element, cannot be null

oldName - original name, cannot be null

Returns:

strings for full text search by renaming element and its original name, never null

filterSearchResult

public Collection<IDtMatchProvider> filterSearchResult(org.eclipse.emf.ecore.EObject context,
                                                       String oldName,
                                                       Collection<IDtMatchProvider> results)

Description copied from interface: IFullTextSearchSupplier

Filters search results

Specified by:

filterSearchResult in interface IFullTextSearchSupplier

Parameters:

context - renaming element, cannot be null

oldName - original name, cannot be null

results - full text search results for filtering, cannot be null

Returns:

filtered search result, never null

isObjectTextAttribute

public boolean isObjectTextAttribute(IBmObject bmObject)

Description copied from interface: IFullTextSearchSupplier

Checks that refactoring for this object does not link with IFile corresponding to the bmObject

Specified by:

isObjectTextAttribute in interface IFullTextSearchSupplier

Parameters:

bmObject - object which has attribute changing in refactoring, cannot be null

Returns:

true if refactoring for this object does not link with IFile corresponding to the bmObject, false otherwise

createChanges

public 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)

Description copied from interface: FullTextSearchRefactoringParticipant.IFullTextSearchRefactoringSupplier

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

Specified by:

createChanges in interface FullTextSearchRefactoringParticipant.IFullTextSearchRefactoringSupplier

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

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

Description copied from interface: FullTextSearchRefactoringParticipant.IFullTextSearchRefactoringSupplier

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

Specified by:

createChanges in interface FullTextSearchRefactoringParticipant.IFullTextSearchRefactoringSupplier

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

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

Description copied from interface: FullTextSearchRefactoringParticipant.IFullTextSearchRefactoringSupplier

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

Specified by:

getMatches in interface FullTextSearchRefactoringParticipant.IFullTextSearchRefactoringSupplier

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

public SearchType getSearchType()

Description copied from interface: FullTextSearchRefactoringParticipant.IFullTextSearchRefactoringSupplier

The target search type for the FTS search

Specified by:

getSearchType in interface FullTextSearchRefactoringParticipant.IFullTextSearchRefactoringSupplier

Returns:

The index type. May not be nulla

filterExtension

protected boolean filterExtension(IDtMatchProvider matchProvider)

Extend filter for every IDtMatchProvider from search result collection

Descendant classes may override this method to provide their own search result filter extension

Parameters:

matchProvider - the search result for filtering, cannot be null

Returns:

true if specified result passes filter conditions, false in otherwise