Remote Systems
v6.4.1

com.ibm.etools.systems.filters
Interface SystemFilterContainer

All Known Subinterfaces:
SystemFilter, SystemFilterPool
All Known Implementing Classes:
SystemFilterImpl, SystemFilterPoolImpl

public interface SystemFilterContainer

Filter containers are any objects that contain filters. This includes filter pools and filters themselves.


Field Summary
static String copyright
           
 
Method Summary
 boolean addSystemFilter(SystemFilter filter)
          Adds given filter to the list.
 boolean areStringsCaseSensitive()
           
 SystemFilter createSystemFilter(String aliasName, Vector filterStrings)
          Creates a new system filter within this container (SystemFilterPool or SystemFilter)
 void deleteSystemFilter(SystemFilter filter)
          Removes a given filter from the list.
 SystemFilter getSystemFilter(String filterName)
          Return a system filter given its name
 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()
          Return the parent pool of this container.
 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 an array of the filters contained in this filter container.
 Vector getSystemFiltersVector()
          Return a Vector of the filters contained in this filter container.
 void moveSystemFilter(int pos, SystemFilter filter)
          Move a given filter to a given zero-based location
 void renameSystemFilter(SystemFilter filter, String newName)
          Renames a given filter in the list.
 void updateSystemFilter(SystemFilter filter, String newName, String[] newStrings)
          Updates a given filter in the list.
 

Field Detail

copyright

public static final String copyright
See Also:
Constant Field Values
Method Detail

getSystemFilterPoolManager

public SystemFilterPoolManager getSystemFilterPoolManager()
Return the filter pool manager managing this collection of filter pools and their filters.


areStringsCaseSensitive

public boolean areStringsCaseSensitive()
Returns:
The value of the StringsCaseSensitive attribute Are filter strings in this filter case sensitive? If not set locally, queries the parent filter pool manager's atttribute.

createSystemFilter

public SystemFilter createSystemFilter(String aliasName,
                                       Vector filterStrings)
Creates a new system filter within this container (SystemFilterPool or SystemFilter)

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.

addSystemFilter

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

PLEASE NOTE:

Parameters:
filter - SystemFilter object to add
Returns:
true if added, false if filter with this aliasname already existed.

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.


getSystemFiltersVector

public Vector getSystemFiltersVector()
Return a Vector of the filters contained in this filter container.


getSystemFilters

public SystemFilter[] getSystemFilters()
Return an array of the filters contained in this filter container.


getSystemFilter

public SystemFilter getSystemFilter(String filterName)
Return a system filter given its name


getSystemFilterPool

public SystemFilterPool getSystemFilterPool()
Return the parent pool of this container. If this is itself a pool, returns "this". Else, for a nested filter, returns the pool that is the ultimate parent of this filter.


getSystemFilterCount

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


deleteSystemFilter

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

Parameters:
filter - SystemFilter object to remove

renameSystemFilter

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

Parameters:
filter - SystemFilter object to rename
newName - New name to assign it. Assumes unique checking already done.

getSystemFilterPosition

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


moveSystemFilter

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


updateSystemFilter

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

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.

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.