Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 

RSE
Release 3.0

org.eclipse.rse.core.filters
Interface ISystemFilterPoolManager

All Superinterfaces:
IRSEPersistableContainer

public interface ISystemFilterPoolManager
extends IRSEPersistableContainer

A filter pool manager manages filter pools.

Further, this is the front door for working with filters too. By forcing all filter related activity through a single point like this, we can ensure that all changes are saved to disk, and events are fired properly.


Field Summary
 
Fields inherited from interface org.eclipse.rse.core.model. IRSEPersistableContainer
NO_CHILDREN
 
Method Summary
  ISystemFilterString addSystemFilterString ( ISystemFilter filter, String newString)
          Append a new filter string to the given filter's list Does the following: Adds the filter string to the in-memory cache Saves parent filter pool to disk.
  ISystemFilterString addSystemFilterString ( ISystemFilter filter, String newString, int position)
          Insert a new filter string to the given filter's list, at the given zero-based position Does the following: Adds the filter string to the in-memory cache Saves parent filter pool to disk.
 boolean areStringsCaseSensitive ()
           
  ISystemFilter copySystemFilter ( ISystemFilterPool targetPool, ISystemFilter oldFilter, String newName)
          Copy a system filter to a pool in this or another filter manager.
  ISystemFilterPool copySystemFilterPool ( ISystemFilterPoolManager targetMgr, ISystemFilterPool pool, String newName)
          Copy the specified filter pool from this manager to this manager or another manager.
 void copySystemFilterPools ( ISystemFilterPoolManager targetMgr)
          Copy all filter pools from this manager to another manager.
  ISystemFilterString copySystemFilterString ( ISystemFilter targetFilter, ISystemFilterString oldFilterString)
          Copy a system filter string to a filter in this or another filter pool manager.
  ISystemFilter createSystemFilter ( ISystemFilterContainer parent, String aliasName, List filterStrings)
          Creates a new system filter within the given filter container (either a filter pool, or a filter).
  ISystemFilter createSystemFilter ( ISystemFilterContainer parent, String aliasName, List filterStrings, String type)
          Creates a new system filter that is typed.
  ISystemFilter createSystemFilter ( ISystemFilterContainer parent, String aliasName, List filterStrings, String type, boolean promptable)
          Creates a new system filter that is typed and promptable Same as createSystemFilter(ISystemFilterContainer, String ,String[], String) but takes a boolean indicating if it is promptable.
  ISystemFilter createSystemFilter ( ISystemFilterContainer parent, String aliasName, String[] filterStrings)
          Creates a new system filter within the given filter container (either a filter pool, or a filter).
  ISystemFilter createSystemFilter ( ISystemFilterContainer parent, String aliasName, String[] filterStrings, String type)
          Creates a new system filter that is typed.
  ISystemFilter createSystemFilter ( ISystemFilterContainer parent, String aliasName, String[] filterStrings, String type, boolean promptable)
          Creates a new system filter that is typed and promptable Same as createSystemFilter(ISystemFilterContainer, String ,String[], String) but takes a boolean indicating if it is promptable.
  ISystemFilterPool createSystemFilterPool ( String name, boolean isDeletable)
          Create a new filter pool.
 void deleteAllSystemFilterPools ()
          Delete all existing filter pools.
 boolean deleteSystemFilter ( ISystemFilter filter)
          Delete an existing system filter.
 void deleteSystemFilterPool ( ISystemFilterPool pool)
          Delete a given filter pool.
  ISystemFilterPool getFirstDefaultSystemFilterPool ()
          Return the first pool that has the default attribute set to true.
  String getName ()
          Return the name of this manager.
  ISystemFilterPoolManagerProvider getProvider ()
          Return the caller which instantiated the filter pool manager
  ISystemFilterPool getSystemFilterPool ( String name)
          Given a filter pool name, return that filter pool object.
  Object getSystemFilterPoolManagerData ()
          Return transient data set via setFilterPoolDataManager.
  String[] getSystemFilterPoolNames ()
          Get array of filter pool names currently existing.
  ISystemFilterPool[] getSystemFilterPools ()
          Return array of SystemFilterPools managed by this manager.
 int getSystemFilterPosition ( ISystemFilter filter)
          Return the zero-based position of a SystemFilter object within its container
 int getSystemFilterStringPosition ( ISystemFilterString filterString)
          Return the zero-based position of a SystemFilterString object within its filter
  ISystemProfile getSystemProfile ()
          Return the owning profile for this provider
 boolean isSetSupportsDuplicateFilterStrings ()
           
 boolean isSingleFilterStringOnly ()
          Returns the value of the ' Single Filter String Only ' attribute
 boolean isStringsCaseSensitive ()
           
 boolean isSupportsDuplicateFilterStrings ()
           
 boolean isSupportsNestedFilters ()
           
  ISystemFilter moveSystemFilter ( ISystemFilterPool targetPool, ISystemFilter oldFilter, String newName)
          Move a system filter to a pool in this or another filter manager.
  ISystemFilterPool moveSystemFilterPool ( ISystemFilterPoolManager targetMgr, ISystemFilterPool oldPool, String newName)
          Move the specified filter pool from this manager to another manager.
 void moveSystemFilters ( ISystemFilter[] filters, int delta)
          Move existing filters a given number of positions in the same container.
  ISystemFilterString moveSystemFilterString ( ISystemFilter targetFilter, ISystemFilterString oldFilterString)
          Move a system filter string to a filter in this or another filter pool manager.
 void moveSystemFilterStrings ( ISystemFilterString[] filterStrings, int delta)
          Move existing filter strings a given number of positions in the same filter If the delta is negative, they are all moved up by the given amount.
 void orderSystemFilters ( ISystemFilterPool pool, String[] names)
          Order filters according to user preferences.
 boolean preTestRenameFilterPool ( ISystemFilterPool pool)
          Pre-test if we are going to run into any trouble renaming any of the files or folders used to persist a filter pool.
 boolean removeSystemFilterString ( ISystemFilter filter, int position)
          Remove a filter string from the given filter's list, given its zero-based position Does the following: Removes the filter string from the in-memory cache Saves parent filter pool to disk.
 boolean removeSystemFilterString ( ISystemFilter filter, ISystemFilterString filterString)
          Remove a filter string from this filter's list, given its SystemFilterString object.
 boolean removeSystemFilterString ( ISystemFilter filter, String oldString)
          Delete a filter string from the given filter's list Does the following: Removes the filter string from the in-memory cache Saves parent filter pool to disk.
 void renameSystemFilter ( ISystemFilter filter, String newName)
          Renames a filter.
 void renameSystemFilterPool ( ISystemFilterPool pool, String newName)
          Rename a filter pool.
 void setName ( String name)
          Set the name of this manager.
 void setProvider ( ISystemFilterPoolManagerProvider caller)
          Set the caller instance which instantiated the filter pool manager.
 void setSingleFilterStringOnly (boolean value)
          Sets the value of the ' Single Filter String Only' attribute
 void setStringsCaseSensitive (boolean value)
           
 void setSupportsDuplicateFilterStrings (boolean supports)
          Set attribute indicating if filters managed by this manager support duplicate filter strings, by default.
 void setSupportsNestedFilters (boolean supports)
          Set attribute indicating if filter pools managed by this manager support nested filters, by default.
 void setSystemFilterPoolManagerData ( Object data)
          This is to set transient data that is subsequently queryable.
 void setSystemFilterType ( ISystemFilter filter, String newType)
          Sets a filter's type.
 boolean supportsDuplicateFilterStrings ()
          Return attribute indicating if filters managed by this manager support nested duplicate filter strings.
 boolean supportsNestedFilters ()
          Return attribute indicating if filter pools managed by this manager support nested filters.
 void suspendCallbacks (boolean suspend)
          Suspend callbacks to the provider
 void unsetSupportsDuplicateFilterStrings ()
           
 void updateSystemFilter ( ISystemFilter filter, String newName, String[] strings)
          Updates a filter.
 void updateSystemFilterString ( ISystemFilterString filterString, String newValue)
          Update a filter string's string vale Does the following: Update the filter string in the in-memory cache Saves parent filter pool to disk.
 boolean wasRestored ()
          Return false if the instantiation of this filter pool manager resulting in a new manager versus a restoration
 
Methods inherited from interface org.eclipse.rse.core.model. IRSEPersistableContainer
commit, getPersistableChildren, getPersistableParent, isDirty, isTainted, setDirty, setTainted, setWasRestored
 

Method Detail

getProvider

ISystemFilterPoolManagerProvider getProvider()
Return the caller which instantiated the filter pool manager


getSystemProfile

ISystemProfile getSystemProfile()
Return the owning profile for this provider


setProvider

void setProvider(
ISystemFilterPoolManagerProvider caller)
Set the caller instance which instantiated the filter pool manager. This is only recorded to enable getProvider from any filter framework object.


setSystemFilterPoolManagerData

void setSystemFilterPoolManagerData(
Object data)
This is to set transient data that is subsequently queryable.


getSystemFilterPoolManagerData

Object getSystemFilterPoolManagerData()
Return transient data set via setFilterPoolDataManager.


getName

String getName()
Return the name of this manager. This matches the name of the folder, which is the parent of the individual filter pool folders.


setName

void setName(
String name)
Set the name of this manager.


supportsNestedFilters

boolean supportsNestedFilters()
Return attribute indicating if filter pools managed by this manager support nested filters.


supportsDuplicateFilterStrings

boolean supportsDuplicateFilterStrings()
Return attribute indicating if filters managed by this manager support nested duplicate filter strings.


setSupportsNestedFilters

void setSupportsNestedFilters(boolean supports)
Set attribute indicating if filter pools managed by this manager support nested filters, by default.


setSupportsDuplicateFilterStrings

void setSupportsDuplicateFilterStrings(boolean supports)
Set attribute indicating if filters managed by this manager support duplicate filter strings, by default.


isStringsCaseSensitive

boolean isStringsCaseSensitive()
Returns:
The value of the StringsCaseSensitive attribute Are filter strings in this filter case sensitive?

areStringsCaseSensitive

boolean areStringsCaseSensitive()
Returns:
The value of the StringsCaseSensitive attribute Are filter strings in this filter case sensitive? Same as isStringsCaseSensitive()

wasRestored

boolean wasRestored()
Return false if the instantiation of this filter pool manager resulting in a new manager versus a restoration

Specified by:
wasRestored in interface IRSEPersistableContainer
Returns:
true if the object was created from its persistent form, false if the object has never been persisted.

getSystemFilterPoolNames

String[] getSystemFilterPoolNames()
Get array of filter pool names currently existing.


getSystemFilterPools

ISystemFilterPool[] getSystemFilterPools()
Return array of SystemFilterPools managed by this manager.


getSystemFilterPool

ISystemFilterPool getSystemFilterPool(
String name)
Given a filter pool name, return that filter pool object. If not found, returns null.


getFirstDefaultSystemFilterPool

ISystemFilterPool getFirstDefaultSystemFilterPool()
Return the first pool that has the default attribute set to true. If none found, returns null.


createSystemFilterPool

ISystemFilterPool createSystemFilterPool(
String name,
                                         boolean isDeletable)
                                         throws 
Exception
Create a new filter pool. Inherits the following attributes from this manager:
  • data ... the transient data to be associated with every filter pool and filter
  • supportsNestedFilters ... whether filters in the pool can themselves contain filters

If a pool of this name already exists, null will be returned.

Depending on the save policy, a new folder to hold the pool may be created. Its name will be derived from the pool name.

If the operation is successful, the pool will be saved to disk.

If this operation fails unexpectedly, an exception will be thrown.

Throws:
Exception
See Also:
ISystemFilterPool.setName(String)

deleteSystemFilterPool

void deleteSystemFilterPool(
ISystemFilterPool pool)
                            throws 
Exception
Delete a given filter pool. Dependending on the save policy, the appropriate file or folder on disk will also be deleted.

Does the following:

  • Removes all references
  • Removes pool object from in-memory model
  • Removes folder from disk for policies of one folder per pool
  • Removes file from disk for policy of one file per pool
  • Saves model to disk for policy of one file per manager
  • Invalidates in-memory caches
  • Calls back to inform caller of this event

Parameters:
pool - The filter pool object to physically delete
Throws:
Exception

deleteAllSystemFilterPools

void deleteAllSystemFilterPools()
Delete all existing filter pools. Call this when you are about to delete this manager, say.


preTestRenameFilterPool

boolean preTestRenameFilterPool(
ISystemFilterPool pool)
                                throws 
Exception
Pre-test if we are going to run into any trouble renaming any of the files or folders used to persist a filter pool.

Returns:
true if everything seems ok, false if a file/folder is in use.
Throws:
Exception

renameSystemFilterPool

void renameSystemFilterPool(
ISystemFilterPool pool,
                            
String newName)
                            throws 
Exception
Rename a filter pool.
  • Renames pool object
  • Informs any filter pool references to this pool
  • Schedules a save of the pool object

Parameters:
pool - The filter pool object to rename
newName - The new name to give the pool
Throws:
Exception
See Also:
ISystemFilterPool.setName(String)

copySystemFilterPool

ISystemFilterPool copySystemFilterPool(
ISystemFilterPoolManager targetMgr,
                                       
ISystemFilterPool pool,
                                       
String newName)
                                       throws 
Exception
Copy the specified filter pool from this manager to this manager or another manager.

Does the following:

  • Clones all filters within the pool
  • Clones all filter strings within each filter
  • Asks target manager to save to disk
  • Calls back to target manager provider, unless callbacks are suspended

Parameters:
targetMgr - The target manager to copy our filter pool to. Can be this manager, but target pool name must be unique.
pool - The filter pool to copy
newName - The new name to give the copied pool
Returns:
the new copy of the copied system filter pool
Throws:
Exception
See Also:
ISystemFilterPool.setName(String)

copySystemFilterPools

void copySystemFilterPools(
ISystemFilterPoolManager targetMgr)
                           throws 
Exception
Copy all filter pools from this manager to another manager.

Does the following:

  • Clones all filter pools
  • Clones all filters within each pool
  • Clones all filter strings within each filter
  • Asks target manager to save to disk
  • Does not callback to caller to fire events, assumes caller doesn't want to know

Parameters:
targetMgr - The target manager to copy our filter pools to
Throws:
Exception

moveSystemFilterPool

ISystemFilterPool moveSystemFilterPool(
ISystemFilterPoolManager targetMgr,
                                       
ISystemFilterPool oldPool,
                                       
String newName)
                                       throws 
Exception
Move the specified filter pool from this manager to another manager.

Does the following:

  • Performs a copySystemFilterPool operation.
  • If copy is successful, updates all references to reference the new copy.
  • If copy is successful, deletes original filter pool in this manager
  • If this final delete fails, deletes the copied version and restore original references
  • Asks target manager to save to disk
  • Saves this manager to disk
  • Calls back to both targer manager provider and this manager provider, unless callbacks are suspended

Parameters:
targetMgr - The target manager to move our filter pool to. Cannot be this manager.
oldPool - The filter pool to move
newName - The new name to give the moved pool
Returns:
the new copy of the moved system filter pool
Throws:
Exception
See Also:
ISystemFilterPool.setName(String)

createSystemFilter

ISystemFilter createSystemFilter(
ISystemFilterContainer parent,
                                 
String aliasName,
                                 
String[] filterStrings)
                                 throws 
Exception
Creates a new system filter within the given filter container (either a filter pool, or a filter). This creates the filter, and then saves the filter pool.

Calls back to provider to inform of the event (filterEventFilterCreated)

Parameters:
parent - The parent which is either a SystemFilterPool or a SystemFilter
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.
Throws:
Exception
Since:
org.eclipse.rse.core 3.0

createSystemFilter

ISystemFilter createSystemFilter(
ISystemFilterContainer parent,
                                 
String aliasName,
                                 
List filterStrings)
                                 throws 
Exception
Creates a new system filter within the given filter container (either a filter pool, or a filter). This creates the filter, and then saves the filter pool.

Calls back to provider to inform of the event (filterEventFilterCreated)

Parameters:
parent - The parent which is either a SystemFilterPool or a SystemFilter
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.
Throws:
Exception
Since:
org.eclipse.rse.core 3.0

createSystemFilter

ISystemFilter createSystemFilter(
ISystemFilterContainer parent,
                                 
String aliasName,
                                 
String[] filterStrings,
                                 
String type)
                                 throws 
Exception
Creates a new system filter that is typed. Same as createSystemFilter(ISystemFilterContainer, String, String[]) but takes a filter type as an additional parameter.

A filter's type is an arbitrary string that is not interpreted or used by the base framework. This is for use entirely by tools who wish to support multiple types of filters and be able to launch unique actions per type, say.

Parameters:
parent - The parent which is either a SystemFilterPool or a SystemFilter
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.
type - The type of this filter
Throws:
Exception
Since:
org.eclipse.rse.core 3.0

createSystemFilter

ISystemFilter createSystemFilter(
ISystemFilterContainer parent,
                                 
String aliasName,
                                 
List filterStrings,
                                 
String type)
                                 throws 
Exception
Creates a new system filter that is typed. Same as createSystemFilter(ISystemFilterContainer, String, String[]) but takes a filter type as an additional parameter.

A filter's type is an arbitrary string that is not interpreted or used by the base framework. This is for use entirely by tools who wish to support multiple types of filters and be able to launch unique actions per type, say.

Parameters:
parent - The parent which is either a SystemFilterPool or a SystemFilter
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.
type - The type of this filter
Throws:
Exception
Since:
org.eclipse.rse.core 3.0

createSystemFilter

ISystemFilter createSystemFilter(
ISystemFilterContainer parent,
                                 
String aliasName,
                                 
String[] filterStrings,
                                 
String type,
                                 boolean promptable)
                                 throws 
Exception
Creates a new system filter that is typed and promptable Same as createSystemFilter(ISystemFilterContainer, String ,String[], String) but takes a boolean indicating if it is promptable.

A promptable filter is one in which the user is prompted for information at expand time. There is no base filter framework support for this, but tools can query this attribute and do their own thing at expand time.

Parameters:
parent - The parent which is either a SystemFilterPool or a SystemFilter
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.
type - The type of this filter
promptable - Pass true if this is a promptable filter
Throws:
Exception
Since:
org.eclipse.rse.core 3.0

createSystemFilter

ISystemFilter createSystemFilter(
ISystemFilterContainer parent,
                                 
String aliasName,
                                 
List filterStrings,
                                 
String type,
                                 boolean promptable)
                                 throws 
Exception
Creates a new system filter that is typed and promptable Same as createSystemFilter(ISystemFilterContainer, String ,String[], String) but takes a boolean indicating if it is promptable.

A promptable filter is one in which the user is prompted for information at expand time. There is no base filter framework support for this, but tools can query this attribute and do their own thing at expand time.

Parameters:
parent - The parent which is either a SystemFilterPool or a SystemFilter
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.
type - The type of this filter
promptable - Pass true if this is a promptable filter
Throws:
Exception
Since:
org.eclipse.rse.core 3.0

deleteSystemFilter

boolean deleteSystemFilter(
ISystemFilter filter)
                           throws 
Exception
Delete an existing system filter. Does the following:
  • Removes filter from its parent in memory.
  • If appropriate for the save policy, deletes the filter's file from disk.
  • Save the SystemFilterPool which direct or indirectly contains the filter.
  • Calls back to provider to inform of the event (filterEventFilterDelete)

Throws:
Exception

renameSystemFilter

void renameSystemFilter(
ISystemFilter filter,
                        
String newName)
                        throws 
Exception
Renames a filter. This is better than filter.setName(String newName) as it saves the parent pool to disk.

Does the following:

  • Renames the object in the in-memory cache
  • If appropriate for the save policy, rename's the filter's file on disk.
  • Save parent filter pool's in-memory object to disk.
  • Calls back to provider to inform of the event (filterEventFilterRenamed)

Throws:
Exception

updateSystemFilter

void updateSystemFilter(
ISystemFilter filter,
                        
String newName,
                        
String[] strings)
                        throws 
Exception
Updates a filter. This is better than doing it directly as it saves it to disk.

Does the following:

  • Updates the object in the in-memory cache
  • Save parent filter pool's in-memory object to disk.
  • Calls back to provider to inform of the event (filterEventFilterUpdated). Will be two callbacks if the name is changed ((filterEventFilterRenamed)

Throws:
Exception

setSystemFilterType

void setSystemFilterType(
ISystemFilter filter,
                         
String newType)
                         throws 
Exception
Sets a filter's type. This is better than calling filter.setType(String) directly as it saves the filter to disk after.

A filter's type is an arbitrary string that is not interpreted or used by the base framework. This is for use entirely by tools who wish to support multiple types of filters and be able to launch unique actions per type, say.

Parameters:
filter - The parent which is either a SystemFilter
newType - The type of this filter
Throws:
Exception

copySystemFilter

ISystemFilter copySystemFilter(
ISystemFilterPool targetPool,
                               
ISystemFilter oldFilter,
                               
String newName)
                               throws 
Exception
Copy a system filter to a pool in this or another filter manager.

Throws:
Exception

getSystemFilterPosition

int getSystemFilterPosition(
ISystemFilter filter)
Return the zero-based position of a SystemFilter object within its container


moveSystemFilter

ISystemFilter moveSystemFilter(
ISystemFilterPool targetPool,
                               
ISystemFilter oldFilter,
                               
String newName)
                               throws 
Exception
Move a system filter to a pool in this or another filter manager. Does this by first copying the filter, and only if successful, deleting the old copy.

Throws:
Exception

moveSystemFilters

void moveSystemFilters(
ISystemFilter[] filters,
                       int delta)
                       throws 
Exception
Move existing filters a given number of positions in the same container. If the delta is negative, they are all moved up by the given amount. If positive, they are all moved down by the given amount.

Does the following:

  • After the move, the pool containing the filter is saved to disk.
  • Calls back to provider to inform of the event (filterEventFiltersRePositioned)

Parameters:
filters - Array of SystemFilters to move.
delta - the amount by which to move the filters
Throws:
Exception

orderSystemFilters

void orderSystemFilters(
ISystemFilterPool pool,
                        
String[] names)
                        throws 
Exception
Order filters according to user preferences.

While the framework has all the code necessary to arrange filters and save/restore that arrangement, you may choose to use preferences instead of this support. In this case, call this method and pass in the saved and sorted filter name list.

Called by someone after restore.

Throws:
Exception

addSystemFilterString

ISystemFilterString addSystemFilterString(
ISystemFilter filter,
                                          
String newString)
                                          throws 
Exception
Append a new filter string to the given filter's list

Does the following:

  • Adds the filter string to the in-memory cache
  • Saves parent filter pool to disk.
  • Calls back to provider to inform it of this event (filterEventFilterStringCreated)

Throws:
Exception

addSystemFilterString

ISystemFilterString addSystemFilterString(
ISystemFilter filter,
                                          
String newString,
                                          int position)
                                          throws 
Exception
Insert a new filter string to the given filter's list, at the given zero-based position

Does the following:

  • Adds the filter string to the in-memory cache
  • Saves parent filter pool to disk.
  • Calls back to provider to inform it of this event (filterEventFilterStringCreated)

Throws:
Exception

removeSystemFilterString

boolean removeSystemFilterString(
ISystemFilter filter,
                                 
ISystemFilterString filterString)
                                 throws 
Exception
Remove a filter string from this filter's list, given its SystemFilterString object.

Does the following:

  • Removes the filter string from the in-memory cache
  • Saves parent filter pool to disk.
  • Calls back to provider to inform it of this event (filterEventFilterStringDeleted)

Returns:
true if the given string existed and hence was deleted.
Throws:
Exception

removeSystemFilterString

boolean removeSystemFilterString(
ISystemFilter filter,
                                 
String oldString)
                                 throws 
Exception
Delete a filter string from the given filter's list

Does the following:

  • Removes the filter string from the in-memory cache
  • Saves parent filter pool to disk.
  • Calls back to provider to inform it of this event (filterEventFilterStringDeleted)

Returns:
true if given string was found and hence was deleted.
Throws:
Exception

removeSystemFilterString

boolean removeSystemFilterString(
ISystemFilter filter,
                                 int position)
                                 throws 
Exception
Remove a filter string from the given filter's list, given its zero-based position

Does the following:

  • Removes the filter string from the in-memory cache
  • Saves parent filter pool to disk.
  • Calls back to provider to inform it of this event (filterEventFilterStringDeleted)

Returns:
true if a string existed at the given position and hence was deleted.
Throws:
Exception

updateSystemFilterString

void updateSystemFilterString(
ISystemFilterString filterString,
                              
String newValue)
                              throws 
Exception
Update a filter string's string vale

Does the following:

  • Update the filter string in the in-memory cache
  • Saves parent filter pool to disk.
  • Calls back to provider to inform it of this event (filterEventFilterStringUpdated)

Throws:
Exception

getSystemFilterStringPosition

int getSystemFilterStringPosition(
ISystemFilterString filterString)
Return the zero-based position of a SystemFilterString object within its filter


copySystemFilterString

ISystemFilterString copySystemFilterString(
ISystemFilter targetFilter,
                                           
ISystemFilterString oldFilterString)
                                           throws 
Exception
Copy a system filter string to a filter in this or another filter pool manager.

Throws:
Exception

moveSystemFilterString

ISystemFilterString moveSystemFilterString(
ISystemFilter targetFilter,
                                           
ISystemFilterString oldFilterString)
                                           throws 
Exception
Move a system filter string to a filter in this or another filter pool manager. Does this by doing a copy operation, then if successful doing a delete operation.

Throws:
Exception

moveSystemFilterStrings

void moveSystemFilterStrings(
ISystemFilterString[] filterStrings,
                             int delta)
                             throws 
Exception
Move existing filter strings a given number of positions in the same filter If the delta is negative, they are all moved up by the given amount. If positive, they are all moved down by the given amount.

Does the following:

  • After the move, the filter pool containing the filter containing the filter strings is saved to disk.
  • Calls back to provider to inform of the event (filterEventFilterStringsRePositioned)

Parameters:
filterStrings - Array of SystemFilterStrings to move.
delta - the amount by which to move the filters
Throws:
Exception

suspendCallbacks

void suspendCallbacks(boolean suspend)
Suspend callbacks to the provider


isSupportsNestedFilters

boolean isSupportsNestedFilters()
Returns:
The value of the SupportsNestedFilters attribute

setStringsCaseSensitive

void setStringsCaseSensitive(boolean value)
Parameters:
value - The new value of the StringsCaseSensitive attribute

isSupportsDuplicateFilterStrings

boolean isSupportsDuplicateFilterStrings()
Returns:
The value of the SupportsDuplicateFilterStrings attribute

unsetSupportsDuplicateFilterStrings

void unsetSupportsDuplicateFilterStrings()

isSetSupportsDuplicateFilterStrings

boolean isSetSupportsDuplicateFilterStrings()
Returns:
true if the SupportsDuplicateFilterStrings attribute has been set

isSingleFilterStringOnly

boolean isSingleFilterStringOnly()
Returns the value of the ' Single Filter String Only ' attribute.

If the meaning of the 'Single Filter String Only' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Single Filter String Only' attribute.
See Also:
setSingleFilterStringOnly(boolean)

setSingleFilterStringOnly

void setSingleFilterStringOnly(boolean value)
Sets the value of the ' Single Filter String Only' attribute.

Parameters:
value - the new value of the 'Single Filter String Only' attribute.
See Also:
isSingleFilterStringOnly()

RSE
Release 3.0

Copyright (c) IBM Corporation and others 2000, 2008. All Rights Reserved.

 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire