|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Field Summary | |
---|---|
static String |
copyright
|
Method Summary | |
---|---|
SystemFilterString |
addSystemFilterString(SystemFilter 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. |
SystemFilterString |
addSystemFilterString(SystemFilter 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()
|
SystemFilter |
copySystemFilter(SystemFilterPool targetPool,
SystemFilter oldFilter,
String newName)
Copy a system filter to a pool in this or another filter manager. |
SystemFilterPool |
copySystemFilterPool(SystemFilterPoolManager targetMgr,
SystemFilterPool pool,
String newName)
Copy the specified filter pool from this manager to this manager or another manager. |
void |
copySystemFilterPools(SystemFilterPoolManager targetMgr)
Copy all filter pools from this manager to another manager. |
SystemFilterString |
copySystemFilterString(SystemFilter targetFilter,
SystemFilterString oldFilterString)
Copy a system filter string to a filter in this or another filter pool manager. |
SystemFilter |
createSystemFilter(SystemFilterContainer parent,
String aliasName,
Vector filterStrings)
Creates a new system filter within the given filter container (either a filter pool, or a filter). |
SystemFilter |
createSystemFilter(SystemFilterContainer parent,
String aliasName,
Vector filterStrings,
String type)
Creates a new system filter that is typed. |
SystemFilter |
createSystemFilter(SystemFilterContainer parent,
String aliasName,
Vector filterStrings,
String type,
boolean promptable)
Creates a new system filter that is typed and promptable Same as createSystemFilter(SystemFilterContainer, String ,Vector, String) but
takes a boolean indicating if it is promptable.
|
SystemFilterPool |
createSystemFilterPool(String name,
boolean isDeletable)
Create a new filter pool. |
void |
deleteAllSystemFilterPools()
Delete all existing filter pools. |
boolean |
deleteSystemFilter(SystemFilter filter)
Delete an existing system filter. |
void |
deleteSystemFilterPool(SystemFilterPool pool)
Delete a given filter pool. |
SystemFilterPool |
getFirstDefaultSystemFilterPool()
Return the first pool that has the default attribute set to true. |
IFolder |
getFolder()
Return the folder that this manager is contained in. |
String |
getName()
Return the name of this manager. |
SystemFilterNamingPolicy |
getNamingPolicy()
Get the naming policy currently used when saving data to disk. |
EList |
getPools()
|
SystemFilterPoolManagerProvider |
getProvider()
Return the caller which instantiated the filter pool manager |
SystemFilterPool |
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. |
Vector |
getSystemFilterPoolNamesVector()
Get vector of filter pool names currently existing. |
SystemFilterPool[] |
getSystemFilterPools()
Return array of SystemFilterPools managed by this manager. |
int |
getSystemFilterPosition(SystemFilter filter)
Return the zero-based position of a SystemFilter object within its container |
int |
getSystemFilterStringPosition(SystemFilterString filterString)
Return the zero-based position of a SystemFilterString object within its filter |
boolean |
isSetSupportsDuplicateFilterStrings()
|
boolean |
isSingleFilterStringOnly()
Returns the value of the 'Single Filter String Only' attribute |
boolean |
isStringsCaseSensitive()
|
boolean |
isSupportsDuplicateFilterStrings()
|
boolean |
isSupportsNestedFilters()
|
SystemFilter |
moveSystemFilter(SystemFilterPool targetPool,
SystemFilter oldFilter,
String newName)
Move a system filter to a pool in this or another filter manager. |
SystemFilterPool |
moveSystemFilterPool(SystemFilterPoolManager targetMgr,
SystemFilterPool oldPool,
String newName)
Move the specified filter pool from this manager to another manager. |
void |
moveSystemFilters(SystemFilter[] filters,
int delta)
Move existing filters a given number of positions in the same container. |
SystemFilterString |
moveSystemFilterString(SystemFilter targetFilter,
SystemFilterString oldFilterString)
Move a system filter string to a filter in this or another filter pool manager. |
void |
moveSystemFilterStrings(SystemFilterString[] 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(SystemFilterPool pool,
String[] names)
Order filters according to user preferences. |
boolean |
preTestRenameFilterPool(SystemFilterPool 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(SystemFilter 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(SystemFilter 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. |
boolean |
removeSystemFilterString(SystemFilter filter,
SystemFilterString filterString)
Remove a filter string from this filter's list, given its SystemFilterString object. |
void |
renameSystemFilter(SystemFilter filter,
String newName)
Renames a filter. |
void |
renameSystemFilterPool(SystemFilterPool pool,
String newName)
Rename a given filter pool. |
void |
resetManagerFolder(IFolder newFolder)
Reset the manager folder |
void |
save()
Save all the filter pools to disk. |
void |
save(SystemFilterPool pool)
Save the given filter pool to disk. |
void |
setName(String name)
Set the name of this manager. |
void |
setNamingPolicy(SystemFilterNamingPolicy namingPolicy)
Set the naming policy used when saving data to disk. |
void |
setProvider(SystemFilterPoolManagerProvider 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(SystemFilter 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(SystemFilter filter,
String newName,
String[] strings)
Updates a filter. |
void |
updateSystemFilterString(SystemFilterString 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 |
Field Detail |
public static final String copyright
Method Detail |
public SystemFilterPoolManagerProvider getProvider()
public void setProvider(SystemFilterPoolManagerProvider caller)
public void setSystemFilterPoolManagerData(Object data)
public Object getSystemFilterPoolManagerData()
public void setNamingPolicy(SystemFilterNamingPolicy namingPolicy)
SystemFilterNamingPolicy
public SystemFilterNamingPolicy getNamingPolicy()
SystemFilterNamingPolicy
public void resetManagerFolder(IFolder newFolder)
public String getName()
public void setName(String name)
public boolean supportsNestedFilters()
public boolean supportsDuplicateFilterStrings()
public void setSupportsNestedFilters(boolean supports)
public void setSupportsDuplicateFilterStrings(boolean supports)
public boolean isStringsCaseSensitive()
public boolean areStringsCaseSensitive()
public boolean wasRestored()
public String[] getSystemFilterPoolNames()
public Vector getSystemFilterPoolNamesVector()
public SystemFilterPool[] getSystemFilterPools()
public SystemFilterPool getSystemFilterPool(String name)
public SystemFilterPool getFirstDefaultSystemFilterPool()
public SystemFilterPool 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
public void deleteSystemFilterPool(SystemFilterPool pool) throws Exception
Does the following:
pool
- The filter pool object to physically delete
Exception
public void deleteAllSystemFilterPools()
public boolean preTestRenameFilterPool(SystemFilterPool pool) throws Exception
Exception
public void renameSystemFilterPool(SystemFilterPool pool, String newName) throws Exception
Does the following:
pool
- The filter pool object to physically renamenewName
- The new name to give the pool
Exception
public SystemFilterPool copySystemFilterPool(SystemFilterPoolManager targetMgr, SystemFilterPool 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
public void copySystemFilterPools(SystemFilterPoolManager targetMgr) throws Exception
Does the following:
targetMgr
- The target manager to copy our filter pools to
Exception
public SystemFilterPool moveSystemFilterPool(SystemFilterPoolManager targetMgr, SystemFilterPool 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
public SystemFilter createSystemFilter(SystemFilterContainer parent, String aliasName, Vector 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
public SystemFilter createSystemFilter(SystemFilterContainer parent, String aliasName, Vector filterStrings, String type) throws Exception
createSystemFilter(SystemFilterContainer, String, Vector)
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
public SystemFilter createSystemFilter(SystemFilterContainer parent, String aliasName, Vector filterStrings, String type, boolean promptable) throws Exception
createSystemFilter(SystemFilterContainer, String ,Vector, 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
public boolean deleteSystemFilter(SystemFilter filter) throws Exception
Exception
public void renameSystemFilter(SystemFilter filter, String newName) throws Exception
Does the following:
Exception
public void updateSystemFilter(SystemFilter filter, String newName, String[] strings) throws Exception
Does the following:
Exception
public void setSystemFilterType(SystemFilter 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.
Exception
public SystemFilter copySystemFilter(SystemFilterPool targetPool, SystemFilter oldFilter, String newName) throws Exception
Exception
public int getSystemFilterPosition(SystemFilter filter)
public SystemFilter moveSystemFilter(SystemFilterPool targetPool, SystemFilter oldFilter, String newName) throws Exception
Exception
public void moveSystemFilters(SystemFilter[] filters, int delta) throws Exception
Does the following:
filters
- Array of SystemFilters to move.
Exception
public void orderSystemFilters(SystemFilterPool 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
public SystemFilterString addSystemFilterString(SystemFilter filter, String newString) throws Exception
Does the following:
Exception
public SystemFilterString addSystemFilterString(SystemFilter filter, String newString, int position) throws Exception
Does the following:
Exception
public boolean removeSystemFilterString(SystemFilter filter, SystemFilterString filterString) throws Exception
Does the following:
Exception
public boolean removeSystemFilterString(SystemFilter filter, String oldString) throws Exception
Does the following:
Exception
public boolean removeSystemFilterString(SystemFilter filter, int position) throws Exception
Does the following:
Exception
public void updateSystemFilterString(SystemFilterString filterString, String newValue) throws Exception
Does the following:
Exception
public int getSystemFilterStringPosition(SystemFilterString filterString)
public SystemFilterString copySystemFilterString(SystemFilter targetFilter, SystemFilterString oldFilterString) throws Exception
Exception
public SystemFilterString moveSystemFilterString(SystemFilter targetFilter, SystemFilterString oldFilterString) throws Exception
Exception
public void moveSystemFilterStrings(SystemFilterString[] filterStrings, int delta) throws Exception
Does the following:
filterStrings
- Array of SystemFilterStrings to move.
Exception
public void suspendCallbacks(boolean suspend)
public void save() throws Exception
Exception
public void save(SystemFilterPool pool) throws Exception
Exception
public IFolder getFolder()
public boolean isSupportsNestedFilters()
public void setStringsCaseSensitive(boolean value)
value
- The new value of the StringsCaseSensitive attributepublic EList getPools()
public boolean isSupportsDuplicateFilterStrings()
public void unsetSupportsDuplicateFilterStrings()
public boolean isSetSupportsDuplicateFilterStrings()
public 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)
,
FiltersPackage.getSystemFilterPoolManager_SingleFilterStringOnly()
public void setSingleFilterStringOnly(boolean value)
Single Filter String Only
' attribute.
value
- the new value of the 'Single Filter String Only' attribute.isSingleFilterStringOnly()
|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |