org.eclipse.rse.ui.view
Class SystemViewFilterReferenceAdapter

java.lang.Object
  org.eclipse.rse.ui.view.AbstractSystemViewAdapter
      org.eclipse.rse.ui.view.SystemViewFilterReferenceAdapter

All Implemented Interfaces:

IActionFilter, IBasicPropertyConstants, IDeferredWorkbenchAdapter, IPropertySource, IRemoteObjectIdentifier, ISystemDragDropAdapter, ISystemPropertyConstants, ISystemViewActionFilter, ISystemViewElementAdapter, IWorkbenchAdapter

public class SystemViewFilterReferenceAdapter

extends AbstractSystemViewAdapter

implements ISystemViewElementAdapter

Adapter for displaying SystemFilterReference objects in tree views. These are children of SystemFilterPoolReference and SystemFilterReference objects

Field Summary

Fields inherited from class org.eclipse.rse.ui.view.AbstractSystemViewAdapter

_lastResults, _lastSelected, canceledObject, EMPTY_STRING_LIST, emptyList, errorObject, filterString, MEMENTO_DELIM, MSG_SUB_PREFIX, MSG_SUB1, MSG_SUB2, msgList, nullObject, propertySourceInput, shell, viewer

Fields inherited from interface org.eclipse.rse.ui.view.ISystemViewElementAdapter

noActions

Fields inherited from interface org.eclipse.rse.ui.view.ISystemPropertyConstants

P_ARCHIVE_COMMENT, P_ARCHIVE_EXPANDEDSIZE, P_CCSID, P_COMMAND, P_COMMENT, P_COMPILETYPE_TYPES, P_DEFAULTUSERID, P_DESCRIPTION, P_ENVLIST, P_ERROR, P_ERROR_FILENAME, P_ERROR_LINENO, P_FILE_CANONICAL_PATH, P_FILE_CLASSIFICATION, P_FILE_HIDDEN, P_FILE_LASTMODIFIED, P_FILE_PATH, P_FILE_READABLE, P_FILE_READONLY, P_FILE_SIZE, P_FILE_WRITABLE, P_FILTER, P_FILTERS, P_FILTERSTRING, P_FILTERSTRINGS, P_FILTERSTRINGS_COUNT, P_HAS_CHILDREN, P_HOSTNAME, P_IS_ACTIVE, P_IS_CONNECTED, P_IS_CONNECTION_PRIVATE, P_NBRCHILDREN, P_NEWNAME, P_OK, P_ORIGIN, P_PARENT_FILTER, P_PARENT_FILTERPOOL, P_PASSWORD, P_PORT, P_PREFIX, P_PROFILE, P_RELATED_CONNECTION, P_SEARCH_LINE, P_SHELL_CONTEXT, P_SHELL_STATUS, P_SYSTEMTYPE, P_TYPE, P_USERACTION_DOMAIN, P_USERID, P_VENDOR, P_VIRTUAL_COMMENT, P_VIRTUAL_COMPRESSEDSIZE, P_VIRTUAL_COMPRESSIONMETHOD, P_VIRTUAL_COMPRESSIONRATIO, P_VRM

Fields inherited from interface org.eclipse.jface.viewers.IBasicPropertyConstants

P_CHILDREN, P_IMAGE, P_PARENT, P_TEXT

Constructor Summary

SystemViewFilterReferenceAdapter()

Method Summary

void	addActions(SystemMenuManager menu, IStructuredSelection selection, Shell shell, String menuGroup) Returns any actions that should be contributed to the popup menu for the given filter object.
boolean	canDelete(Object element) Return true if this object is deletable by the user.
boolean	canDrag(Object element) drag support is handled directly for filter references, rather than delegated here.
boolean	canDrop(Object element) Can this object be added as part of the filter?
boolean	canRename(Object element) Return true if this object is renamable by the user.
boolean	doDelete(Shell shell, Object element, IProgressMonitor monitor) Perform the delete action.
Object	doDrag(Object element, boolean sameSystemType, IProgressMonitor monitor) drag support is handled directory for filter references, rather than delegated here.
ISystemResourceSet	doDrag(SystemRemoteResourceSet set, IProgressMonitor monitor) Perform the drag on the given objects.
Object	doDrop(Object from, Object to, boolean sameSystemType, boolean sameSystem, int srcType, IProgressMonitor monitor) Add the absolute name of the from object to the list of filter strings for this filter
boolean	doRename(Shell shell, Object element, String name) Perform the rename action.
String	getAbsoluteName(Object element) Return the absolute name, versus just display name, of this object
String	getCanonicalNewName(Object element, String newName) Parent override.
Object[]	getChildren(IProgressMonitor monitor, Object element) Return the children of this object.
Object[]	getChildren(Object element) Return the children of this object.
ImageDescriptor	getImageDescriptor(Object element) Returns an image descriptor for the image.
String	getInputMementoHandle(Object element) Return what to save to disk to identify this element when it is the input object to a secondary Remote System Explorer perspective.
String	getMementoHandle(Object element) Return what to save to disk to identify this element in the persisted list of expanded elements.
String	getMementoHandleKey(Object element) Return a short string to uniquely identify the type of resource.
String	getName(Object element) Return the name of this object, which may be different than the display text ({#link #getText(Object)}.
ISystemValidator	getNameValidator(Object element) Return a validator for verifying the new name is correct.
Object	getParent(Object element) Return the parent of this object
ISubSystem	getSubSystem(Object element) Overridden from parent.
String	getText(Object element) Return the label for this object.
String	getType(Object element) Return the type label for this object
boolean	hasChildren(Object element) Return true if this object has children.
protected Object[]	internalGetChildren(IProgressMonitor monitor, Object element)
protected IPropertyDescriptor[]	internalGetPropertyDescriptors() Return our unique property descriptors
protected Object	internalGetPropertyValue(Object key) Return our unique property values
static boolean	isCommandFilter(ISystemFilter filter) Return true if the given filter is from a command subsystem
boolean	isPromptable(Object element) Return true if this object is a "prompting" object that prompts the user when expanded.
boolean	saveExpansionState(Object element) Somtimes we don't want to remember an element's expansion state, such as for temporarily inserted messages.
boolean	showGenericShowInTableAction(Object element) Don't show generic "Show in Table" if the factory asks not to
boolean	showOpenViewActions(Object element) Don't show "Open in new perspective" if this is promptable
boolean	showRefresh(Object element) Return true if we should show the refresh action in the popup for the element.
boolean	supportsDeferredQueries() Return whether deferred queries are supported.
boolean	testAttribute(Object target, String name, String value) Overide of parent method.
boolean	validateDrop(Object src, Object target, boolean sameSystem) Validate that the source and target for the drag and drop operation are compatable.

Methods inherited from class org.eclipse.rse.ui.view.AbstractSystemViewAdapter

addCommonRemoteActions, addDynamicPopupMenuActions, canDrag, canEdit, checkForNull, createSimplePropertyDescriptor, doDelete, doDeleteBatch, doDrop, doDrop, fetchDeferredChildren, getAdapter, getAlternateText, getCancelledMessageObject, getChildrenUsingExpandToFilter, getCurrentTreeView, getDefaultDescriptors, getEditableRemoteObject, getEditableValue, getEmptyMessageObject, getFailedMessageObject, getFilterString, getFilterStringFor, getFirstSelection, getInput, getLabel, getPropertyDescriptors, getPropertyValue, getPropertyValue, getRemoteAdapter, getRemoteSourceType, getRemoteSubSubType, getRule, getShell, getStatusLineText, getSystemFetchOperation, getSystemTree, getTranslatedFalse, getTranslatedNo, getTranslatedNotApplicable, getTranslatedNotAvailable, getTranslatedTrue, getTranslatedYes, getUniquePropertyDescriptors, getViewer, handleDoubleClick, initMsgObjects, isContainer, isPropertySet, namesAreEqual, resetPropertyValue, selectionChanged, setFilterString, setInput, setPropertySourceInput, setPropertyValue, setShell, setViewer, showDelete, showRename, sub, validateDrop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.rse.ui.view.ISystemViewElementAdapter

doDelete, doDeleteBatch, getAlternateText, getChildrenUsingExpandToFilter, getFilterString, getInput, getPropertyValue, getShell, getStatusLineText, getUniquePropertyDescriptors, getViewer, handleDoubleClick, namesAreEqual, selectionChanged, setFilterString, setInput, setPropertySourceInput, setShell, setViewer, showDelete, showRename

Methods inherited from interface org.eclipse.ui.views.properties.IPropertySource

getEditableValue, getPropertyDescriptors, getPropertyValue, isPropertySet, resetPropertyValue, setPropertyValue

Methods inherited from interface org.eclipse.rse.ui.view.ISystemDragDropAdapter

canDrag, doDrop, validateDrop

Constructor Detail

SystemViewFilterReferenceAdapter

public SystemViewFilterReferenceAdapter()

Method Detail

addActions

public void addActions(SystemMenuManager menu,
                       IStructuredSelection selection,
                       Shell shell,
                       String menuGroup)

Returns any actions that should be contributed to the popup menu for the given filter object.

Specified by:

addActions in interface ISystemViewElementAdapter

Specified by:

addActions in class AbstractSystemViewAdapter

Parameters:

menu - The menu to contribute actions to

selection - The window's current selection.

shell - Shell of viewer

menuGroup - recommended menu group to add actions to. If added to another group, you must be sure to create that group first.

See Also:

ISystemViewElementAdapter.addActions(SystemMenuManager, IStructuredSelection, Shell, String)

getSubSystem

public ISubSystem getSubSystem(Object element)

Overridden from parent.
Returns the subsystem that contains this object.

Specified by:

getSubSystem in interface ISystemViewElementAdapter

Overrides:

getSubSystem in class AbstractSystemViewAdapter

getImageDescriptor

public ImageDescriptor getImageDescriptor(Object element)

Returns an image descriptor for the image. More efficient than getting the image.

Specified by:

getImageDescriptor in interface ISystemViewElementAdapter

Specified by:

getImageDescriptor in class AbstractSystemViewAdapter

Parameters:

element - The element for which an image is desired

getText

public String getText(Object element)

Return the label for this object. Uses getName() on the filter pool object.

Specified by:

getText in interface ISystemViewElementAdapter

Specified by:

getText in class AbstractSystemViewAdapter

See Also:

AbstractSystemViewAdapter.getName(Object), AbstractSystemViewAdapter.getAbsoluteName(Object)

getName

public String getName(Object element)

Return the name of this object, which may be different than the display text ({#link #getText(Object)}.

Called by common rename and delete actions.

Specified by:

getName in interface ISystemViewElementAdapter

Overrides:

getName in class AbstractSystemViewAdapter

See Also:

AbstractSystemViewAdapter.getText(Object), AbstractSystemViewAdapter.getAbsoluteName(Object)

getAbsoluteName

public String getAbsoluteName(Object element)

Return the absolute name, versus just display name, of this object

Specified by:

getAbsoluteName in interface IRemoteObjectIdentifier

Specified by:

getAbsoluteName in class AbstractSystemViewAdapter

See Also:

AbstractSystemViewAdapter.getText(Object), AbstractSystemViewAdapter.getName(Object)

getType

public String getType(Object element)

Return the type label for this object

Specified by:

getType in interface ISystemViewElementAdapter

Specified by:

getType in class AbstractSystemViewAdapter

getParent

public Object getParent(Object element)

Return the parent of this object

Specified by:

getParent in interface ISystemViewElementAdapter

Specified by:

getParent in class AbstractSystemViewAdapter

getChildren

public Object[] getChildren(IProgressMonitor monitor,
                            Object element)

Return the children of this object. For filters, this is one or more of:

• filters if nested filters supported
• filter strings if user has elected to show filter strings in his preferences
• resolved objects for each filter string if user has elected NOT to show filter strings in his preferences

Specified by:

getChildren in interface ISystemViewElementAdapter

Overrides:

getChildren in class AbstractSystemViewAdapter

getChildren

public Object[] getChildren(Object element)

Return the children of this object. For filters, this is one or more of:

• filters if nested filters supported
• filter strings if user has elected to show filter strings in his preferences
• resolved objects for each filter string if user has elected NOT to show filter strings in his preferences

Specified by:

getChildren in interface ISystemViewElementAdapter

Specified by:

getChildren in class AbstractSystemViewAdapter

internalGetChildren

protected Object[] internalGetChildren(IProgressMonitor monitor,
                                       Object element)

hasChildren

public boolean hasChildren(Object element)

Return true if this object has children. That is, if the referenced filter has nested filters or filter strings.

Specified by:

hasChildren in interface ISystemViewElementAdapter

Specified by:

hasChildren in class AbstractSystemViewAdapter

isPromptable

public boolean isPromptable(Object element)

Return true if this object is a "prompting" object that prompts the user when expanded. For such objects, we do not try to save and restore their expansion state on F5 or between sessions.

Default is false unless this is a prompting filter

Specified by:

isPromptable in interface ISystemViewElementAdapter

Overrides:

isPromptable in class AbstractSystemViewAdapter

testAttribute

public boolean testAttribute(Object target,
                             String name,
                             String value)

Overide of parent method.
From IActionFilter so the popupMenus extension point can use <filter>, <enablement> or <visibility>. We add support is for the following:

1. name="filterType". The value is tested against the non-translated filter type. Note all subsystems support different types of filters.
2. name="showChangeFilterStringsPropertyPage". The value is tested against the call to the subsystem factory method showChangeFilterStringsPropertyPage(SystemFilter). Compares against "true" (default) or "false".

Specified by:

testAttribute in interface IActionFilter

Overrides:

testAttribute in class AbstractSystemViewAdapter

See Also:

IActionFilter.testAttribute(Object, String, String)

internalGetPropertyDescriptors

protected IPropertyDescriptor[] internalGetPropertyDescriptors()

Return our unique property descriptors

Specified by:

internalGetPropertyDescriptors in class AbstractSystemViewAdapter

Returns:

an array containing all descriptors to be added to the default set of descriptors, or null if no additional properties desired.

See Also:

AbstractSystemViewAdapter.createSimplePropertyDescriptor(String, String, String)

internalGetPropertyValue

protected Object internalGetPropertyValue(Object key)

Return our unique property values

Specified by:

internalGetPropertyValue in class AbstractSystemViewAdapter

Parameters:

key - the name of the property as named by its property descriptor

Returns:

the current value of the property or null if not a known property.

canDelete

public boolean canDelete(Object element)

Return true if this object is deletable by the user. If so, when selected, the Edit->Delete menu item will be enabled.

Specified by:

canDelete in interface ISystemViewElementAdapter

Overrides:

canDelete in class AbstractSystemViewAdapter

See Also:

AbstractSystemViewAdapter.showDelete(Object), AbstractSystemViewAdapter.doDelete(Shell,Object)

doDelete

public boolean doDelete(Shell shell,
                        Object element,
                        IProgressMonitor monitor)
                 throws Exception

Perform the delete action. This physically deletes the filter pool and all references.

Specified by:

doDelete in interface ISystemViewElementAdapter

Overrides:

doDelete in class AbstractSystemViewAdapter

Throws:

Exception

See Also:

AbstractSystemViewAdapter.showDelete(Object), AbstractSystemViewAdapter.canDelete(Object)

canRename

public boolean canRename(Object element)

Return true if this object is renamable by the user. If so, when selected, the Rename menu item will be enabled.

Specified by:

canRename in interface ISystemViewElementAdapter

Overrides:

canRename in class AbstractSystemViewAdapter

Returns:

true if this object is renamable by the user

See Also:

AbstractSystemViewAdapter.showRename(Object), AbstractSystemViewAdapter.doRename(Shell,Object,String), AbstractSystemViewAdapter.getNameValidator(Object), AbstractSystemViewAdapter.getCanonicalNewName(Object,String), AbstractSystemViewAdapter.namesAreEqual(Object,String)

doRename

public boolean doRename(Shell shell,
                        Object element,
                        String name)
                 throws Exception

Perform the rename action. Assumes uniqueness checking was done already.

Specified by:

doRename in interface ISystemViewElementAdapter

Overrides:

doRename in class AbstractSystemViewAdapter

Returns:

true if the rename was successful

Throws:

Exception

See Also:

AbstractSystemViewAdapter.showRename(Object), AbstractSystemViewAdapter.canRename(Object)

getNameValidator

public ISystemValidator getNameValidator(Object element)

Return a validator for verifying the new name is correct.

Specified by:

getNameValidator in interface ISystemViewElementAdapter

Overrides:

getNameValidator in class AbstractSystemViewAdapter

See Also:

AbstractSystemViewAdapter.canRename(Object)

getCanonicalNewName

public String getCanonicalNewName(Object element,
                                  String newName)

Parent override.

Form and return a new canonical (unique) name for this object, given a candidate for the new name. This is called by the generic multi-rename dialog to test that all new names are unique. To do this right, sometimes more than the raw name itself is required to do uniqueness checking.

Returns mgrName.poolName.filterName, upperCased

Specified by:

getCanonicalNewName in interface ISystemViewElementAdapter

Overrides:

getCanonicalNewName in class AbstractSystemViewAdapter

See Also:

AbstractSystemViewAdapter.canRename(Object)

showOpenViewActions

public boolean showOpenViewActions(Object element)

Don't show "Open in new perspective" if this is promptable

Specified by:

showOpenViewActions in interface ISystemViewElementAdapter

Overrides:

showOpenViewActions in class AbstractSystemViewAdapter

showGenericShowInTableAction

public boolean showGenericShowInTableAction(Object element)

Don't show generic "Show in Table" if the factory asks not to

Specified by:

showGenericShowInTableAction in interface ISystemViewElementAdapter

Overrides:

showGenericShowInTableAction in class AbstractSystemViewAdapter

showRefresh

public boolean showRefresh(Object element)

Return true if we should show the refresh action in the popup for the element.

Specified by:

showRefresh in interface ISystemViewElementAdapter

Overrides:

showRefresh in class AbstractSystemViewAdapter

getMementoHandle

public String getMementoHandle(Object element)

Return what to save to disk to identify this element in the persisted list of expanded elements. This just defaults to getName, but if that is not sufficient override it here.

Specified by:

getMementoHandle in interface ISystemViewElementAdapter

Overrides:

getMementoHandle in class AbstractSystemViewAdapter

getInputMementoHandle

public String getInputMementoHandle(Object element)

Return what to save to disk to identify this element when it is the input object to a secondary Remote System Explorer perspective.

Specified by:

getInputMementoHandle in interface ISystemViewElementAdapter

Overrides:

getInputMementoHandle in class AbstractSystemViewAdapter

getMementoHandleKey

public String getMementoHandleKey(Object element)

Return a short string to uniquely identify the type of resource. Eg "conn" for connection. This just defaults to getType, but if that is not sufficient override it here, since that is a translated string.

Specified by:

getMementoHandleKey in interface ISystemViewElementAdapter

Overrides:

getMementoHandleKey in class AbstractSystemViewAdapter

saveExpansionState

public boolean saveExpansionState(Object element)

Somtimes we don't want to remember an element's expansion state, such as for temporarily inserted messages. In these cases return false from this method. The default is true.

WE RETURN FALSE IF THIS IS A PROMPTABLE FILTER, COMMAND FILTER OR JOB FILTER.

Specified by:

saveExpansionState in interface ISystemViewElementAdapter

Overrides:

saveExpansionState in class AbstractSystemViewAdapter

isCommandFilter

public static boolean isCommandFilter(ISystemFilter filter)

Return true if the given filter is from a command subsystem

canDrag

public boolean canDrag(Object element)

drag support is handled directly for filter references, rather than delegated here.

Specified by:

canDrag in interface ISystemDragDropAdapter

Overrides:

canDrag in class AbstractSystemViewAdapter

See Also:

AbstractSystemViewAdapter.doDrag(Object,boolean,IProgressMonitor), AbstractSystemViewAdapter.canDrop(Object), AbstractSystemViewAdapter.doDrop(Object,Object,boolean,boolean,IProgressMonitor), AbstractSystemViewAdapter.validateDrop(Object,Object,boolean)

canDrop

public boolean canDrop(Object element)

Can this object be added as part of the filter?

Specified by:

canDrop in interface ISystemDragDropAdapter

Overrides:

canDrop in class AbstractSystemViewAdapter

See Also:

AbstractSystemViewAdapter.canDrag(Object), AbstractSystemViewAdapter.doDrag(Object,boolean,IProgressMonitor), AbstractSystemViewAdapter.doDrop(Object,Object,boolean,boolean,IProgressMonitor), AbstractSystemViewAdapter.validateDrop(Object,Object,boolean)

doDrag

public ISystemResourceSet doDrag(SystemRemoteResourceSet set,
                                 IProgressMonitor monitor)

Description copied from interface: ISystemDragDropAdapter

Perform the drag on the given objects.

Specified by:

doDrag in interface ISystemDragDropAdapter

Overrides:

doDrag in class AbstractSystemViewAdapter

Parameters:

set - the set of objects to copy

monitor - the progress monitor

Returns:

the set of objects as a result of the drag

doDrag

public Object doDrag(Object element,
                     boolean sameSystemType,
                     IProgressMonitor monitor)

drag support is handled directory for filter references, rather than delegated here.

Specified by:

doDrag in interface ISystemDragDropAdapter

Overrides:

doDrag in class AbstractSystemViewAdapter

See Also:

AbstractSystemViewAdapter.canDrag(Object), AbstractSystemViewAdapter.canDrop(Object), AbstractSystemViewAdapter.doDrop(Object,Object,boolean,boolean,IProgressMonitor), AbstractSystemViewAdapter.validateDrop(Object,Object,boolean)

doDrop

public Object doDrop(Object from,
                     Object to,
                     boolean sameSystemType,
                     boolean sameSystem,
                     int srcType,
                     IProgressMonitor monitor)

Add the absolute name of the from object to the list of filter strings for this filter

Specified by:

doDrop in interface ISystemDragDropAdapter

Overrides:

doDrop in class AbstractSystemViewAdapter

Returns:

the new object that was copied

See Also:

AbstractSystemViewAdapter.canDrag(Object), AbstractSystemViewAdapter.doDrag(Object,boolean,IProgressMonitor), AbstractSystemViewAdapter.canDrop(Object), AbstractSystemViewAdapter.validateDrop(Object,Object,boolean)

validateDrop

public boolean validateDrop(Object src,
                            Object target,
                            boolean sameSystem)

Validate that the source and target for the drag and drop operation are compatable.

Specified by:

validateDrop in interface ISystemDragDropAdapter

Overrides:

validateDrop in class AbstractSystemViewAdapter

Parameters:

src - the object to drop

target - the object which src is dropped in

sameSystem - whether this is the same system or not

Returns:

whether this is a valid operation

See Also:

AbstractSystemViewAdapter.canDrag(Object), AbstractSystemViewAdapter.doDrag(Object,boolean,IProgressMonitor), AbstractSystemViewAdapter.canDrop(Object), AbstractSystemViewAdapter.doDrop(Object,Object,boolean,boolean,IProgressMonitor)

supportsDeferredQueries

public boolean supportsDeferredQueries()

Description copied from interface: ISystemViewElementAdapter

Return whether deferred queries are supported. By default they are not supported. Subclasses must override this to return true if they are to support this.

Specified by:

supportsDeferredQueries in interface ISystemViewElementAdapter

Overrides:

supportsDeferredQueries in class AbstractSystemViewAdapter