Remote Systems
v6.4.1

com.ibm.etools.systems.core.ui.view
Class SystemViewFilterPoolAdapter

java.lang.Object
  extended bycom.ibm.etools.systems.core.ui.view.AbstractSystemViewAdapter
      extended bycom.ibm.etools.systems.core.ui.view.SystemViewFilterPoolAdapter
All Implemented Interfaces:
IRemoteObjectIdentifier, ISystemDragDropAdapter, ISystemPropertyConstants, ISystemViewActionFilter, ISystemViewElementAdapter

public class SystemViewFilterPoolAdapter
extends AbstractSystemViewAdapter
implements ISystemViewElementAdapter

Adapter for displaying SystemFilterPool objects in tree views. These are the masters, and only shown in work-with for the master. These are children of SubSystemFactory objects


Field Summary
static String copyright
           
protected  String translatedType
           
 
Fields inherited from class com.ibm.etools.systems.core.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 com.ibm.etools.systems.core.ui.view.ISystemViewElementAdapter
noActions
 
Fields inherited from interface com.ibm.etools.systems.subsystems.IRemoteObjectIdentifier
Copyright
 
Fields inherited from interface com.ibm.etools.systems.core.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
 
Constructor Summary
SystemViewFilterPoolAdapter()
           
 
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 subsystem object.
 boolean canDelete(Object element)
          Return true if this object is deletable by the user.
 boolean canRename(Object element)
          Return true if this object is renamable by the user.
 boolean doDelete(Shell shell, Object element)
          Perform the delete action.
 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(Object element)
          Return the children of this object.
 ImageDescriptor getImageDescriptor(Object element)
          Returns an image descriptor for the image.
 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.
 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  IPropertyDescriptor[] internalGetPropertyDescriptors()
          Return our unique property descriptors
protected  Object internalGetPropertyValue(Object key)
          Return our unique property values
 
Methods inherited from class com.ibm.etools.systems.core.ui.view.AbstractSystemViewAdapter
addCommonRemoteActions, addDynamicPopupMenuActions, canDrag, canDrop, canEdit, checkForNull, createSimplePropertyDescriptor, createSimplePropertyDescriptor, doDrag, doDrop, doDrop, fetchDeferredChildren, getAdapter, getCancelledMessageObject, getChildren, getChildrenUsingExpandToFilter, getCurrentTreeView, getDefaultDescriptors, getEditableRemoteObject, getEditableValue, getEmptyMessageObject, getFailedMessageObject, getFilterString, getFilterStringFor, getFirstSelection, getInput, getInputMementoHandle, getLabel, getMementoHandle, getMementoHandleKey, getPropertyDescriptors, getPropertyValue, getPropertyValue, getRemoteAdapter, getRemoteSourceType, getRemoteSubSubType, getRule, getShell, getStatusLineText, getSubSystem, getSystemFetchOperation, getSystemTree, getTranslatedFalse, getTranslatedNo, getTranslatedNotApplicable, getTranslatedNotAvailable, getTranslatedTrue, getTranslatedYes, getUniquePropertyDescriptors, getViewer, handleDoubleClick, initMsgObjects, isContainer, isPromptable, isPropertySet, namesAreEqual, resetPropertyValue, saveExpansionState, selectionChanged, setFilterString, setInput, setPropertySourceInput, setPropertyValue, setShell, setViewer, showDelete, showGenericShowInTableAction, showOpenViewActions, showRefresh, showRename, sub, supportsDeferredQueries, testAttribute, validateDrop
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.etools.systems.core.ui.view.ISystemViewElementAdapter
getChildren, getChildrenUsingExpandToFilter, getFilterString, getInput, getInputMementoHandle, getMementoHandle, getMementoHandleKey, getPropertyValue, getShell, getStatusLineText, getSubSystem, getUniquePropertyDescriptors, getViewer, handleDoubleClick, isPromptable, namesAreEqual, saveExpansionState, selectionChanged, setFilterString, setInput, setPropertySourceInput, setShell, setViewer, showDelete, showGenericShowInTableAction, showOpenViewActions, showRefresh, showRename, supportsDeferredQueries
 
Methods inherited from interface com.ibm.etools.systems.core.ui.view.ISystemDragDropAdapter
canDrag, canDrop, doDrag, doDrop, doDrop, validateDrop
 

Field Detail

copyright

public static final String copyright
See Also:
Constant Field Values

translatedType

protected String translatedType
Constructor Detail

SystemViewFilterPoolAdapter

public SystemViewFilterPoolAdapter()
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 subsystem object. Calls the method getActions on the subsystem's factory, and places all action objects returned from the call, into the menu.

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 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. The parent of a filter pool is a subsystem factory, in real life. But to a user, it is a subsystem.

Specified by:
getParent in interface ISystemViewElementAdapter
Specified by:
getParent in class AbstractSystemViewAdapter

getChildren

public Object[] getChildren(Object element)
Return the children of this object. For filter pools, this is a list of filters.

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. That is, has filters.

Specified by:
hasChildren in interface ISystemViewElementAdapter
Specified by:
hasChildren 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:
AbstractSystemViewAdapter.createSimplePropertyDescriptor(String,ResourceBundle,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)
                 throws Exception
Perform the delete action.

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, upperCased

Specified by:
getCanonicalNewName in interface ISystemViewElementAdapter
Overrides:
getCanonicalNewName in class AbstractSystemViewAdapter
See Also:
AbstractSystemViewAdapter.canRename(Object)

Remote Systems
v6.4.1

Copyright © 2005 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.