org.eclipse.rse.core.filters
Interface ISystemFilterContainer

All Superinterfaces:

org.eclipse.rse.core.persistance.IRSEPersistableContainer

All Known Subinterfaces:

ISystemFilter, ISystemFilterPool

All Known Implementing Classes:

org.eclipse.rse.internal.filters.SystemFilter, SystemFilterPool

public interface ISystemFilterContainer

extends org.eclipse.rse.core.persistance.IRSEPersistableContainer

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

Method Summary

boolean	addSystemFilter(ISystemFilter filter) Adds given filter to the list.
boolean	areStringsCaseSensitive()
ISystemFilter	createSystemFilter(String aliasName, Vector filterStrings) Creates a new system filter within this container (SystemFilterPool or SystemFilter)
void	deleteSystemFilter(ISystemFilter filter) Removes a given filter from the list.
ISystemFilter	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.
ISystemFilterPool	getSystemFilterPool() Return the parent pool of this container.
ISystemFilterPoolManager	getSystemFilterPoolManager() Return the filter pool manager managing this collection of filter pools and their filters.
int	getSystemFilterPosition(ISystemFilter filter) Return a given filter's zero-based location
ISystemFilter[]	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, ISystemFilter filter) Move a given filter to a given zero-based location
void	renameSystemFilter(ISystemFilter filter, String newName) Renames a given filter in the list.
void	updateSystemFilter(ISystemFilter filter, String newName, String[] newStrings) Updates a given filter in the list.

Methods inherited from interface org.eclipse.rse.core.persistance.IRSEPersistableContainer

commit, isDirty, setDirty, setWasRestored, wasRestored

Method Detail

getSystemFilterPoolManager

public ISystemFilterPoolManager 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 ISystemFilter 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(ISystemFilter filter)

Adds given filter to the list.

PLEASE NOTE:

• createSystemFilter calls this method for you!
• this is a no-op if a filter with the same aliasname already exists

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 ISystemFilter[] getSystemFilters()

Return an array of the filters contained in this filter container.

getSystemFilter

public ISystemFilter getSystemFilter(String filterName)

Return a system filter given its name

getSystemFilterPool

public ISystemFilterPool 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(ISystemFilter filter)

Removes a given filter from the list.

Parameters:

filter - SystemFilter object to remove

renameSystemFilter

public void renameSystemFilter(ISystemFilter 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(ISystemFilter filter)

Return a given filter's zero-based location

moveSystemFilter

public void moveSystemFilter(int pos,
                             ISystemFilter filter)

Move a given filter to a given zero-based location

updateSystemFilter

public void updateSystemFilter(ISystemFilter 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.