|
RSE Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ISystemFilterPoolManager
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 |
---|
ISystemFilterPoolManagerProvider getProvider()
ISystemProfile getSystemProfile()
void setProvider(ISystemFilterPoolManagerProvider caller)
void setSystemFilterPoolManagerData(Object data)
Object getSystemFilterPoolManagerData()
String getName()
void setName(String name)
boolean supportsNestedFilters()
boolean supportsDuplicateFilterStrings()
void setSupportsNestedFilters(boolean supports)
void setSupportsDuplicateFilterStrings(boolean supports)
boolean isStringsCaseSensitive()
boolean areStringsCaseSensitive()
boolean wasRestored()
wasRestored
in interface IRSEPersistableContainer
String[] getSystemFilterPoolNames()
ISystemFilterPool[] getSystemFilterPools()
ISystemFilterPool getSystemFilterPool(String name)
ISystemFilterPool getFirstDefaultSystemFilterPool()
ISystemFilterPool createSystemFilterPool(String name, boolean isDeletable) throws Exception
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.
Exception
ISystemFilterPool.setName(String)
void deleteSystemFilterPool(ISystemFilterPool pool) throws Exception
Does the following:
pool
- The filter pool object to physically delete
Exception
void deleteAllSystemFilterPools()
boolean preTestRenameFilterPool(ISystemFilterPool pool) throws Exception
Exception
void renameSystemFilterPool(ISystemFilterPool pool, String newName) throws Exception
pool
- The filter pool object to renamenewName
- The new name to give the pool
Exception
ISystemFilterPool.setName(String)
ISystemFilterPool copySystemFilterPool(ISystemFilterPoolManager targetMgr, ISystemFilterPool pool, String newName) throws Exception
Does the following:
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 copynewName
- The new name to give the copied pool
Exception
ISystemFilterPool.setName(String)
void copySystemFilterPools(ISystemFilterPoolManager targetMgr) throws Exception
Does the following:
targetMgr
- The target manager to copy our filter pools to
Exception
ISystemFilterPool moveSystemFilterPool(ISystemFilterPoolManager targetMgr, ISystemFilterPool oldPool, String newName) throws Exception
Does the following:
copySystemFilterPool
operation.
targetMgr
- The target manager to move our filter pool to. Cannot be this manager.oldPool
- The filter pool to movenewName
- The new name to give the moved pool
Exception
ISystemFilterPool.setName(String)
ISystemFilter createSystemFilter(ISystemFilterContainer parent, String aliasName, String[] filterStrings) throws Exception
Calls back to provider to inform of the event (filterEventFilterCreated)
parent
- The parent which is either a SystemFilterPool or a
SystemFilteraliasName
- The name to give the new filter. Must be unique for this
pool.filterStrings
- The list of String objects that represent the filter
strings.
Exception
ISystemFilter createSystemFilter(ISystemFilterContainer parent, String aliasName, List filterStrings) throws Exception
Calls back to provider to inform of the event (filterEventFilterCreated)
parent
- The parent which is either a SystemFilterPool or a
SystemFilteraliasName
- The name to give the new filter. Must be unique for this
pool.filterStrings
- The list of String objects that represent the filter
strings.
Exception
ISystemFilter createSystemFilter(ISystemFilterContainer parent, String aliasName, String[] filterStrings, String type) throws Exception
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.
parent
- The parent which is either a SystemFilterPool or a
SystemFilteraliasName
- 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
Exception
ISystemFilter createSystemFilter(ISystemFilterContainer parent, String aliasName, List filterStrings, String type) throws Exception
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.
parent
- The parent which is either a SystemFilterPool or a
SystemFilteraliasName
- 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
Exception
ISystemFilter createSystemFilter(ISystemFilterContainer parent, String aliasName, String[] filterStrings, String type, boolean promptable) throws Exception
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.
parent
- The parent which is either a SystemFilterPool or a
SystemFilteraliasName
- 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 filterpromptable
- Pass true if this is a promptable filter
Exception
ISystemFilter createSystemFilter(ISystemFilterContainer parent, String aliasName, List filterStrings, String type, boolean promptable) throws Exception
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.
parent
- The parent which is either a SystemFilterPool or a
SystemFilteraliasName
- 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 filterpromptable
- Pass true if this is a promptable filter
Exception
boolean deleteSystemFilter(ISystemFilter filter) throws Exception
Exception
void renameSystemFilter(ISystemFilter filter, String newName) throws Exception
Does the following:
Exception
void updateSystemFilter(ISystemFilter filter, String newName, String[] strings) throws Exception
Does the following:
Exception
void setSystemFilterType(ISystemFilter filter, String newType) throws Exception
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.
filter
- The parent which is either a SystemFilternewType
- The type of this filter
Exception
ISystemFilter copySystemFilter(ISystemFilterPool targetPool, ISystemFilter oldFilter, String newName) throws Exception
Exception
int getSystemFilterPosition(ISystemFilter filter)
ISystemFilter moveSystemFilter(ISystemFilterPool targetPool, ISystemFilter oldFilter, String newName) throws Exception
Exception
void moveSystemFilters(ISystemFilter[] filters, int delta) throws Exception
Does the following:
filters
- Array of SystemFilters to move.delta
- the amount by which to move the filters
Exception
void orderSystemFilters(ISystemFilterPool pool, String[] names) throws Exception
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.
Exception
ISystemFilterString addSystemFilterString(ISystemFilter filter, String newString) throws Exception
Does the following:
Exception
ISystemFilterString addSystemFilterString(ISystemFilter filter, String newString, int position) throws Exception
Does the following:
Exception
boolean removeSystemFilterString(ISystemFilter filter, ISystemFilterString filterString) throws Exception
Does the following:
Exception
boolean removeSystemFilterString(ISystemFilter filter, String oldString) throws Exception
Does the following:
Exception
boolean removeSystemFilterString(ISystemFilter filter, int position) throws Exception
Does the following:
Exception
void updateSystemFilterString(ISystemFilterString filterString, String newValue) throws Exception
Does the following:
Exception
int getSystemFilterStringPosition(ISystemFilterString filterString)
ISystemFilterString copySystemFilterString(ISystemFilter targetFilter, ISystemFilterString oldFilterString) throws Exception
Exception
ISystemFilterString moveSystemFilterString(ISystemFilter targetFilter, ISystemFilterString oldFilterString) throws Exception
Exception
void moveSystemFilterStrings(ISystemFilterString[] filterStrings, int delta) throws Exception
Does the following:
filterStrings
- Array of SystemFilterStrings to move.delta
- the amount by which to move the filters
Exception
void suspendCallbacks(boolean suspend)
boolean isSupportsNestedFilters()
void setStringsCaseSensitive(boolean value)
value
- The new value of the StringsCaseSensitive attributeboolean isSupportsDuplicateFilterStrings()
void unsetSupportsDuplicateFilterStrings()
boolean isSetSupportsDuplicateFilterStrings()
boolean isSingleFilterStringOnly()
If the meaning of the 'Single Filter String Only' attribute isn't clear, there really should be more of a description here...
setSingleFilterStringOnly(boolean)
void setSingleFilterStringOnly(boolean value)
Single Filter String Only
' attribute.
value
- the new value of the 'Single Filter String Only' attribute.isSingleFilterStringOnly()
|
RSE Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |