org.eclipse.rse.files.ui.view
Class SystemViewRemoteFileAdapter

java.lang.Object
  org.eclipse.rse.ui.view.AbstractSystemViewAdapter
      org.eclipse.rse.files.ui.view.SystemViewRemoteFileAdapter

All Implemented Interfaces:

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

public class SystemViewRemoteFileAdapter

extends AbstractSystemViewAdapter

implements ISystemViewElementAdapter, ISystemRemoteElementAdapter, ISystemPropertyConstants

Adapter for displaying remote file system objects in tree views. These are children of RemoteFileSubSystem filter strings

Nested Class Summary

static class

SystemViewRemoteFileAdapter.RenameRunnable

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

SystemViewRemoteFileAdapter()
Constructor

SystemViewRemoteFileAdapter(boolean foldersOnly, boolean filesOnly)
Constructor for folders or files only

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 string object.
boolean	canDelete(Object element) Yes, remote file objects are deletable!
boolean	canDrag(Object element) Indicates whether the specified object can be copied or not.
boolean	canDrop(Object element) Indicates whether the specified object can have another object copied to it
boolean	canEdit(Object element) Indicates whether the specified object can be edited or not.
boolean	canRename(Object element) Yes, remote file objects are renamable!
protected String	checkForCollision(Shell shell, IRemoteFile targetFolder, String oldName)
protected static PropertyDescriptor	createSimplePropertyDescriptor(String keyAndLabel) Create and return a simple string readonly property descriptor.
boolean	doDelete(Shell shell, Object element) Deprecated. use the one with monitor now
boolean	doDelete(Shell shell, Object element, IProgressMonitor monitor) Perform the delete action.
boolean	doDeleteBatch(Shell shell, List resourceSet, IProgressMonitor monitor) Perform the delete action.
Object	doDrag(Object element, boolean sameSystem, IProgressMonitor monitor) Performs a drag copy operation.
ISystemResourceSet	doDrag(SystemRemoteResourceSet set, IProgressMonitor monitor) Overridable by subclasses, and is iff drag and drop supported.
ISystemResourceSet	doDrop(ISystemResourceSet fromSet, Object target, boolean sameSystemType, boolean sameSystem, int srcType, IProgressMonitor monitor) Perform drop from the "fromSet" of objects to the "to" object
Object	doDrop(Object src, Object target, boolean sameSystemType, boolean sameSystem, int sourceType, IProgressMonitor monitor) Perform a copy via drag and drop.
boolean	doRename(Shell shell, Object element, String newName) Perform the rename action.
String	getAbsoluteName(Object element) Return fully qualified name that uniquely identifies this object within its subsystem
String	getAbsoluteParentName(Object element) Return fully qualified name that uniquely identifies this remote object's remote parent within its subsystem
String	getAlternateText(Object element) Return the label for this object.
IFile	getCachedCopy(IRemoteFile remoteFile)
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.
ISystemEditableRemoteObject	getEditableRemoteObject(Object element) Return the remote edit wrapper for this object.
String	getFilterString() Get the current filter string being used to subset the list by.
String	getFilterStringFor(Object object) Return a filter string that corresponds to this object.
protected long	getFlatRemoteResourceSet(List initialResources, SystemRemoteResourceSet flatSet, IProgressMonitor monitor)
protected long	getFlatWorkspaceResourceSet(IResource[] resources, SystemWorkspaceResourceSet flatSet, IProgressMonitor monitor)
protected long	getFlatWorkspaceResourceSet(List resources, SystemWorkspaceResourceSet flatSet, IProgressMonitor monitor)
ImageDescriptor	getImageDescriptor(Object element) Returns an image descriptor for the image.
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
Object	getPropertyValue(Object property, boolean formatted) Returns the current value for the named property.
Object	getRemoteParent(Shell shell, Object element) Given a remote object, returns it remote parent object.
String[]	getRemoteParentNamesInUse(Shell shell, Object element) Given a remote object, return the unqualified names of the objects contained in that parent.
String	getRemoteSourceType(Object element) Return the source type of the selected object.
String	getRemoteSubSubType(Object element) Return the untranslated sub-subtype for this object.
String	getRemoteSubType(Object element) Return the untranslated subtype for this object.
String	getRemoteType(Object element) Return the untranslated type for this object.
String	getRemoteTypeCategory(Object element) Return a value for the type category property for this object The value must not be translated, so that property pages registered via xml can subset by it.
String	getStatusLineText(Object element) Return the string to display in the status line when the given object is selected.
ISubSystem	getSubSystem(Object element) Return subsystem
String	getSubSystemConfigurationId(Object element) Return the subsystem factory id that owns this remote object The value must not be translated, so that property pages registered via xml can subset by it.
protected SystemFetchOperation	getSystemFetchOperation(Object o, IElementCollector collector) Returns the SystemFetchOperation to be used in performing a query.
String	getText(Object element) Return the label for this object.
String	getType(Object element) Return the type label for this object
IPropertyDescriptor[]	getUniquePropertyDescriptors() Returns the list of property descriptors that are unique for this particular adapter - that is the difference between the default property descriptors and the total list of property descriptors.
boolean	handleDoubleClick(Object element) User has double clicked on an object.
boolean	hasChildren(Object element) Return true if this object has children.
protected IPropertyDescriptor[]	internalGetPropertyDescriptors() Return our unique property descriptors
protected Object	internalGetPropertyValue(Object key) Returns the current value for the named property.
boolean	namesAreEqual(Object element, String newName) Parent override.
boolean	refreshRemoteObject(Object oldElement, Object newElement) Some view has updated the name or properties of this remote object.
void	setFilterString(String filterString) Set a filter string to subset the list by.
boolean	supportsDeferredQueries() Return whether deferred queries are supported.
boolean	supportsUserDefinedActions(Object object) Returns false if the file is a virtual file, otherwise defaults to asking the subsystem factory.
boolean	testAttribute(Object target, String name, String value) From IActionFilter, it exposes properties for decorator and popupMenus extension points.
boolean	validateDrop(ISystemResourceSet srcSet, Object target, boolean sameSystem) Return true if it is valid for the src object to be dropped in the target
boolean	validateDrop(Object src, Object target, boolean sameSystem) Return true if it is valid for the src object to be dropped in the target

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

addCommonRemoteActions, addDynamicPopupMenuActions, canDrag, checkForNull, createSimplePropertyDescriptor, doDrop, fetchDeferredChildren, getAdapter, getCancelledMessageObject, getChildrenUsingExpandToFilter, getCurrentTreeView, getDefaultDescriptors, getEditableValue, getEmptyMessageObject, getFailedMessageObject, getFirstSelection, getInput, getInputMementoHandle, getLabel, getMementoHandle, getPropertyDescriptors, getPropertyValue, getRemoteAdapter, getRule, getShell, getSystemTree, getTranslatedFalse, getTranslatedNo, getTranslatedNotApplicable, getTranslatedNotAvailable, getTranslatedTrue, getTranslatedYes, getViewer, initMsgObjects, isContainer, isPromptable, isPropertySet, resetPropertyValue, saveExpansionState, selectionChanged, setInput, setPropertySourceInput, setPropertyValue, setShell, setViewer, showDelete, showGenericShowInTableAction, showOpenViewActions, showRefresh, showRename, sub

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

getChildrenUsingExpandToFilter, getInput, getInputMementoHandle, getMementoHandle, getShell, getViewer, isPromptable, saveExpansionState, selectionChanged, setInput, setPropertySourceInput, setShell, setViewer, showDelete, showGenericShowInTableAction, showOpenViewActions, showRefresh, 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

Constructor Detail

SystemViewRemoteFileAdapter

public SystemViewRemoteFileAdapter()

Constructor

SystemViewRemoteFileAdapter

public SystemViewRemoteFileAdapter(boolean foldersOnly,
                                   boolean filesOnly)

Constructor for folders or files only

Method Detail

setFilterString

public void setFilterString(String filterString)

Set a filter string to subset the list by. For example, "A*.java" or "java,class,". Only valid if filesOnly mode or foldersOnly mode.

Specified by:

setFilterString in interface ISystemViewElementAdapter

Overrides:

setFilterString in class AbstractSystemViewAdapter

getFilterString

public String getFilterString()

Get the current filter string being used to subset the list by. Will be null unless setFilterString has previously been called.

Specified by:

getFilterString in interface ISystemViewElementAdapter

Overrides:

getFilterString in class AbstractSystemViewAdapter

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

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 remote file object.

Specified by:

getText in interface ISystemViewElementAdapter

Specified by:

getText in class AbstractSystemViewAdapter

See Also:

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

getAlternateText

public String getAlternateText(Object element)

Return the label for this object. Uses getName() on the remote file object.

Specified by:

getAlternateText in interface ISystemViewElementAdapter

Overrides:

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

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

getStatusLineText

public String getStatusLineText(Object element)

Return the string to display in the status line when the given object is selected. We return: :

Specified by:

getStatusLineText in interface ISystemViewElementAdapter

Overrides:

getStatusLineText 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. If this is a folder or root, we list all child folders and files.

Specified by:

getChildren in interface ISystemViewElementAdapter

Overrides:

getChildren in class AbstractSystemViewAdapter

getChildren

public Object[] getChildren(Object element)

Return the children of this object. If this is a folder or root, we list all child folders and files.

Specified by:

getChildren in interface ISystemViewElementAdapter

Specified by:

getChildren in class AbstractSystemViewAdapter

hasChildren

public boolean hasChildren(Object element)

Return true if this object has children. Since we can't predict the outcome of resolving the filter string, we return true.

Specified by:

hasChildren in interface ISystemViewElementAdapter

Specified by:

hasChildren in class AbstractSystemViewAdapter

getUniquePropertyDescriptors

public IPropertyDescriptor[] getUniquePropertyDescriptors()

Description copied from interface: ISystemViewElementAdapter

Returns the list of property descriptors that are unique for this particular adapter - that is the difference between the default property descriptors and the total list of property descriptors.

Specified by:

getUniquePropertyDescriptors in interface ISystemViewElementAdapter

Overrides:

getUniquePropertyDescriptors in class AbstractSystemViewAdapter

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:

#createSimplePropertyDescriptor(String,ResourceBundle,String)

createSimplePropertyDescriptor

protected static PropertyDescriptor createSimplePropertyDescriptor(String keyAndLabel)

Create and return a simple string readonly property descriptor. For debug purposes

internalGetPropertyValue

protected Object internalGetPropertyValue(Object key)

Returns the current value for the named property.

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 given property

getPropertyValue

public Object getPropertyValue(Object property,
                               boolean formatted)

Returns the current value for the named property.

Specified by:

getPropertyValue in interface ISystemViewElementAdapter

Overrides:

getPropertyValue in class AbstractSystemViewAdapter

Parameters:

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

formatted - indication of whether to return the value in formatted or raw form

Returns:

the current value of the given property

canDrag

public boolean canDrag(Object element)

Indicates whether the specified object can be copied or not.

Specified by:

canDrag in interface ISystemDragDropAdapter

Overrides:

canDrag in class AbstractSystemViewAdapter

Parameters:

element - the object we want to try to copy

Returns:

whether this object can be copied or not

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)

Indicates whether the specified object can have another object copied to it

Specified by:

canDrop in interface ISystemDragDropAdapter

Overrides:

canDrop in class AbstractSystemViewAdapter

Parameters:

element - the object we want to try to copy to

Returns:

whether this object can be copied to or not

See Also:

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

validateDrop

public boolean validateDrop(ISystemResourceSet srcSet,
                            Object target,
                            boolean sameSystem)

Return true if it is valid for the src object to be dropped in the target

Specified by:

validateDrop in interface ISystemDragDropAdapter

Overrides:

validateDrop in class AbstractSystemViewAdapter

Parameters:

srcSet - the objects to drop

target - the object which src is dropped in

sameSystem - whether this is the same system

Returns:

whether this is a valid operation

validateDrop

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

Return true if it is valid for the src object to be dropped in the target

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

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)

doDrag

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

Performs a drag copy operation. The source object is uploaded to a temporary location so that it can later be dropped on another remote system.

Specified by:

doDrag in interface ISystemDragDropAdapter

Overrides:

doDrag in class AbstractSystemViewAdapter

Parameters:

element - the object which is being copied

sameSystem - an indication whether a transfer is being made between the same types of systems.

monitor - a progress monitor

Returns:

the temporary object that was created after the upload

See Also:

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

doDrag

public ISystemResourceSet doDrag(SystemRemoteResourceSet set,
                                 IProgressMonitor monitor)

Overridable by subclasses, and is iff drag and drop supported.
Perform the drag on the given objects. This default implementation simply iterates through the set. For optimal performance, this should be overridden.

Specified by:

doDrag in interface ISystemDragDropAdapter

Overrides:

doDrag in class AbstractSystemViewAdapter

Parameters:

set - the set of objects to copy

monitor - the progress monitor

Returns:

a temporary workspace copies of the object that was copied

getFlatRemoteResourceSet

protected long getFlatRemoteResourceSet(List initialResources,
                                        SystemRemoteResourceSet flatSet,
                                        IProgressMonitor monitor)

getFlatWorkspaceResourceSet

protected long getFlatWorkspaceResourceSet(List resources,
                                           SystemWorkspaceResourceSet flatSet,
                                           IProgressMonitor monitor)

getFlatWorkspaceResourceSet

protected long getFlatWorkspaceResourceSet(IResource[] resources,
                                           SystemWorkspaceResourceSet flatSet,
                                           IProgressMonitor monitor)

doDrop

public ISystemResourceSet doDrop(ISystemResourceSet fromSet,
                                 Object target,
                                 boolean sameSystemType,
                                 boolean sameSystem,
                                 int srcType,
                                 IProgressMonitor monitor)

Perform drop from the "fromSet" of objects to the "to" object

Specified by:

doDrop in interface ISystemDragDropAdapter

Overrides:

doDrop in class AbstractSystemViewAdapter

Parameters:

sameSystemType - indication of whether the source and target reside of the same type of system

sameSystem - indication of whether the source and target are on the same system

srcType - the type of objects to be dropped

monitor - the progress monitor

fromSet - the source objects for the drop

target - the target object for the drop

Returns:

the set of new objects created from the drop

doDrop

public Object doDrop(Object src,
                     Object target,
                     boolean sameSystemType,
                     boolean sameSystem,
                     int sourceType,
                     IProgressMonitor monitor)

Perform a copy via drag and drop.

Specified by:

doDrop in interface ISystemDragDropAdapter

Overrides:

doDrop in class AbstractSystemViewAdapter

Parameters:

src - the object to be copied. If the target and source are not on the same system, then this is a temporary object produced by the doDrag.

target - the object to be copied to.

sameSystem - an indication whether the target and source reside on the same type of system

monitor - the progress monitor

Returns:

an indication whether the operation was successful or not.

See Also:

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

checkForCollision

protected String checkForCollision(Shell shell,
                                   IRemoteFile targetFolder,
                                   String oldName)

canDelete

public boolean canDelete(Object element)

Yes, remote file objects are deletable!

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)
                 throws Exception

Deprecated. use the one with monitor now

Perform the delete action. Defers request to the remote file subsystem

Specified by:

doDelete in interface ISystemViewElementAdapter

Overrides:

doDelete in class AbstractSystemViewAdapter

Throws:

Exception

See Also:

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

doDelete

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

Perform the delete action. Defers request to the remote file subsystem

Specified by:

doDelete in interface ISystemViewElementAdapter

Overrides:

doDelete in class AbstractSystemViewAdapter

Throws:

Exception

See Also:

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

doDeleteBatch

public boolean doDeleteBatch(Shell shell,
                             List resourceSet,
                             IProgressMonitor monitor)
                      throws Exception

Perform the delete action. Defers request to the remote file subsystem

Specified by:

doDeleteBatch in interface ISystemViewElementAdapter

Overrides:

doDeleteBatch in class AbstractSystemViewAdapter

Throws:

Exception

canRename

public boolean canRename(Object element)

Yes, remote file objects are renamable!

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 newName)
                 throws Exception

Perform the rename action. Defers request to the remote file subsystem

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. Defers request to the subsystem factory, calling either getFileNameValidator or getFolderNameValidator.

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 newName, but uppercased for Windows file systems

Specified by:

getCanonicalNewName in interface ISystemViewElementAdapter

Overrides:

getCanonicalNewName in class AbstractSystemViewAdapter

See Also:

AbstractSystemViewAdapter.canRename(Object)

namesAreEqual

public boolean namesAreEqual(Object element,
                             String newName)

Parent override.

Compare the name of the given element to the given new name to decide if they are equal. Allows adapters to consider case and quotes as appropriate.

For Unix/Linux, returns the result of getName(element).equals(newName), which is to say, it is a case sensitive compare. For windows, it is case insensitive (equalsIgnoreCase).

Specified by:

namesAreEqual in interface ISystemViewElementAdapter

Overrides:

namesAreEqual in class AbstractSystemViewAdapter

See Also:

AbstractSystemViewAdapter.canRename(Object)

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

getAbsoluteName

public String getAbsoluteName(Object element)

Return fully qualified name that uniquely identifies this object within its subsystem

Specified by:

getAbsoluteName in interface IRemoteObjectIdentifier

Specified by:

getAbsoluteName in class AbstractSystemViewAdapter

See Also:

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

getAbsoluteParentName

public String getAbsoluteParentName(Object element)

Return fully qualified name that uniquely identifies this remote object's remote parent within its subsystem

Specified by:

getAbsoluteParentName in interface ISystemRemoteElementAdapter

getSubSystem

public ISubSystem getSubSystem(Object element)

Return subsystem

Specified by:

getSubSystem in interface ISystemViewElementAdapter

Overrides:

getSubSystem in class AbstractSystemViewAdapter

getSubSystemConfigurationId

public String getSubSystemConfigurationId(Object element)

Return the subsystem factory id that owns this remote object The value must not be translated, so that property pages registered via xml can subset by it.

Specified by:

getSubSystemConfigurationId in interface ISystemRemoteElementAdapter

getRemoteTypeCategory

public String getRemoteTypeCategory(Object element)

Return a value for the type category property for this object The value must not be translated, so that property pages registered via xml can subset by it.

Specified by:

getRemoteTypeCategory in interface ISystemRemoteElementAdapter

getRemoteType

public String getRemoteType(Object element)

Return the untranslated type for this object. For files, returns the "file" For folders or roots, returns "folder"

Specified by:

getRemoteType in interface ISystemRemoteElementAdapter

getRemoteSubType

public String getRemoteSubType(Object element)

Return the untranslated subtype for this object. For files, returns the file extension. Eg, for abc.java this returns "java". For folders, returns "root" or "subfolder"

Specified by:

getRemoteSubType in interface ISystemRemoteElementAdapter

getRemoteSubSubType

public String getRemoteSubSubType(Object element)

Return the untranslated sub-subtype for this object. Returns null for now.

Specified by:

getRemoteSubSubType in interface ISystemRemoteElementAdapter

Overrides:

getRemoteSubSubType in class AbstractSystemViewAdapter

getRemoteSourceType

public String getRemoteSourceType(Object element)

Return the source type of the selected object. Typically, this only makes sense for compilable source members. For non-compilable remote objects, this typically just returns null.

For files, this returns the extension. For folders, it returns null.

Specified by:

getRemoteSourceType in interface ISystemRemoteElementAdapter

Overrides:

getRemoteSourceType in class AbstractSystemViewAdapter

refreshRemoteObject

public boolean refreshRemoteObject(Object oldElement,
                                   Object newElement)

Some view has updated the name or properties of this remote object. As a result, the remote object's contents need to be refreshed. You are given the old remote object that has old data, and you are given the new remote object that has the new data. For example, on a rename the old object still has the old name attribute while the new object has the new new attribute.

This is called by viewers like SystemView in response to rename and property change events.

Specified by:

refreshRemoteObject in interface ISystemRemoteElementAdapter

Parameters:

oldElement - the element that was found in the tree

newElement - the updated element that was passed in the REFRESH_REMOTE event

Returns:

true if you want the viewer that called this to refresh the children of this object, such as is needed on a rename of a folder, say.

getRemoteParent

public Object getRemoteParent(Shell shell,
                              Object element)
                       throws Exception

Given a remote object, returns it remote parent object. Eg, given a file, return the folder it is contained in.

The shell is required in order to set the cursor to a busy state if a remote trip is required.

Specified by:

getRemoteParent in interface ISystemRemoteElementAdapter

Returns:

an IRemoteFile object for the parent

Throws:

Exception

getRemoteParentNamesInUse

public String[] getRemoteParentNamesInUse(Shell shell,
                                          Object element)
                                   throws Exception

Given a remote object, return the unqualified names of the objects contained in that parent. This is used for testing for uniqueness on a rename operation, for example. Sometimes, it is not enough to just enumerate all the objects in the parent for this purpose, because duplicate names are allowed if the types are different, such as on iSeries. In this case return only the names which should be used to do name-uniqueness validation on a rename operation.

Specified by:

getRemoteParentNamesInUse in interface ISystemRemoteElementAdapter

Returns:

an array of all file and folder names in the parent of the given IRemoteFile object

Throws:

Exception

handleDoubleClick

public boolean handleDoubleClick(Object element)

User has double clicked on an object. We want to open the object in the applicable editor. Return true to indicate that we are handling the double-click event.

Specified by:

handleDoubleClick in interface ISystemViewElementAdapter

Overrides:

handleDoubleClick in class AbstractSystemViewAdapter

canEdit

public boolean canEdit(Object element)

Description copied from interface: ISystemRemoteElementAdapter

Indicates whether the specified object can be edited or not.

Specified by:

canEdit in interface ISystemRemoteElementAdapter

Overrides:

canEdit in class AbstractSystemViewAdapter

Parameters:

element - the object to edit

Returns:

true if the object can be edited. Returns false by default.

getEditableRemoteObject

public ISystemEditableRemoteObject getEditableRemoteObject(Object element)

Description copied from interface: ISystemRemoteElementAdapter

Return the remote edit wrapper for this object.

Specified by:

getEditableRemoteObject in interface ISystemRemoteElementAdapter

Overrides:

getEditableRemoteObject in class AbstractSystemViewAdapter

Parameters:

element - the object to edit

Returns:

the editor wrapper for this object

getCachedCopy

public IFile getCachedCopy(IRemoteFile remoteFile)
                    throws SystemMessageException

Throws:

SystemMessageException

getFilterStringFor

public String getFilterStringFor(Object object)

Return a filter string that corresponds to this object.

Specified by:

getFilterStringFor in interface ISystemRemoteElementAdapter

Overrides:

getFilterStringFor in class AbstractSystemViewAdapter

Parameters:

object - the object to obtain a filter string for

Returns:

the corresponding filter string if applicable

testAttribute

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

From IActionFilter, it exposes properties for decorator and popupMenus extension points.

1. name="name". The given value must match the name exactly or if ends with an asterisk the beginning must match. (case sensitiveness depends on the subsystem)
2. name="absolutePath". The given value must match the absolute path exactly or if ends with an asterisk the beginning must match. (case sensitiveness depends on the subsystem)
3. name="extension". The given value must match the extension exactly or if ends with an asterisk the beginning must match. (case sensitiveness depends on the subsystem)
4. name="isRoot". If the given value is true, then returns true if the target is a root file. If the given value is false, then returns true if the target is not root.
5. name="isFile". If the given value is true, then returns true if the target is a file. If the given value is false, then returns true if the target is not a file.
6. name="isDirectory". If the given value is true, then returns true if the target is a directory. If the given value is false, then returns true if the target is not a directory.
7. name="isHidden". If the given value is true, then returns true if the target is a hidden file. If the given value is false, then returns true if the target is not a hidden file.
8. name="canRead". If the given value is true, then returns true if the target is readable. If the given value is false, then returns true if the target is not readable.
9. name="canWrite". If the given value is true, then returns true if the target is writable. If the given value is false, then returns true if the target is not writable.
10. name="isBinary". If the given value is true, then returns true if the target is a binary file. If the given value is false, then returns true if the target is not a binary file.
11. name="isText". If the given value is true, then returns true if the target is a text file. If the given value is false, then returns true if the target is not a text file.
12. name="isArchive". If the given value is true, then returns true if the target is an archive file. If the given value is false, then returns true if the target is not an archive file.
13. name="isVirtual". If the given value is true, then returns true if the target is a virtual file. If the given value is false, then returns true if the target is not a virtual file.

Specified by:

testAttribute in interface IActionFilter

Overrides:

testAttribute in class AbstractSystemViewAdapter

See Also:

IActionFilter.testAttribute(java.lang.Object, java.lang.String, java.lang.String)

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

getSystemFetchOperation

protected SystemFetchOperation getSystemFetchOperation(Object o,
                                                       IElementCollector collector)

Description copied from class: AbstractSystemViewAdapter

Returns the SystemFetchOperation to be used in performing a query. Adapters should override this to provide customizations where appropriate.

Overrides:

getSystemFetchOperation in class AbstractSystemViewAdapter

Parameters:

o -

collector -

Returns:

the fetch operation. By default it returns the base implementation

supportsUserDefinedActions

public boolean supportsUserDefinedActions(Object object)

Returns false if the file is a virtual file, otherwise defaults to asking the subsystem factory.

Specified by:

supportsUserDefinedActions in interface ISystemRemoteElementAdapter

Parameters:

object - the object.

Returns:

true if the object supports user defined actions, false otherwise.

See Also:

ISystemRemoteElementAdapter.supportsUserDefinedActions(java.lang.Object)