Remote Systems
v6.4.1

com.ibm.etools.systems.filters.impl
Class SystemFilterSimpleImpl

java.lang.Object
  extended byEObjectImpl
      extended bycom.ibm.etools.systems.references.impl.SystemReferencedObjectImpl
          extended bycom.ibm.etools.systems.filters.impl.SystemFilterImpl
              extended bycom.ibm.etools.systems.filters.impl.SystemFilterSimpleImpl
All Implemented Interfaces:
IAdaptable, ISystemContainer, ISystemReferencedObject, SystemFilter, SystemFilterContainer, SystemReferencedObject

public class SystemFilterSimpleImpl
extends SystemFilterImpl
implements ISystemContainer

A lightweight override of the full-fledged persistable implementation of SystemFilter. This class replaces the heavy-weight MOF implementations with simple non-MOF implementations.

This flavour of SystemFilter implementation is for those cases where a simple in-memory SystemFilter is needed temporarily, perhaps to populate a GUI widget say, and the filter does not need to be savable/restorable. As a result there is no mof, and no need for a parent SystemFilterPool or SystemFilterPoolManager. The class is small, simple and directly instantiable.

This simple implementation does not support:

See Also:
Serialized Form

Field Summary
protected  HashMap cachedContents
           
static String copyright
           
protected  boolean isStale
           
 
Fields inherited from class com.ibm.etools.systems.filters.impl.SystemFilterImpl
debug, default_, DEFAULT_EDEFAULT, filterStringArray, filterStringObjectArray, filterStringVector, NAME_EDEFAULT, nestedFilters, NON_CHANGABLE_EDEFAULT, NON_DELETABLE_EDEFAULT, NON_RENAMABLE_EDEFAULT, nonChangable, nonDeletable, nonRenamable, PROMPTABLE_EDEFAULT, RELATIVE_ORDER_EDEFAULT, relativeOrder, release, RELEASE_EDEFAULT, SINGLE_FILTER_STRING_ONLY_EDEFAULT, singleFilterStringOnly, singleFilterStringOnlyESet, strings, STRINGS_CASE_SENSITIVE_EDEFAULT, STRINGS_NON_CHANGABLE_EDEFAULT, stringsCaseSensitive, stringsCaseSensitiveESet, stringsNonChangable, SUPPORTS_DUPLICATE_FILTER_STRINGS_EDEFAULT, SUPPORTS_NESTED_FILTERS_EDEFAULT, supportsDuplicateFilterStrings, supportsNestedFilters, TYPE_EDEFAULT
 
Fields inherited from class com.ibm.etools.systems.references.impl.SystemReferencedObjectImpl
helper
 
Constructor Summary
SystemFilterSimpleImpl(String name)
          Constructor for SystemFilterSimpleImpl
 
Method Summary
 SystemFilterString addFilterString(String newString)
          Append a new filter string to this filter's list.
 SystemFilterString addFilterString(String newString, int position)
          Insert a new filter string to this filter's list, at the given zero-based position.
 boolean areStringsCaseSensitive()
          Are filter strings in this filter case sensitive?
 void clone(SystemFilter targetFilter)
          Clones a given filter to the given target filter.
 Object[] getChildren()
          Return the children of this filter.
 Object[] getContents(ISystemContentsType contentsType)
          Returns all the contents of the object (combining results of all filters
 String getFilterString()
          Get the single filter string.
 int getFilterStringCount()
          Return how many filter strings are defined in this filter.
 String[] getFilterStrings()
          Return filter strings as an array of String objects.
 Vector getFilterStringsVector()
          Return filter strings as a Vector of String objects
 String getName()
          Get the filter's name
 EList getNestedFilters()
          Overridden to return null
 Object getParent()
          Get the parent as set in setParent(Object)
 SystemFilter getParentFilter()
          Overridden to return null
 SystemFilterPoolManagerProvider getProvider()
          Overridden to return null
 int getRelativeOrder()
          Overridden to return -1
 IFile getSaveFile()
          Overridden to return null
 String getSaveFileName()
          Overridden to return null
 EList getStrings()
          Overridden to return null
 SystemFilter getSystemFilter(String aliasName)
          Overridden to return null
 int getSystemFilterCount()
          Overridden to return 0
 Vector getSystemFilterNames()
          Overridden to return null
 SystemFilterPoolManager getSystemFilterPoolManager()
          Overridden to return null
 SystemFilter[] getSystemFilters()
          Overridden to return null
 SystemFilterString[] getSystemFilterStrings()
          Get this filter's filter string objects as an array.
 Vector getSystemFiltersVector()
          Overridden to return null
 String getType()
          Get the filter's type
 boolean hasChildren()
          Returns true if this filter has any filter strings
 boolean hasContents(ISystemContentsType contentsType)
          Returns whether the object has contents of a particular type.
protected  void invalidateCache()
          Clear internal cache so it will be rebuilt on next request.
 boolean isDefault()
          Overridden to return false
 boolean isNested()
          Return true if this filter is a nested filter or not.
 boolean isPromptable()
          Is this a special filter that prompts the user when it is expanded?
 boolean isStale()
          Indicates whether the cached object is stale
 boolean isStringsCaseSensitive()
          Are filter strings in this filter case sensitive?
 boolean isTransient()
          Return true if this a transient or simple filter that is only created temporary "on the fly" and not intended to be saved or part of the filter framework.
 void markStale(boolean isStale)
          Marks the object as stale or not
 void moveSystemFilterString(int pos, SystemFilterString filterString)
          Move a given filter string to a given zero-based location.
 SystemFilterString removeFilterString(int position)
          Remove a filter string from this filter's list, given its zero-based position
 SystemFilterString removeFilterString(String oldString)
          Delete a filter string from this filter's list.
 boolean removeFilterString(SystemFilterString filterString)
          Remove a filter string from this filter's list, given its SystemFilterString object.
 void save()
          Overridden to do nothing
 void setContents(ISystemContentsType type, Object[] cachedContents)
          Cache contents of a certain type.
 void setDefault(boolean value)
          Overridden to do nothing
 void setFilterString(String filterString)
          Set the single filter string
 void setFilterStrings(String[] newStrings)
          Set all the filter strings for this filter.
 void setFilterStrings(Vector newStrings)
          Set all the filter strings for this filter.
 void setName(String name)
          Set the filter's name
 void setParent(Object parent)
          Set the parent.
 void setParentFilter(SystemFilter l)
          Overridden to do nothing
 void setPromptable(boolean promptable)
          Is this a special filter that prompts the user when it is expanded?
 void setRelativeOrder(int value)
          Overridden to do nothing
 void setStringsCaseSensitive(boolean value)
          Specify if filter strings in this filter are case sensitive.
 void setSupportsNestedFilters(boolean value)
          Overridden to do nothing
 void setType(String type)
          Set the filter's type
 boolean supportsNestedFilters()
          Does this support nested filters?
 void updateFilterString(SystemFilterString filterString, String newValue)
          Update a new filter string's string value.
 
Methods inherited from class com.ibm.etools.systems.filters.impl.SystemFilterImpl
addPathTerminator, addSystemFilter, cloneSystemFilter, copySystemFilterString, createSystemFilter, deleteSystemFilter, eBasicRemoveFromContainer, eGet, eInverseAdd, eInverseRemove, eIsSet, eSet, eStaticClass, eUnset, getAdapter, getFilterStringObjectsVector, getFolder, getMOFHelpers, getMOFHelpers, getNamingPolicy, getParentFilterContainer, getParentFilterPool, getRelease, getRootSaveFileName, getRootSaveFileName, getSaveFileName, getSaveFilePathAndName, getSystemFilterPool, getSystemFilterPosition, getSystemFilterString, getTypeGen, initializeFilterStrings, initMOF, internalGetFilters, isNonChangable, isNonDeletable, isNonRenamable, isSetSingleFilterStringOnly, isSetStringsCaseSensitive, isSingleFilterStringOnly, isSingleFilterStringOnlyGen, isStringsNonChangable, isSupportsDuplicateFilterStrings, isSupportsNestedFilters, moveSystemFilter, renameSystemFilter, restore, setNonChangable, setNonDeletable, setNonRenamable, setParentFilterPool, setRelease, setSingleFilterStringOnly, setStringsNonChangable, setSupportsDuplicateFilterStrings, supportsDuplicateFilterStrings, toString, unsetSingleFilterStringOnly, unsetStringsCaseSensitive, updateSystemFilter
 
Methods inherited from class com.ibm.etools.systems.references.impl.SystemReferencedObjectImpl
addReference, getReferenceCount, getReferencingObjects, removeAllReferences, removeReference
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.ibm.etools.systems.references.ISystemReferencedObject
addReference, getReferenceCount, getReferencingObjects, removeAllReferences, removeReference
 

Field Detail

copyright

public static final String copyright
See Also:
Constant Field Values

isStale

protected boolean isStale

cachedContents

protected HashMap cachedContents
Constructor Detail

SystemFilterSimpleImpl

public SystemFilterSimpleImpl(String name)
Constructor for SystemFilterSimpleImpl

Method Detail

invalidateCache

protected void invalidateCache()
Description copied from class: SystemFilterImpl
Clear internal cache so it will be rebuilt on next request.

Overrides:
invalidateCache in class SystemFilterImpl

isTransient

public boolean isTransient()
Return true if this a transient or simple filter that is only created temporary "on the fly" and not intended to be saved or part of the filter framework. Eg it has no manager or provider.

We always return true

Specified by:
isTransient in interface SystemFilter
Overrides:
isTransient in class SystemFilterImpl
See Also:
SystemFilterSimpleImpl

clone

public void clone(SystemFilter targetFilter)
Clones a given filter to the given target filter. All filter strings, and all nested filters, are copied.

Specified by:
clone in interface SystemFilter
Overrides:
clone in class SystemFilterImpl
Parameters:
targetFilter - new filter into which we copy all our data

setFilterString

public void setFilterString(String filterString)
Set the single filter string


getFilterString

public String getFilterString()
Get the single filter string. Returns null if setFilterString has not been called.


setParent

public void setParent(Object parent)
Set the parent. Since we don't have any filter manager, we need some way to store context info for the adapter. Use this.


getParent

public Object getParent()
Get the parent as set in setParent(Object)


setName

public void setName(String name)
Set the filter's name

Specified by:
setName in interface SystemFilter
Overrides:
setName in class SystemFilterImpl

getName

public String getName()
Get the filter's name

Specified by:
getName in interface SystemFilter
Overrides:
getName in class SystemFilterImpl

setType

public void setType(String type)
Set the filter's type

Specified by:
setType in interface SystemFilter
Overrides:
setType in class SystemFilterImpl

getType

public String getType()
Get the filter's type

Specified by:
getType in interface SystemFilter
Overrides:
getType in class SystemFilterImpl

setStringsCaseSensitive

public void setStringsCaseSensitive(boolean value)
Specify if filter strings in this filter are case sensitive. Default is false.

Specified by:
setStringsCaseSensitive in interface SystemFilter
Overrides:
setStringsCaseSensitive in class SystemFilterImpl
Parameters:
value - The new value of the StringsCaseSensitive attribute

isStringsCaseSensitive

public boolean isStringsCaseSensitive()
Are filter strings in this filter case sensitive?

Specified by:
isStringsCaseSensitive in interface SystemFilter
Overrides:
isStringsCaseSensitive in class SystemFilterImpl
Returns:
The value of the StringsCaseSensitive attribute

areStringsCaseSensitive

public boolean areStringsCaseSensitive()
Are filter strings in this filter case sensitive?

Specified by:
areStringsCaseSensitive in interface SystemFilterContainer
Overrides:
areStringsCaseSensitive in class SystemFilterImpl
Returns:
The value of the StringsCaseSensitive attribute

setPromptable

public void setPromptable(boolean promptable)
Is this a special filter that prompts the user when it is expanded?

Specified by:
setPromptable in interface SystemFilter
Overrides:
setPromptable in class SystemFilterImpl

isPromptable

public boolean isPromptable()
Is this a special filter that prompts the user when it is expanded?

Specified by:
isPromptable in interface SystemFilter
Overrides:
isPromptable in class SystemFilterImpl

getFilterStrings

public String[] getFilterStrings()
Return filter strings as an array of String objects.

Specified by:
getFilterStrings in interface SystemFilter
Overrides:
getFilterStrings in class SystemFilterImpl

getFilterStringsVector

public Vector getFilterStringsVector()
Return filter strings as a Vector of String objects

Specified by:
getFilterStringsVector in interface SystemFilter
Overrides:
getFilterStringsVector in class SystemFilterImpl

getFilterStringCount

public int getFilterStringCount()
Return how many filter strings are defined in this filter.

Specified by:
getFilterStringCount in interface SystemFilter
Overrides:
getFilterStringCount in class SystemFilterImpl

setFilterStrings

public void setFilterStrings(Vector newStrings)
Set all the filter strings for this filter.

Specified by:
setFilterStrings in interface SystemFilter
Overrides:
setFilterStrings in class SystemFilterImpl
Parameters:
newStrings - Vector of String objects

setFilterStrings

public void setFilterStrings(String[] newStrings)
Set all the filter strings for this filter.

Specified by:
setFilterStrings in interface SystemFilter
Overrides:
setFilterStrings in class SystemFilterImpl
Parameters:
newStrings - array of String objects

addFilterString

public SystemFilterString addFilterString(String newString)
Append a new filter string to this filter's list. Returns null.

Specified by:
addFilterString in interface SystemFilter
Overrides:
addFilterString in class SystemFilterImpl

addFilterString

public SystemFilterString addFilterString(String newString,
                                          int position)
Insert a new filter string to this filter's list, at the given zero-based position. Returns null.

Specified by:
addFilterString in interface SystemFilter
Overrides:
addFilterString in class SystemFilterImpl

removeFilterString

public SystemFilterString removeFilterString(String oldString)
Delete a filter string from this filter's list. Returns null.

Specified by:
removeFilterString in interface SystemFilter
Overrides:
removeFilterString in class SystemFilterImpl
Returns:
the SystemFilterString object deleted, or null if not found

removeFilterString

public SystemFilterString removeFilterString(int position)
Remove a filter string from this filter's list, given its zero-based position

Specified by:
removeFilterString in interface SystemFilter
Overrides:
removeFilterString in class SystemFilterImpl
Returns:
the SystemFilterString object deleted, or null if not found

getChildren

public Object[] getChildren()
Return the children of this filter. This is the same as getFilterStrings()

Overrides:
getChildren in class SystemFilterImpl

hasChildren

public boolean hasChildren()
Returns true if this filter has any filter strings

Overrides:
hasChildren in class SystemFilterImpl

getSystemFilterStrings

public SystemFilterString[] getSystemFilterStrings()
Get this filter's filter string objects as an array. We return null, as we don't support SystemFilterString objects, just String objects.

Specified by:
getSystemFilterStrings in interface SystemFilter
Overrides:
getSystemFilterStrings in class SystemFilterImpl

setSupportsNestedFilters

public void setSupportsNestedFilters(boolean value)
Overridden to do nothing

Specified by:
setSupportsNestedFilters in interface SystemFilter
Overrides:
setSupportsNestedFilters in class SystemFilterImpl

supportsNestedFilters

public boolean supportsNestedFilters()
Does this support nested filters? No. Not for simple filtes.

Overrides:
supportsNestedFilters in class SystemFilterImpl

isNested

public boolean isNested()
Return true if this filter is a nested filter or not. Overridden to return false;

Specified by:
isNested in interface SystemFilter
Overrides:
isNested in class SystemFilterImpl

updateFilterString

public void updateFilterString(SystemFilterString filterString,
                               String newValue)
Update a new filter string's string value. Overridden to do nothing.

Specified by:
updateFilterString in interface SystemFilter
Overrides:
updateFilterString in class SystemFilterImpl

removeFilterString

public boolean removeFilterString(SystemFilterString filterString)
Remove a filter string from this filter's list, given its SystemFilterString object. Overridden to do nothing

Specified by:
removeFilterString in interface SystemFilter
Overrides:
removeFilterString in class SystemFilterImpl
Returns:
true if the given string existed and hence was deleted.

moveSystemFilterString

public void moveSystemFilterString(int pos,
                                   SystemFilterString filterString)
Move a given filter string to a given zero-based location. Overridden to do nothing

Specified by:
moveSystemFilterString in interface SystemFilter
Overrides:
moveSystemFilterString in class SystemFilterImpl

setRelativeOrder

public void setRelativeOrder(int value)
Overridden to do nothing

Specified by:
setRelativeOrder in interface SystemFilter
Overrides:
setRelativeOrder in class SystemFilterImpl

getRelativeOrder

public int getRelativeOrder()
Overridden to return -1

Specified by:
getRelativeOrder in interface SystemFilter
Overrides:
getRelativeOrder in class SystemFilterImpl

setDefault

public void setDefault(boolean value)
Overridden to do nothing

Specified by:
setDefault in interface SystemFilter
Overrides:
setDefault in class SystemFilterImpl

isDefault

public boolean isDefault()
Overridden to return false

Specified by:
isDefault in interface SystemFilter
Overrides:
isDefault in class SystemFilterImpl

setParentFilter

public void setParentFilter(SystemFilter l)
Overridden to do nothing

Specified by:
setParentFilter in interface SystemFilter
Overrides:
setParentFilter in class SystemFilterImpl

getParentFilter

public SystemFilter getParentFilter()
Overridden to return null

Specified by:
getParentFilter in interface SystemFilter
Overrides:
getParentFilter in class SystemFilterImpl

getSystemFilterNames

public Vector getSystemFilterNames()
Overridden to return null

Specified by:
getSystemFilterNames in interface SystemFilterContainer
Overrides:
getSystemFilterNames in class SystemFilterImpl

getNestedFilters

public EList getNestedFilters()
Overridden to return null

Specified by:
getNestedFilters in interface SystemFilter
Overrides:
getNestedFilters in class SystemFilterImpl

getSystemFiltersVector

public Vector getSystemFiltersVector()
Overridden to return null

Specified by:
getSystemFiltersVector in interface SystemFilterContainer
Overrides:
getSystemFiltersVector in class SystemFilterImpl

getSystemFilters

public SystemFilter[] getSystemFilters()
Overridden to return null

Specified by:
getSystemFilters in interface SystemFilterContainer
Overrides:
getSystemFilters in class SystemFilterImpl

getSystemFilterCount

public int getSystemFilterCount()
Overridden to return 0

Specified by:
getSystemFilterCount in interface SystemFilterContainer
Overrides:
getSystemFilterCount in class SystemFilterImpl

getStrings

public EList getStrings()
Overridden to return null

Specified by:
getStrings in interface SystemFilter
Overrides:
getStrings in class SystemFilterImpl

getSystemFilter

public SystemFilter getSystemFilter(String aliasName)
Overridden to return null

Specified by:
getSystemFilter in interface SystemFilterContainer
Overrides:
getSystemFilter in class SystemFilterImpl
Parameters:
aliasName - unique aliasName (case insensitive) to search on.
Returns:
SystemFilter object with unique aliasName, or null if no filter object with this name exists.

getProvider

public SystemFilterPoolManagerProvider getProvider()
Overridden to return null

Specified by:
getProvider in interface SystemFilter
Overrides:
getProvider in class SystemFilterImpl

getSystemFilterPoolManager

public SystemFilterPoolManager getSystemFilterPoolManager()
Overridden to return null

Specified by:
getSystemFilterPoolManager in interface SystemFilterContainer
Overrides:
getSystemFilterPoolManager in class SystemFilterImpl

getSaveFile

public IFile getSaveFile()
Overridden to return null

Specified by:
getSaveFile in interface SystemFilter
Overrides:
getSaveFile in class SystemFilterImpl

getSaveFileName

public String getSaveFileName()
Overridden to return null

Specified by:
getSaveFileName in interface SystemFilter
Overrides:
getSaveFileName in class SystemFilterImpl

save

public void save()
          throws Exception
Overridden to do nothing

Specified by:
save in interface SystemFilter
Overrides:
save in class SystemFilterImpl
Throws:
Exception

setContents

public void setContents(ISystemContentsType type,
                        Object[] cachedContents)
Cache contents of a certain type.

Parameters:
type - the contents type.
cachedContents - the contents to cache.

getContents

public Object[] getContents(ISystemContentsType contentsType)
Description copied from interface: ISystemContainer
Returns all the contents of the object (combining results of all filters

Specified by:
getContents in interface ISystemContainer
Parameters:
contentsType - type of contents
Returns:
an array of contents.
See Also:
ISystemContainer.getContents(com.ibm.etools.systems.model.ISystemContentsType)

hasContents

public boolean hasContents(ISystemContentsType contentsType)
Description copied from interface: ISystemContainer
Returns whether the object has contents of a particular type.

Specified by:
hasContents in interface ISystemContainer
Parameters:
contentsType - type of contents
Returns:
true if the object has contents, false otherwise.
See Also:
ISystemContainer.hasContents(com.ibm.etools.systems.model.ISystemContentsType)

isStale

public boolean isStale()
Description copied from interface: ISystemContainer
Indicates whether the cached object is stale

Specified by:
isStale in interface ISystemContainer
Returns:
whether the container is stale
See Also:
ISystemContainer.isStale()

markStale

public void markStale(boolean isStale)
Description copied from interface: ISystemContainer
Marks the object as stale or not

Specified by:
markStale in interface ISystemContainer
Parameters:
isStale - whether the object is to be marked stale or not
See Also:
ISystemContainer.markStale(boolean)

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.