org.eclipse.rse.core.filters
Interface ISystemFilterContainer

All Superinterfaces:

IRSEPersistableContainer

All Known Subinterfaces:

ISystemFilter, ISystemFilterPool

public interface ISystemFilterContainer

extends IRSEPersistableContainer

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

Field Summary

Fields inherited from interface org.eclipse.rse.core.model.IRSEPersistableContainer

NO_CHILDREN

Method Summary

boolean	addSystemFilter(ISystemFilter filter) Adds given filter to the list without populating the filter strings.
boolean	areStringsCaseSensitive()
ISystemFilter	createSystemFilter(String aliasName, String[] filterStrings) Adds a new system filter to this container (SystemFilterPool or SystemFilter) and populates it with the filter strings created from the strings provided.
void	deleteSystemFilter(ISystemFilter filter) Removes a given filter from the list.
ISystemFilter	getSystemFilter(String filterName)
int	getSystemFilterCount()
String[]	getSystemFilterNames() Get the names of existing filters in this container.
ISystemFilterPool	getSystemFilterPool()
ISystemFilterPoolManager	getSystemFilterPoolManager()
int	getSystemFilterPosition(ISystemFilter filter)
ISystemFilter[]	getSystemFilters()
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.

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

commit, getPersistableChildren, getPersistableParent, isDirty, isTainted, setDirty, setTainted, setWasRestored, wasRestored

Method Detail

getSystemFilterPoolManager

public ISystemFilterPoolManager getSystemFilterPoolManager()

Returns:

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 filters in this filter container case sensitive? If not set locally, queries the parent filter pool manager's attribute.

createSystemFilter

public ISystemFilter createSystemFilter(String aliasName,
                                        String[] filterStrings)

Adds a new system filter to this container (SystemFilterPool or SystemFilter) and populates it with the filter strings created from the strings provided. Does nothing if this filter already exists in this container.

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.

Since:

org.eclipse.rse.core 3.0

addSystemFilter

public boolean addSystemFilter(ISystemFilter filter)

Adds given filter to the list without populating the filter strings.

Parameters:

filter - SystemFilter object to add

Returns:

true if added, false if a filter with this aliasname already existed.

getSystemFilterNames

public String[] getSystemFilterNames()

Get the names of existing filters in this container. Typically used by name validators for New and Rename actions to verify new name is unique.

Returns:

String array of the names of existing filters in this container.

Since:

org.eclipse.rse.core 3.0

getSystemFilters

public ISystemFilter[] getSystemFilters()

Returns:

an array of the ISystemFilter objects contained in this filter container.

getSystemFilter

public ISystemFilter getSystemFilter(String filterName)

Returns:

a system filter given its name. Will return null if no filter by this name is found.

getSystemFilterPool

public ISystemFilterPool getSystemFilterPool()

Returns:

the parent pool of this container. If this is itself a pool, returns "this". For a nested filter, returns the pool that is the ultimate parent of this filter.

getSystemFilterCount

public int getSystemFilterCount()

Returns:

how many filters are directly defined in this filter container.

deleteSystemFilter

public void deleteSystemFilter(ISystemFilter filter)

Removes a given filter from the list. Will do nothing if the specified filter is not in this filter container.

Parameters:

filter - SystemFilter object to remove

renameSystemFilter

public void renameSystemFilter(ISystemFilter filter,
                               String newName)

Renames a given filter in the list. The new name is assumed to be valid. Will perform the rename whether or not the filter is contained in this container.

Parameters:

filter - SystemFilter object to rename

newName - New name to assign it.

getSystemFilterPosition

public int getSystemFilterPosition(ISystemFilter filter)

Returns:

a given filter's zero-based location. Will return -1 if the filter is not present in this container.

moveSystemFilter

public void moveSystemFilter(int pos,
                             ISystemFilter filter)

Move a given filter to a given zero-based location. Does nothing if the filter is not in this container.

Parameters:

pos - the new position of the filter.

filter - the filter to move.

updateSystemFilter

public void updateSystemFilter(ISystemFilter filter,
                               String newName,
                               String[] newStrings)

Updates a given filter. The filter need not be present in this container but will operate on any filter.

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.