public abstract class AbstractScriptSearchProvider<T> extends AbstractSearchProvider
Modifier and Type | Class and Description |
---|---|
protected class |
AbstractScriptSearchProvider.AbstractScriptSearchObject |
protected class |
AbstractScriptSearchProvider.MapIterator<K> |
protected class |
AbstractScriptSearchProvider.SimplePropertySO |
SearchProvider.SelectedObjectsHandler
Constructor and Description |
---|
AbstractScriptSearchProvider(DesignerContext context,
java.lang.String name,
java.lang.String moduleId,
java.lang.String resourceType,
java.lang.Runnable locateFunc) |
Modifier and Type | Method and Description |
---|---|
java.util.List<java.lang.Object> |
getCategories()
Returns a list of "categories", or sub-selectable units, supported by this search provider.
|
protected DesignerContext |
getContext() |
protected org.apache.log4j.Logger |
getLogger() |
java.lang.String |
getName()
Returns the name of the search provider, which will be used in the gateway and a UI to uniquely identify the
provider.
|
java.lang.String |
getSelectableObjectBaseKey()
Returns a key that will be used with
BundleUtil to get various descriptions of the selectable objects. |
protected T |
getTargetObject() |
boolean |
hasSelectableObjects()
Whether or not the set of objects searched by this provider is selectable- for examples, which groups or windows
are to be searched.
|
protected void |
loadTargetObject() |
protected void |
saveResource() |
void |
selectObjects(SearchProvider.SelectedObjectsHandler handler)
Instructs the SearchProvider to show a dialog in order to select the objects to search.
|
protected byte[] |
serialize(java.lang.Object resource) |
protected void |
showEditorWindow() |
notifySearchClosed, selectedObjectsToString, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getExecutor, retrieveSearchableObjects
public AbstractScriptSearchProvider(DesignerContext context, java.lang.String name, java.lang.String moduleId, java.lang.String resourceType, java.lang.Runnable locateFunc)
protected DesignerContext getContext()
protected org.apache.log4j.Logger getLogger()
protected T getTargetObject()
public java.util.List<java.lang.Object> getCategories()
SearchProvider
public java.lang.String getName()
SearchProvider
public java.lang.String getSelectableObjectBaseKey()
AbstractSearchProvider
BundleUtil
to get various descriptions of the selectable objects. It
is expected that the following keys exist:getSelectableObjectBaseKey
in class AbstractSearchProvider
BundleUtil
key corresponding to a description for a selectable object.public boolean hasSelectableObjects()
SearchProvider
public void selectObjects(SearchProvider.SelectedObjectsHandler handler)
SearchProvider
protected void loadTargetObject()
protected void saveResource()
protected byte[] serialize(java.lang.Object resource) throws SerializationException
SerializationException
protected void showEditorWindow()