Package com.inductiveautomation.ignition.designer.scripteditor

Class ScriptConfigSearchProvider<T extends ScriptConfig>

java.lang.Object

com.inductiveautomation.ignition.designer.findreplace.AbstractSearchProvider

com.inductiveautomation.ignition.designer.scripteditor.AbstractScriptSearchProvider<T>

com.inductiveautomation.ignition.designer.scripteditor.ScriptConfigSearchProvider<T>

All Implemented Interfaces:

SearchProvider

Direct Known Subclasses:

ClientScriptSearchProvider, PerspectiveGatewayEventsSearchProvider, SystemEventsSearchProvider

public class ScriptConfigSearchProvider<T extends ScriptConfig>
extends AbstractScriptSearchProvider<T>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ScriptConfigSearchProvider.SearchObjectListCursor	Cursor for iterating over a list of search objects pertaining to event scripts search objects

Nested classes/interfaces inherited from class com.inductiveautomation.ignition.designer.scripteditor.AbstractScriptSearchProvider

AbstractScriptSearchProvider.MapIterator<K>

Nested classes/interfaces inherited from interface com.inductiveautomation.ignition.designer.findreplace.SearchProvider

SearchProvider.SelectedObjectsHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected ResourceWorkspace	workspace

Constructor Summary

Constructors

Constructor	Description
ScriptConfigSearchProvider(DesignerContext context, String name, ResourceType resourceType, Runnable locateFunc, ResourceWorkspace workspace)

Method Summary

Modifier and Type	Method	Description
protected void	migrateToResources()	Calls the workspace to migrate event scripts
Iterator<SearchObject>	retrieveSearchableObjects(Collection<Object> categories, List<Object> searchObjects, TaskProgressListener progress)	Returns an iterator that provides all of the objects described by the parameters.

Methods inherited from class com.inductiveautomation.ignition.designer.scripteditor.AbstractScriptSearchProvider

deserialize, getCategories, getContext, getLogger, getName, getSelectableObjectBaseKey, getTargetObject, hasSelectableObjects, loadTargetObject, saveResource, selectObjects, serialize, showEditorWindow

Methods inherited from class com.inductiveautomation.ignition.designer.findreplace.AbstractSearchProvider

notifySearchClosed, selectedObjectsToString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.ignition.designer.findreplace.SearchProvider

addAsyncReplaceListener, getExecutor, getId

Field Details

workspace

protected ResourceWorkspace workspace

Constructor Details

ScriptConfigSearchProvider

public ScriptConfigSearchProvider(DesignerContext context,
 String name,
 ResourceType resourceType,
 Runnable locateFunc,
 ResourceWorkspace workspace)

Method Details

retrieveSearchableObjects

public Iterator<SearchObject> retrieveSearchableObjects(Collection<Object> categories,
 List<Object> searchObjects,
 TaskProgressListener progress)

Description copied from interface: SearchProvider

Returns an iterator that provides all of the objects described by the parameters. The iterator will generally stream the results, calculating the next object on each call to hasNext().

The provided ProgressListener can be used to provide progress information as the Iterator is processed. Some providers may not be able to calculate progress, in which case they should call setIndeterminate(true), but the provider implementors are encouraged to provide anything they can, even if it's very coarse.

Parameters:

categories - indicates the user selection (if applicable) of which categories should be searched.

searchObjects - the user selected objects (if applicable) to be searched.

progress - a progress listener for this provider, which can be updated as the returned Iterator is used. If not supported, the provider should call setIndeterminate(true).

migrateToResources

protected void migrateToResources()

Calls the workspace to migrate event scripts