Package com.inductiveautomation.perspective.designer.search.script

Class SystemEventsSearchProvider

java.lang.Object

com.inductiveautomation.ignition.designer.findreplace.AbstractSearchProvider

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

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

com.inductiveautomation.perspective.designer.search.script.SystemEventsSearchProvider

All Implemented Interfaces:

SearchProvider

public class SystemEventsSearchProvider
extends ScriptConfigSearchProvider<SystemEventsConfig>

Nested Class Summary

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

ScriptConfigSearchProvider.SearchObjectListCursor

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 inherited from class com.inductiveautomation.ignition.designer.scripteditor.ScriptConfigSearchProvider

workspace

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected SystemEventsConfig	deserialize(Resource resource)
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

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

Constructor Details

SystemEventsSearchProvider

public SystemEventsSearchProvider(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.

Specified by:

retrieveSearchableObjects in interface SearchProvider

Overrides:

retrieveSearchableObjects in class ScriptConfigSearchProvider<SystemEventsConfig>

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

deserialize

protected SystemEventsConfig deserialize(Resource resource)
                                  throws Exception

Overrides:

deserialize in class AbstractScriptSearchProvider<SystemEventsConfig>

Throws:

Exception

migrateToResources

protected void migrateToResources()

Description copied from class: ScriptConfigSearchProvider

Calls the workspace to migrate event scripts

Overrides:

migrateToResources in class ScriptConfigSearchProvider<SystemEventsConfig>