Remote Systems
v6.4.1

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

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

public class SystemFilterImpl
extends SystemReferencedObjectImpl
implements SystemFilter, SystemReferencedObject, SystemFilterContainer, IAdaptable

See Also:
Serialized Form

Field Summary
static String copyright
           
protected static boolean debug
           
protected  boolean default_
           
protected static boolean DEFAULT_EDEFAULT
          The default value of the 'Default' attribute
protected  String[] filterStringArray
           
protected  SystemFilterString[] filterStringObjectArray
           
protected  Vector filterStringVector
           
protected  String name
           
protected static String NAME_EDEFAULT
          The default value of the 'Name' attribute
protected  EList nestedFilters
           
protected static boolean NON_CHANGABLE_EDEFAULT
          The default value of the 'Non Changable' attribute
protected static boolean NON_DELETABLE_EDEFAULT
          The default value of the 'Non Deletable' attribute
protected static boolean NON_RENAMABLE_EDEFAULT
          The default value of the 'Non Renamable' attribute
protected  boolean nonChangable
           
protected  boolean nonDeletable
           
protected  boolean nonRenamable
           
protected  boolean promptable
           
protected static boolean PROMPTABLE_EDEFAULT
          The default value of the 'Promptable' attribute
protected static int RELATIVE_ORDER_EDEFAULT
          The default value of the 'Relative Order' attribute
protected  int relativeOrder
           
protected  int release
           
protected static int RELEASE_EDEFAULT
          The default value of the 'Release' attribute
protected static boolean SINGLE_FILTER_STRING_ONLY_EDEFAULT
          The default value of the 'Single Filter String Only' attribute
protected  boolean singleFilterStringOnly
          The cached value of the 'Single Filter String Only' attribute
protected  boolean singleFilterStringOnlyESet
          This is true if the Single Filter String Only attribute has been set
protected  EList strings
           
protected static boolean STRINGS_CASE_SENSITIVE_EDEFAULT
          The default value of the 'Strings Case Sensitive' attribute
protected static boolean STRINGS_NON_CHANGABLE_EDEFAULT
          The default value of the 'Strings Non Changable' attribute
protected  boolean stringsCaseSensitive
           
protected  boolean stringsCaseSensitiveESet
          This is true if the Strings Case Sensitive attribute has been set
protected  boolean stringsNonChangable
           
protected static boolean SUPPORTS_DUPLICATE_FILTER_STRINGS_EDEFAULT
          The default value of the 'Supports Duplicate Filter Strings' attribute
protected static boolean SUPPORTS_NESTED_FILTERS_EDEFAULT
          The default value of the 'Supports Nested Filters' attribute
protected  boolean supportsDuplicateFilterStrings
           
protected  boolean supportsNestedFilters
           
protected  String type
           
protected static String TYPE_EDEFAULT
          The default value of the 'Type' attribute
 
Fields inherited from class com.ibm.etools.systems.references.impl.SystemReferencedObjectImpl
helper
 
Constructor Summary
protected SystemFilterImpl()
          Constructor.
 
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
static String addPathTerminator(String path)
          Ensure given path ends with path separator.
 boolean addSystemFilter(SystemFilter filter)
          Adds given filter to the list.
 boolean areStringsCaseSensitive()
          Same as isStringsCaseSensitive()
 void clone(SystemFilter targetFilter)
          Clones a given filter to the given target filter.
 SystemFilter cloneSystemFilter(SystemFilter filter, String aliasName)
          Duplicates a given filter in the list.
 SystemFilterString copySystemFilterString(SystemFilter targetFilter, SystemFilterString oldFilterString)
          Copies a given filter string from this filter to another filter in this pool or another pool in this manager or another manager.
 SystemFilter createSystemFilter(String aliasName, Vector filterStrings)
          Creates a new nested system filter within this filter.
 void deleteSystemFilter(SystemFilter filter)
          Removes a given filter from the list.
 NotificationChain eBasicRemoveFromContainer(NotificationChain msgs)
           
 Object eGet(EStructuralFeature eFeature, boolean resolve)
           
 NotificationChain eInverseAdd(InternalEObject otherEnd, int featureID, Class baseClass, NotificationChain msgs)
           
 NotificationChain eInverseRemove(InternalEObject otherEnd, int featureID, Class baseClass, NotificationChain msgs)
           
 boolean eIsSet(EStructuralFeature eFeature)
           
 void eSet(EStructuralFeature eFeature, Object newValue)
           
protected  EClass eStaticClass()
           
 void eUnset(EStructuralFeature eFeature)
           
 Object getAdapter(Class adapterType)
          This is the method required by the IAdaptable interface.
 Object[] getChildren()
          Return the children of this filter.
 int getFilterStringCount()
          Return how many filter strings are defined in this filter.
 Vector getFilterStringObjectsVector()
          Get this filter's filter strings as a Vector of FilterString objects
 String[] getFilterStrings()
          Return filter strings as an array of String objects.
 Vector getFilterStringsVector()
          Return filter strings as a Vector of String objects
protected static IFolder getFolder(SystemFilter filter)
          Return folder
 SystemMOFHelpers getMOFHelpers()
           
static SystemMOFHelpers getMOFHelpers(SystemFilterPoolManagerImpl mgr)
           
 String getName()
          Returns the value of the 'Name' attribute
protected static SystemFilterNamingPolicy getNamingPolicy(SystemFilter filter)
          Return naming policy
 EList getNestedFilters()
          Returns the value of the 'Nested Filters' containment reference list.
 SystemFilter getParentFilter()
          Returns the value of the 'Parent Filter' container reference.
 SystemFilterContainer getParentFilterContainer()
          Return the ISystemFilterContainer parent of this filter.
 SystemFilterPool getParentFilterPool()
          Return the parent pool of this filter.
 SystemFilterPoolManagerProvider getProvider()
          Return the caller which instantiated the filter pool manager overseeing this filter framework instance
 int getRelativeOrder()
          Returns the value of the 'Relative Order' attribute
 int getRelease()
          Returns the value of the 'Release' attribute
protected static String getRootSaveFileName(SystemFilter filter)
          Return the root save file name without the extension .xmi
protected static String getRootSaveFileName(SystemFilterNamingPolicy namingPolicy, String name)
          Return the root save file name without the extension .xmi
 IFile getSaveFile()
          Return a handle to the file this filter is saved to.
 String getSaveFileName()
          Return the unqualified name of the file this filter is saved to.
protected static String getSaveFileName(SystemMOFHelpers mofHelpers, SystemFilter filter)
          Return the unqualified save file name with the extension .xmi
protected static String getSaveFilePathAndName(SystemMOFHelpers mofHelpers, SystemFilter filter)
          Return the qualified save file name with the extension .xmi
 EList getStrings()
          Returns the value of the 'Strings' containment reference list.
 SystemFilter getSystemFilter(String aliasName)
          Return a filter object, given its aliasname.
 int getSystemFilterCount()
          Return how many filters are defined in this filter container
 Vector getSystemFilterNames()
          Return Vector of String objects: the names of existing filters in this container.
 SystemFilterPool getSystemFilterPool()
          From SystemFilterContainer.
 SystemFilterPoolManager getSystemFilterPoolManager()
          Return the filter pool manager managing this collection of filter pools and their filters.
 int getSystemFilterPosition(SystemFilter filter)
          Return a given filter's zero-based location
 SystemFilter[] getSystemFilters()
          Return the nested filters as an array
 SystemFilterString getSystemFilterString(String string)
          Get a filter string given its string value
 SystemFilterString[] getSystemFilterStrings()
          Get this filter's filter string objects as an array
 Vector getSystemFiltersVector()
          Return the nested filters as a Vector
 String getType()
          Returns the type attribute.
 String getTypeGen()
          Returns the type attribute.
 boolean hasChildren()
          Returns true if this filter has any nested filters or any filter strings
protected  void initializeFilterStrings()
          Internal use method
static FiltersFactory initMOF()
          Initialize the MOF package.
protected  EList internalGetFilters()
           
protected  void invalidateCache()
          Clear internal cache so it will be rebuilt on next request.
 boolean isDefault()
          Returns the value of the 'Default' attribute
 boolean isNested()
          Return true if this filter is a nested filter or not.
 boolean isNonChangable()
          Returns the value of the 'Non Changable' attribute
 boolean isNonDeletable()
          Returns the value of the 'Non Deletable' attribute
 boolean isNonRenamable()
          Returns the value of the 'Non Renamable' attribute
 boolean isPromptable()
          Returns the value of the 'Promptable' attribute
 boolean isSetSingleFilterStringOnly()
           
 boolean isSetStringsCaseSensitive()
          Returns whether the value of the 'Strings Case Sensitive' attribute is set
 boolean isSingleFilterStringOnly()
          Returns true if this filter is limited to a single filter string.
 boolean isSingleFilterStringOnlyGen()
           
 boolean isStringsCaseSensitive()
          Are filter strings in this filter case sensitive?
 boolean isStringsNonChangable()
          Returns the value of the 'Strings Non Changable' attribute
 boolean isSupportsDuplicateFilterStrings()
          Returns the value of the 'Supports Duplicate Filter Strings' attribute
 boolean isSupportsNestedFilters()
          Returns the value of the 'Supports Nested Filters' attribute
 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 moveSystemFilter(int pos, SystemFilter filter)
          Move a given filter to a given zero-based location
 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 renameSystemFilter(SystemFilter filter, String newName)
          Rename a given filter in the list.
static SystemFilter restore(SystemMOFHelpers mofHelpers, IFolder folder, String name, SystemFilterPool parentPool, SystemFilterNamingPolicy namingPolicy)
          Restore specific filter.
 void save()
          Attempt to save contents of filter to disk.
 void setDefault(boolean newDefault)
          Sets the value of the 'Default' attribute
 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 newName)
          Sets the value of the 'Name' attribute
 void setNonChangable(boolean newNonChangable)
          Sets the value of the 'Non Changable' attribute
 void setNonDeletable(boolean newNonDeletable)
          Sets the value of the 'Non Deletable' attribute
 void setNonRenamable(boolean newNonRenamable)
          Sets the value of the 'Non Renamable' attribute
 void setParentFilter(SystemFilter newParentFilter)
          Sets the value of the 'Parent Filter' container reference
 void setParentFilterPool(SystemFilterPool parentPool)
          Internal use method to set the parent filter pool.
 void setPromptable(boolean newPromptable)
          Sets the value of the 'Promptable' attribute
 void setRelativeOrder(int newRelativeOrder)
          Sets the value of the 'Relative Order' attribute
 void setRelease(int newRelease)
          Sets the value of the 'Release' attribute
 void setSingleFilterStringOnly(boolean newSingleFilterStringOnly)
           
 void setStringsCaseSensitive(boolean newStringsCaseSensitive)
          Sets the value of the 'Strings Case Sensitive' attribute
 void setStringsNonChangable(boolean newStringsNonChangable)
          Sets the value of the 'Strings Non Changable' attribute
 void setSupportsDuplicateFilterStrings(boolean newSupportsDuplicateFilterStrings)
          Sets the value of the 'Supports Duplicate Filter Strings' attribute
 void setSupportsNestedFilters(boolean newSupportsNestedFilters)
          Sets the value of the 'Supports Nested Filters' attribute
 void setType(String newType)
          Sets the value of the 'Type' attribute
 boolean supportsDuplicateFilterStrings()
          Does this support duplicate filter strings?
 boolean supportsNestedFilters()
          Does this support nested filters?
 String toString()
          Return string identifying this filter
 void unsetSingleFilterStringOnly()
           
 void unsetStringsCaseSensitive()
          Unsets the value of the 'Strings Case Sensitive' attribute
 void updateFilterString(SystemFilterString filterString, String newValue)
          Update a new filter string's string value
 void updateSystemFilter(SystemFilter filter, String newName, String[] newStrings)
          Updates a given filter in the list.
 
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

NAME_EDEFAULT

protected static final String NAME_EDEFAULT
The default value of the 'Name' attribute.

See Also:
getName()

filterStringArray

protected String[] filterStringArray

filterStringObjectArray

protected SystemFilterString[] filterStringObjectArray

filterStringVector

protected Vector filterStringVector

debug

protected static boolean debug

name

protected String name

TYPE_EDEFAULT

protected static final String TYPE_EDEFAULT
The default value of the 'Type' attribute.

See Also:
getType()

type

protected String type

SUPPORTS_NESTED_FILTERS_EDEFAULT

protected static final boolean SUPPORTS_NESTED_FILTERS_EDEFAULT
The default value of the 'Supports Nested Filters' attribute.

See Also:
isSupportsNestedFilters(), Constant Field Values

supportsNestedFilters

protected boolean supportsNestedFilters

RELATIVE_ORDER_EDEFAULT

protected static final int RELATIVE_ORDER_EDEFAULT
The default value of the 'Relative Order' attribute.

See Also:
getRelativeOrder(), Constant Field Values

relativeOrder

protected int relativeOrder

DEFAULT_EDEFAULT

protected static final boolean DEFAULT_EDEFAULT
The default value of the 'Default' attribute.

See Also:
isDefault(), Constant Field Values

default_

protected boolean default_

STRINGS_CASE_SENSITIVE_EDEFAULT

protected static final boolean STRINGS_CASE_SENSITIVE_EDEFAULT
The default value of the 'Strings Case Sensitive' attribute.

See Also:
isStringsCaseSensitive(), Constant Field Values

stringsCaseSensitive

protected boolean stringsCaseSensitive

stringsCaseSensitiveESet

protected boolean stringsCaseSensitiveESet
This is true if the Strings Case Sensitive attribute has been set.


PROMPTABLE_EDEFAULT

protected static final boolean PROMPTABLE_EDEFAULT
The default value of the 'Promptable' attribute.

See Also:
isPromptable(), Constant Field Values

promptable

protected boolean promptable

SUPPORTS_DUPLICATE_FILTER_STRINGS_EDEFAULT

protected static final boolean SUPPORTS_DUPLICATE_FILTER_STRINGS_EDEFAULT
The default value of the 'Supports Duplicate Filter Strings' attribute.

See Also:
isSupportsDuplicateFilterStrings(), Constant Field Values

supportsDuplicateFilterStrings

protected boolean supportsDuplicateFilterStrings

NON_DELETABLE_EDEFAULT

protected static final boolean NON_DELETABLE_EDEFAULT
The default value of the 'Non Deletable' attribute.

See Also:
isNonDeletable(), Constant Field Values

nonDeletable

protected boolean nonDeletable

NON_RENAMABLE_EDEFAULT

protected static final boolean NON_RENAMABLE_EDEFAULT
The default value of the 'Non Renamable' attribute.

See Also:
isNonRenamable(), Constant Field Values

nonRenamable

protected boolean nonRenamable

NON_CHANGABLE_EDEFAULT

protected static final boolean NON_CHANGABLE_EDEFAULT
The default value of the 'Non Changable' attribute.

See Also:
isNonChangable(), Constant Field Values

nonChangable

protected boolean nonChangable

STRINGS_NON_CHANGABLE_EDEFAULT

protected static final boolean STRINGS_NON_CHANGABLE_EDEFAULT
The default value of the 'Strings Non Changable' attribute.

See Also:
isStringsNonChangable(), Constant Field Values

stringsNonChangable

protected boolean stringsNonChangable

RELEASE_EDEFAULT

protected static final int RELEASE_EDEFAULT
The default value of the 'Release' attribute.

See Also:
getRelease(), Constant Field Values

release

protected int release

SINGLE_FILTER_STRING_ONLY_EDEFAULT

protected static final boolean SINGLE_FILTER_STRING_ONLY_EDEFAULT
The default value of the 'Single Filter String Only' attribute.

See Also:
isSingleFilterStringOnly(), Constant Field Values

singleFilterStringOnly

protected boolean singleFilterStringOnly
The cached value of the 'Single Filter String Only' attribute.

See Also:
isSingleFilterStringOnly()

singleFilterStringOnlyESet

protected boolean singleFilterStringOnlyESet
This is true if the Single Filter String Only attribute has been set.


nestedFilters

protected EList nestedFilters

strings

protected EList strings
Constructor Detail

SystemFilterImpl

protected SystemFilterImpl()
Constructor. Do not instantiate directly, let MOF do it!

Method Detail

eStaticClass

protected EClass eStaticClass()

Overrides:
eStaticClass in class SystemReferencedObjectImpl

internalGetFilters

protected EList internalGetFilters()

getType

public String getType()
Returns the type attribute. Intercepted to return SystemFilterConstants.DEFAULT_TYPE if it is currently null

Specified by:
getType in interface SystemFilter
Returns:
the value of the 'Type' attribute.
See Also:
SystemFilter.setType(String), FiltersPackage.getSystemFilter_Type()

getTypeGen

public String getTypeGen()
Returns the type attribute. Intercepted to return SystemFilterConstants.DEFAULT_TYPE if it is currently null


createSystemFilter

public SystemFilter createSystemFilter(String aliasName,
                                       Vector filterStrings)
Creates a new nested system filter within this filter. This filter will inherit/store the following attributes from this filter:

Specified by:
createSystemFilter in interface SystemFilterContainer
Parameters:
aliasName - The name to give the new filter. Must be unique for this pool.
filterStrings - The list of String objects that represent the filter strings.

initializeFilterStrings

protected void initializeFilterStrings()
Internal use method


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
Parameters:
targetFilter - new filter into which we copy all our data

copySystemFilterString

public SystemFilterString copySystemFilterString(SystemFilter targetFilter,
                                                 SystemFilterString oldFilterString)
Copies a given filter string from this filter to another filter in this pool or another pool in this manager or another manager.

Specified by:
copySystemFilterString in interface SystemFilter

getSystemFilterPool

public SystemFilterPool getSystemFilterPool()
From SystemFilterContainer. Same as calling getParentFilterPool(). It walks the parent chain until the pool is found.

Specified by:
getSystemFilterPool in interface SystemFilterContainer

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 false.

Specified by:
isTransient in interface SystemFilter
See Also:
SystemFilterSimpleImpl

supportsNestedFilters

public boolean supportsNestedFilters()
Does this support nested filters? Calls mof-generated isSupportsNestedFilters.


supportsDuplicateFilterStrings

public boolean supportsDuplicateFilterStrings()
Does this support duplicate filter strings? Calls mof-generated isSupportsDuplicateFilterStrings.

Specified by:
supportsDuplicateFilterStrings in interface SystemFilter

isNested

public boolean isNested()
Return true if this filter is a nested filter or not. If not, its parent is the filter pool.

Specified by:
isNested in interface SystemFilter

isStringsCaseSensitive

public boolean isStringsCaseSensitive()
Are filter strings in this filter case sensitive? If not set locally, queries the parent filter pool's atttribute.

Specified by:
isStringsCaseSensitive in interface SystemFilter
Returns:
The value of the StringsCaseSensitive attribute
See Also:
SystemFilter.isSetStringsCaseSensitive(), SystemFilter.unsetStringsCaseSensitive(), SystemFilter.setStringsCaseSensitive(boolean), FiltersPackage.getSystemFilter_StringsCaseSensitive()

areStringsCaseSensitive

public boolean areStringsCaseSensitive()
Same as isStringsCaseSensitive()

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

getSystemFilterNames

public Vector getSystemFilterNames()
Return Vector of String objects: the names of existing filters in this container. Needed by name validators for New and Rename actions to verify new name is unique.

Specified by:
getSystemFilterNames in interface SystemFilterContainer

getSystemFiltersVector

public Vector getSystemFiltersVector()
Return the nested filters as a Vector

Specified by:
getSystemFiltersVector in interface SystemFilterContainer

getSystemFilters

public SystemFilter[] getSystemFilters()
Return the nested filters as an array

Specified by:
getSystemFilters in interface SystemFilterContainer

getSystemFilterCount

public int getSystemFilterCount()
Return how many filters are defined in this filter container

Specified by:
getSystemFilterCount in interface SystemFilterContainer

getSystemFilter

public SystemFilter getSystemFilter(String aliasName)
Return a filter object, given its aliasname. Can be used to test if an aliasname is already used (non-null return).

Specified by:
getSystemFilter in interface SystemFilterContainer
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.

addSystemFilter

public boolean addSystemFilter(SystemFilter filter)
Adds given filter to the list.

PLEASE NOTE:

Specified by:
addSystemFilter in interface SystemFilterContainer
Parameters:
filter - SystemFilter object to add
Returns:
true if added, false if filter with this aliasname already existed.

deleteSystemFilter

public void deleteSystemFilter(SystemFilter filter)
Removes a given filter from the list.

Specified by:
deleteSystemFilter in interface SystemFilterContainer
Parameters:
filter - SystemFilter object to remove

renameSystemFilter

public void renameSystemFilter(SystemFilter filter,
                               String newName)
Rename a given filter in the list.

Specified by:
renameSystemFilter in interface SystemFilterContainer
Parameters:
filter - SystemFilter object to remove
newName - New name to assign it. Assumes unique checking already done.

updateSystemFilter

public void updateSystemFilter(SystemFilter filter,
                               String newName,
                               String[] newStrings)
Updates a given filter in the list.

Specified by:
updateSystemFilter in interface SystemFilterContainer
Parameters:
filter - SystemFilter object to update
newName - New name to assign it. Assumes unique checking already done.
newStrings - New strings to assign it. Replaces current strings.

cloneSystemFilter

public SystemFilter cloneSystemFilter(SystemFilter filter,
                                      String aliasName)
Duplicates a given filter in the list.

Parameters:
filter - SystemFilter object to clone

getSystemFilterPosition

public int getSystemFilterPosition(SystemFilter filter)
Return a given filter's zero-based location

Specified by:
getSystemFilterPosition in interface SystemFilterContainer

moveSystemFilter

public void moveSystemFilter(int pos,
                             SystemFilter filter)
Move a given filter to a given zero-based location

Specified by:
moveSystemFilter in interface SystemFilterContainer

getParentFilterPool

public SystemFilterPool getParentFilterPool()
Return the parent pool of this filter. For nested filters, we walk up the parent chain until we find the pool.

Specified by:
getParentFilterPool in interface SystemFilter

setParentFilterPool

public void setParentFilterPool(SystemFilterPool parentPool)
Internal use method to set the parent filter pool.

Specified by:
setParentFilterPool in interface SystemFilter

getParentFilterContainer

public SystemFilterContainer getParentFilterContainer()
Return the ISystemFilterContainer parent of this filter. Will be either a SystemFilterPool or a SystemFilter if this is a nested filter.

Specified by:
getParentFilterContainer in interface SystemFilter

invalidateCache

protected void invalidateCache()
Clear internal cache so it will be rebuilt on next request.


getFilterStrings

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

Specified by:
getFilterStrings in interface SystemFilter

getFilterStringsVector

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

Specified by:
getFilterStringsVector in interface SystemFilter

getFilterStringObjectsVector

public Vector getFilterStringObjectsVector()
Get this filter's filter strings as a Vector of FilterString objects

Specified by:
getFilterStringObjectsVector in interface SystemFilter

getFilterStringCount

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

Specified by:
getFilterStringCount in interface SystemFilter

getSystemFilterString

public SystemFilterString getSystemFilterString(String string)
Get a filter string given its string value

Specified by:
getSystemFilterString in interface SystemFilter

setFilterStrings

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

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

getSystemFilterStrings

public SystemFilterString[] getSystemFilterStrings()
Get this filter's filter string objects as an array

Specified by:
getSystemFilterStrings in interface SystemFilter

setFilterStrings

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

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

addFilterString

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

Specified by:
addFilterString in interface SystemFilter

addFilterString

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

Specified by:
addFilterString in interface SystemFilter

updateFilterString

public void updateFilterString(SystemFilterString filterString,
                               String newValue)
Update a new filter string's string value

Specified by:
updateFilterString in interface SystemFilter

removeFilterString

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

Specified by:
removeFilterString in interface SystemFilter
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
Returns:
the SystemFilterString object deleted, or null if not found

removeFilterString

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

Specified by:
removeFilterString in interface SystemFilter
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

Specified by:
moveSystemFilterString in interface SystemFilter

getAdapter

public Object getAdapter(Class adapterType)
This is the method required by the IAdaptable interface. Given an adapter class type, return an object castable to the type, or null if this is not possible.

Specified by:
getAdapter in interface IAdaptable

getChildren

public Object[] getChildren()
Return the children of this filter. This is all nested filters and all filter strings.


hasChildren

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


getProvider

public SystemFilterPoolManagerProvider getProvider()
Return the caller which instantiated the filter pool manager overseeing this filter framework instance

Specified by:
getProvider in interface SystemFilter

getSystemFilterPoolManager

public SystemFilterPoolManager getSystemFilterPoolManager()
Return the filter pool manager managing this collection of filter pools and their filters. To save space, we delegate this query to our parent filter pool.

Specified by:
getSystemFilterPoolManager in interface SystemFilterContainer

getSaveFile

public IFile getSaveFile()
Return a handle to the file this filter is saved to.

Called by SystemFilterPoolManager on a rename or delete operation when the save policy is one file per filter.

Specified by:
getSaveFile in interface SystemFilter

getSaveFileName

public String getSaveFileName()
Return the unqualified name of the file this filter is saved to.

Called by SystemFilterPoolManager on a rename or delete operation when the save policy is one file per filter.

Specified by:
getSaveFileName in interface SystemFilter

save

public void save()
          throws Exception
Attempt to save contents of filter to disk. Only used for save policy of one file per filter. Assumes getFolder() in parent pool will return the folder to save to.

Specified by:
save in interface SystemFilter
Throws:
Exception

restore

public static SystemFilter restore(SystemMOFHelpers mofHelpers,
                                   IFolder folder,
                                   String name,
                                   SystemFilterPool parentPool,
                                   SystemFilterNamingPolicy namingPolicy)
                            throws Exception
Restore specific filter. Used when save policy is SAVE_POLICY_ONE_FILE_PER_FILTER

Parameters:
mofHelpers - helper object with routines for saving/restoring using mof.
folder - the folder containing the saved file.
name - The name of the saved filter. The file name is derived from this.
parentPool - the SystemFilterPool that is the parent of this filter. Will be perpetuated to nested filters.
namingPolicy - Tells us how to derive file name from filter name. Can be null for default prefix name.
Returns:
SystemFilter object if restored ok, null if error encountered. If null, call getLastException().
Throws:
Exception

getSaveFilePathAndName

protected static String getSaveFilePathAndName(SystemMOFHelpers mofHelpers,
                                               SystemFilter filter)
Return the qualified save file name with the extension .xmi


getSaveFileName

protected static String getSaveFileName(SystemMOFHelpers mofHelpers,
                                        SystemFilter filter)
Return the unqualified save file name with the extension .xmi


getRootSaveFileName

protected static String getRootSaveFileName(SystemFilter filter)
Return the root save file name without the extension .xmi


getRootSaveFileName

protected static String getRootSaveFileName(SystemFilterNamingPolicy namingPolicy,
                                            String name)
Return the root save file name without the extension .xmi


getNamingPolicy

protected static SystemFilterNamingPolicy getNamingPolicy(SystemFilter filter)
Return naming policy


getFolder

protected static IFolder getFolder(SystemFilter filter)
Return folder


addPathTerminator

public static String addPathTerminator(String path)
Ensure given path ends with path separator.


initMOF

public static FiltersFactory initMOF()
Initialize the MOF package. Need only be done once.


getMOFHelpers

public static SystemMOFHelpers getMOFHelpers(SystemFilterPoolManagerImpl mgr)

getMOFHelpers

public SystemMOFHelpers getMOFHelpers()

toString

public String toString()
Return string identifying this filter


getName

public String getName()
Description copied from interface: SystemFilter
Returns the value of the 'Name' attribute.

If the meaning of the 'Name' attribute isn't clear, there really should be more of a description here...

Specified by:
getName in interface SystemFilter
Returns:
the value of the 'Name' attribute.
See Also:
SystemFilter.setName(String), FiltersPackage.getSystemFilter_Name()

setName

public void setName(String newName)
Description copied from interface: SystemFilter
Sets the value of the 'Name' attribute.

Specified by:
setName in interface SystemFilter
Parameters:
newName - the new value of the 'Name' attribute.
See Also:
SystemFilter.getName()

setType

public void setType(String newType)
Description copied from interface: SystemFilter
Sets the value of the 'Type' attribute.

Specified by:
setType in interface SystemFilter
Parameters:
newType - the new value of the 'Type' attribute.
See Also:
SystemFilter.getType()

isSupportsNestedFilters

public boolean isSupportsNestedFilters()
Description copied from interface: SystemFilter
Returns the value of the 'Supports Nested Filters' attribute.

If the meaning of the 'Supports Nested Filters' attribute isn't clear, there really should be more of a description here...

Specified by:
isSupportsNestedFilters in interface SystemFilter
Returns:
the value of the 'Supports Nested Filters' attribute.
See Also:
SystemFilter.setSupportsNestedFilters(boolean), FiltersPackage.getSystemFilter_SupportsNestedFilters()

setSupportsNestedFilters

public void setSupportsNestedFilters(boolean newSupportsNestedFilters)
Description copied from interface: SystemFilter
Sets the value of the 'Supports Nested Filters' attribute.

Specified by:
setSupportsNestedFilters in interface SystemFilter
Parameters:
newSupportsNestedFilters - the new value of the 'Supports Nested Filters' attribute.
See Also:
SystemFilter.isSupportsNestedFilters()

getRelativeOrder

public int getRelativeOrder()
Description copied from interface: SystemFilter
Returns the value of the 'Relative Order' attribute.

If the meaning of the 'Relative Order' attribute isn't clear, there really should be more of a description here...

Specified by:
getRelativeOrder in interface SystemFilter
Returns:
the value of the 'Relative Order' attribute.
See Also:
SystemFilter.setRelativeOrder(int), FiltersPackage.getSystemFilter_RelativeOrder()

setRelativeOrder

public void setRelativeOrder(int newRelativeOrder)
Description copied from interface: SystemFilter
Sets the value of the 'Relative Order' attribute.

Specified by:
setRelativeOrder in interface SystemFilter
Parameters:
newRelativeOrder - the new value of the 'Relative Order' attribute.
See Also:
SystemFilter.getRelativeOrder()

isDefault

public boolean isDefault()
Description copied from interface: SystemFilter
Returns the value of the 'Default' attribute.

If the meaning of the 'Default' attribute isn't clear, there really should be more of a description here...

Specified by:
isDefault in interface SystemFilter
Returns:
the value of the 'Default' attribute.
See Also:
SystemFilter.setDefault(boolean), FiltersPackage.getSystemFilter_Default()

setDefault

public void setDefault(boolean newDefault)
Description copied from interface: SystemFilter
Sets the value of the 'Default' attribute.

Specified by:
setDefault in interface SystemFilter
Parameters:
newDefault - the new value of the 'Default' attribute.
See Also:
SystemFilter.isDefault()

setStringsCaseSensitive

public void setStringsCaseSensitive(boolean newStringsCaseSensitive)
Description copied from interface: SystemFilter
Sets the value of the 'Strings Case Sensitive' attribute.

Specified by:
setStringsCaseSensitive in interface SystemFilter
Parameters:
newStringsCaseSensitive - the new value of the 'Strings Case Sensitive' attribute.
See Also:
SystemFilter.isSetStringsCaseSensitive(), SystemFilter.unsetStringsCaseSensitive(), SystemFilter.isStringsCaseSensitive()

unsetStringsCaseSensitive

public void unsetStringsCaseSensitive()
Description copied from interface: SystemFilter
Unsets the value of the 'Strings Case Sensitive' attribute.

Specified by:
unsetStringsCaseSensitive in interface SystemFilter
See Also:
SystemFilter.isSetStringsCaseSensitive(), SystemFilter.isStringsCaseSensitive(), SystemFilter.setStringsCaseSensitive(boolean)

isSetStringsCaseSensitive

public boolean isSetStringsCaseSensitive()
Description copied from interface: SystemFilter
Returns whether the value of the 'Strings Case Sensitive' attribute is set.

Specified by:
isSetStringsCaseSensitive in interface SystemFilter
Returns:
whether the value of the 'Strings Case Sensitive' attribute is set.
See Also:
SystemFilter.unsetStringsCaseSensitive(), SystemFilter.isStringsCaseSensitive(), SystemFilter.setStringsCaseSensitive(boolean)

isPromptable

public boolean isPromptable()
Description copied from interface: SystemFilter
Returns the value of the 'Promptable' attribute.

If the meaning of the 'Promptable' attribute isn't clear, there really should be more of a description here...

Specified by:
isPromptable in interface SystemFilter
Returns:
the value of the 'Promptable' attribute.
See Also:
SystemFilter.setPromptable(boolean), FiltersPackage.getSystemFilter_Promptable()

setPromptable

public void setPromptable(boolean newPromptable)
Description copied from interface: SystemFilter
Sets the value of the 'Promptable' attribute.

Specified by:
setPromptable in interface SystemFilter
Parameters:
newPromptable - the new value of the 'Promptable' attribute.
See Also:
SystemFilter.isPromptable()

getParentFilter

public SystemFilter getParentFilter()
Description copied from interface: SystemFilter
Returns the value of the 'Parent Filter' container reference. It is bidirectional and its opposite is 'Nested Filters'.

If the meaning of the 'Parent Filter' container reference isn't clear, there really should be more of a description here...

Specified by:
getParentFilter in interface SystemFilter
Returns:
the value of the 'Parent Filter' container reference.
See Also:
SystemFilter.setParentFilter(SystemFilter), FiltersPackage.getSystemFilter_ParentFilter(), SystemFilter.getNestedFilters()

setParentFilter

public void setParentFilter(SystemFilter newParentFilter)
Description copied from interface: SystemFilter
Sets the value of the 'Parent Filter' container reference.

Specified by:
setParentFilter in interface SystemFilter
Parameters:
newParentFilter - the new value of the 'Parent Filter' container reference.
See Also:
SystemFilter.getParentFilter()

getNestedFilters

public EList getNestedFilters()
Description copied from interface: SystemFilter
Returns the value of the 'Nested Filters' containment reference list. The list contents are of type SystemFilter. It is bidirectional and its opposite is 'Parent Filter'.

If the meaning of the 'Nested Filters' containment reference list isn't clear, there really should be more of a description here...

Specified by:
getNestedFilters in interface SystemFilter
Returns:
the value of the 'Nested Filters' containment reference list.
See Also:
FiltersPackage.getSystemFilter_NestedFilters(), SystemFilter.getParentFilter()

getStrings

public EList getStrings()
Description copied from interface: SystemFilter
Returns the value of the 'Strings' containment reference list. The list contents are of type SystemFilterString.

If the meaning of the 'Strings' containment reference list isn't clear, there really should be more of a description here...

Specified by:
getStrings in interface SystemFilter
Returns:
the value of the 'Strings' containment reference list.
See Also:
FiltersPackage.getSystemFilter_Strings()

eInverseAdd

public NotificationChain eInverseAdd(InternalEObject otherEnd,
                                     int featureID,
                                     Class baseClass,
                                     NotificationChain msgs)


eInverseRemove

public NotificationChain eInverseRemove(InternalEObject otherEnd,
                                        int featureID,
                                        Class baseClass,
                                        NotificationChain msgs)


eBasicRemoveFromContainer

public NotificationChain eBasicRemoveFromContainer(NotificationChain msgs)


eGet

public Object eGet(EStructuralFeature eFeature,
                   boolean resolve)


eIsSet

public boolean eIsSet(EStructuralFeature eFeature)

eSet

public void eSet(EStructuralFeature eFeature,
                 Object newValue)

eUnset

public void eUnset(EStructuralFeature eFeature)

isSupportsDuplicateFilterStrings

public boolean isSupportsDuplicateFilterStrings()
Description copied from interface: SystemFilter
Returns the value of the 'Supports Duplicate Filter Strings' attribute.

If the meaning of the 'Supports Duplicate Filter Strings' attribute isn't clear, there really should be more of a description here...

Specified by:
isSupportsDuplicateFilterStrings in interface SystemFilter
Returns:
the value of the 'Supports Duplicate Filter Strings' attribute.
See Also:
SystemFilter.setSupportsDuplicateFilterStrings(boolean), FiltersPackage.getSystemFilter_SupportsDuplicateFilterStrings()

setSupportsDuplicateFilterStrings

public void setSupportsDuplicateFilterStrings(boolean newSupportsDuplicateFilterStrings)
Description copied from interface: SystemFilter
Sets the value of the 'Supports Duplicate Filter Strings' attribute.

Specified by:
setSupportsDuplicateFilterStrings in interface SystemFilter
Parameters:
newSupportsDuplicateFilterStrings - the new value of the 'Supports Duplicate Filter Strings' attribute.
See Also:
SystemFilter.isSupportsDuplicateFilterStrings()

isNonDeletable

public boolean isNonDeletable()
Description copied from interface: SystemFilter
Returns the value of the 'Non Deletable' attribute.

If the meaning of the 'Non Deletable' attribute isn't clear, there really should be more of a description here...

Specified by:
isNonDeletable in interface SystemFilter
Returns:
the value of the 'Non Deletable' attribute.
See Also:
SystemFilter.setNonDeletable(boolean), FiltersPackage.getSystemFilter_NonDeletable()

setNonDeletable

public void setNonDeletable(boolean newNonDeletable)
Description copied from interface: SystemFilter
Sets the value of the 'Non Deletable' attribute.

Specified by:
setNonDeletable in interface SystemFilter
Parameters:
newNonDeletable - the new value of the 'Non Deletable' attribute.
See Also:
SystemFilter.isNonDeletable()

isNonRenamable

public boolean isNonRenamable()
Description copied from interface: SystemFilter
Returns the value of the 'Non Renamable' attribute.

If the meaning of the 'Non Renamable' attribute isn't clear, there really should be more of a description here...

Specified by:
isNonRenamable in interface SystemFilter
Returns:
the value of the 'Non Renamable' attribute.
See Also:
SystemFilter.setNonRenamable(boolean), FiltersPackage.getSystemFilter_NonRenamable()

setNonRenamable

public void setNonRenamable(boolean newNonRenamable)
Description copied from interface: SystemFilter
Sets the value of the 'Non Renamable' attribute.

Specified by:
setNonRenamable in interface SystemFilter
Parameters:
newNonRenamable - the new value of the 'Non Renamable' attribute.
See Also:
SystemFilter.isNonRenamable()

isNonChangable

public boolean isNonChangable()
Description copied from interface: SystemFilter
Returns the value of the 'Non Changable' attribute.

If the meaning of the 'Non Changable' attribute isn't clear, there really should be more of a description here...

Specified by:
isNonChangable in interface SystemFilter
Returns:
the value of the 'Non Changable' attribute.
See Also:
SystemFilter.setNonChangable(boolean), FiltersPackage.getSystemFilter_NonChangable()

setNonChangable

public void setNonChangable(boolean newNonChangable)
Description copied from interface: SystemFilter
Sets the value of the 'Non Changable' attribute.

Specified by:
setNonChangable in interface SystemFilter
Parameters:
newNonChangable - the new value of the 'Non Changable' attribute.
See Also:
SystemFilter.isNonChangable()

isStringsNonChangable

public boolean isStringsNonChangable()
Description copied from interface: SystemFilter
Returns the value of the 'Strings Non Changable' attribute.

If the meaning of the 'Strings Non Changable' attribute isn't clear, there really should be more of a description here...

Specified by:
isStringsNonChangable in interface SystemFilter
Returns:
the value of the 'Strings Non Changable' attribute.
See Also:
SystemFilter.setStringsNonChangable(boolean), FiltersPackage.getSystemFilter_StringsNonChangable()

setStringsNonChangable

public void setStringsNonChangable(boolean newStringsNonChangable)
Description copied from interface: SystemFilter
Sets the value of the 'Strings Non Changable' attribute.

Specified by:
setStringsNonChangable in interface SystemFilter
Parameters:
newStringsNonChangable - the new value of the 'Strings Non Changable' attribute.
See Also:
SystemFilter.isStringsNonChangable()

getRelease

public int getRelease()
Description copied from interface: SystemFilter
Returns the value of the 'Release' attribute.

If the meaning of the 'Release' attribute isn't clear, there really should be more of a description here...

Specified by:
getRelease in interface SystemFilter
Returns:
the value of the 'Release' attribute.
See Also:
SystemFilter.setRelease(int), FiltersPackage.getSystemFilter_Release()

setRelease

public void setRelease(int newRelease)
Description copied from interface: SystemFilter
Sets the value of the 'Release' attribute.

Specified by:
setRelease in interface SystemFilter
Parameters:
newRelease - the new value of the 'Release' attribute.
See Also:
SystemFilter.getRelease()

isSingleFilterStringOnly

public boolean isSingleFilterStringOnly()
Returns true if this filter is limited to a single filter string. If not set here, it is queried from the parent pool.

Specified by:
isSingleFilterStringOnly in interface SystemFilter
Returns:
the value of the 'Single Filter String Only' attribute.
See Also:
SystemFilter.isSetSingleFilterStringOnly(), SystemFilter.unsetSingleFilterStringOnly(), SystemFilter.setSingleFilterStringOnly(boolean), FiltersPackage.getSystemFilter_SingleFilterStringOnly()

isSingleFilterStringOnlyGen

public boolean isSingleFilterStringOnlyGen()


setSingleFilterStringOnly

public void setSingleFilterStringOnly(boolean newSingleFilterStringOnly)

Specified by:
setSingleFilterStringOnly in interface SystemFilter
Parameters:
newSingleFilterStringOnly - the new value of the 'Single Filter String Only' attribute.
See Also:
SystemFilter.isSetSingleFilterStringOnly(), SystemFilter.unsetSingleFilterStringOnly(), SystemFilter.isSingleFilterStringOnly()

unsetSingleFilterStringOnly

public void unsetSingleFilterStringOnly()

Specified by:
unsetSingleFilterStringOnly in interface SystemFilter
See Also:
SystemFilter.isSetSingleFilterStringOnly(), SystemFilter.isSingleFilterStringOnly(), SystemFilter.setSingleFilterStringOnly(boolean)

isSetSingleFilterStringOnly

public boolean isSetSingleFilterStringOnly()

Specified by:
isSetSingleFilterStringOnly in interface SystemFilter
Returns:
whether the value of the 'Single Filter String Only' attribute is set.
See Also:
SystemFilter.unsetSingleFilterStringOnly(), SystemFilter.isSingleFilterStringOnly(), SystemFilter.setSingleFilterStringOnly(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.