|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectEObjectImpl
com.ibm.etools.systems.filters.impl.SystemFilterPoolManagerImpl
Field Summary | |
---|---|
static String |
copyright
|
static boolean |
debug
|
protected String |
name
|
protected static String |
NAME_EDEFAULT
The default value of the ' Name ' attribute |
protected EList |
pools
|
protected static boolean |
SINGLE_FILTER_STRING_ONLY_EDEFAULT
The default value of the ' Single Filter String Only ' attribute |
protected boolean |
singleFilterStringOnly
The cached value of the ' Single Filter String Only ' attribute |
protected static boolean |
STRINGS_CASE_SENSITIVE_EDEFAULT
The default value of the ' Strings Case Sensitive ' attribute |
protected boolean |
stringsCaseSensitive
|
protected static boolean |
SUPPORTS_DUPLICATE_FILTER_STRINGS_EDEFAULT
The default value of the ' Supports Duplicate Filter Strings ' attribute |
protected static boolean |
SUPPORTS_NESTED_FILTERS_EDEFAULT
The default value of the ' Supports Nested Filters ' attribute |
protected boolean |
supportsDuplicateFilterStrings
|
protected boolean |
supportsDuplicateFilterStringsESet
This is true if the Supports Duplicate Filter Strings attribute has been set |
protected boolean |
supportsNestedFilters
|
Constructor Summary | |
---|---|
protected |
SystemFilterPoolManagerImpl()
Constructor |
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 its filters' 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()
Same as isStringsCaseSensitive() Are filter strings in this filter case sensitive? |
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 oldPool,
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. |
protected static SystemFilterPoolManagerImpl |
createManager()
|
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 poolName,
boolean isDeletable)
Create a new filter pool. |
static SystemFilterPoolManager |
createSystemFilterPoolManager(Logger logger,
SystemFilterPoolManagerProvider caller,
IFolder mgrFolder,
String name,
boolean allowNestedFilters,
int savePolicy,
SystemFilterNamingPolicy namingPolicy)
Factory to create a filter pool manager. |
protected Vector |
deducePoolNames()
Private helper method to deduce filter pool folder names. |
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. |
protected String |
derivePoolFolderName(String poolName)
Derive and return the unqualified folder name for a filter pool, given the pool's name. |
Object |
eGet(EStructuralFeature eFeature,
boolean resolve)
|
boolean |
eIsSet(EStructuralFeature eFeature)
|
void |
eSet(EStructuralFeature eFeature,
Object newValue)
|
protected EClass |
eStaticClass()
|
void |
eUnset(EStructuralFeature eFeature)
|
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. |
static String |
getFolderPath(IFolder folder)
Return the path of the given folder |
Logger |
getLogger()
Return our logger |
SystemMOFHelpers |
getMOFHelpers()
Return mof helpers instance. |
static SystemMOFHelpers |
getMOFHelpers(Logger logger)
Return mof helpers instance given a logging object |
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 |
protected static String |
getRootSaveFileName(SystemFilterNamingPolicy namingPolicy,
String managerName)
Return the root save file name without the extension .xmi |
protected static String |
getRootSaveFileName(SystemFilterPoolManager manager)
Return the root save file name without the extension .xmi |
IFile |
getSaveFile(SystemFilterPool pool)
Return the save file that will be written for the given filter pool. |
protected static String |
getSaveFileName(SystemMOFHelpers mofHelpers,
SystemFilterPoolManager manager)
Return the unqualified save file name with the extension .xmi |
SystemFilterPool |
getSystemFilterPool(String name)
Given a filter pool name, return that filter pool object. |
Object |
getSystemFilterPoolManagerData()
Return transient data set via setFilterPoolData. |
String[] |
getSystemFilterPoolNames()
Get list of filter pool names currently existing. |
Vector |
getSystemFilterPoolNamesVector()
Get list 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 |
protected void |
initialize(Logger logger,
SystemFilterPoolManagerProvider caller,
IFolder folder,
String name,
boolean allowNestedFilters,
int savePolicy,
SystemFilterNamingPolicy namingPolicy)
|
protected void |
initialize(Logger logger,
SystemFilterPoolManagerProvider caller,
IFolder folder,
String name,
int savePolicy,
SystemFilterNamingPolicy namingPolicy)
|
boolean |
isSetSupportsDuplicateFilterStrings()
|
boolean |
isSingleFilterStringOnly()
|
boolean |
isStringsCaseSensitive()
|
boolean |
isSupportsDuplicateFilterStrings()
|
boolean |
isSupportsNestedFilters()
|
void |
logDebugMessage(String prefix,
String message)
Helper method for logging debug messages |
void |
logError(String message,
Throwable exception)
Helper method for logging errors (exceptions) |
void |
logInfo(String message)
Helper method for logging information |
void |
logMessage(String msg)
Deprecated. Use either logInfo, logWarning, logError, or logDebugMessage. This method now calls logInfo. |
void |
logWarning(String message)
Helper method for logging warnings |
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 |
static SystemFilterPoolManager |
restore(Logger logger,
SystemFilterPoolManagerProvider caller,
IFolder mgrFolder,
String name,
int savePolicy)
Restore the filter pools from disk, assuming default for prefix of name. |
static SystemFilterPoolManager |
restore(Logger logger,
SystemFilterPoolManagerProvider caller,
IFolder mgrFolder,
String name,
int savePolicy,
SystemFilterNamingPolicy namingPolicy)
Restore the filter pools from disk. |
protected static SystemFilterPoolManager |
restoreFromOneFile(Logger logger,
IFolder mgrFolder,
String name,
SystemFilterNamingPolicy namingPolicy)
Restore filter pools when all are stored in one file |
void |
save()
Save all the filter pools to disk. |
void |
save(SystemFilterPool pool)
Save the given filter pool to disk. |
protected void |
saveToOneFile()
Save this object to disk, into a single file. |
protected void |
setFilterPoolManager()
Set transient variable pointing back to us. |
void |
setLogger(Logger logger)
Set our logger |
void |
setName(String name)
Set the name of this manager. |
void |
setNameGen(String newName)
|
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 newSingleFilterStringOnly)
|
void |
setStringsCaseSensitive(boolean newStringsCaseSensitive)
Set attribute indicating if filters managed by this manager support case-sensitive filter strings, by default. |
void |
setStringsCaseSensitiveGen(boolean newStringsCaseSensitive)
|
void |
setSupportsDuplicateFilterStrings(boolean newSupportsDuplicateFilterStrings)
Set attribute indicating if filters managed by this manager support duplicate filter strings, by default. |
void |
setSupportsDuplicateFilterStringsGen(boolean newSupportsDuplicateFilterStrings)
|
void |
setSupportsNestedFilters(boolean newSupportsNestedFilters)
Set attribute indicating if filter pools managed by this manager support nested filters, by default. |
void |
setSupportsNestedFiltersGen(boolean newSupportsNestedFilters)
|
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 |
String |
toString()
|
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 |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static boolean debug
public static final String copyright
protected static final String NAME_EDEFAULT
Name
' attribute.
getName()
protected String name
protected static final boolean SUPPORTS_NESTED_FILTERS_EDEFAULT
Supports Nested Filters
' attribute.
isSupportsNestedFilters()
,
Constant Field Valuesprotected boolean supportsNestedFilters
protected static final boolean STRINGS_CASE_SENSITIVE_EDEFAULT
Strings Case Sensitive
' attribute.
isStringsCaseSensitive()
,
Constant Field Valuesprotected boolean stringsCaseSensitive
protected static final boolean SUPPORTS_DUPLICATE_FILTER_STRINGS_EDEFAULT
Supports Duplicate Filter Strings
' attribute.
isSupportsDuplicateFilterStrings()
,
Constant Field Valuesprotected boolean supportsDuplicateFilterStrings
protected boolean supportsDuplicateFilterStringsESet
protected static final boolean SINGLE_FILTER_STRING_ONLY_EDEFAULT
Single Filter String Only
' attribute.
isSingleFilterStringOnly()
,
Constant Field Valuesprotected boolean singleFilterStringOnly
Single Filter String Only
' attribute.
isSingleFilterStringOnly()
protected EList pools
Constructor Detail |
protected SystemFilterPoolManagerImpl()
Method Detail |
protected EClass eStaticClass()
public static SystemFilterPoolManager createSystemFilterPoolManager(Logger logger, SystemFilterPoolManagerProvider caller, IFolder mgrFolder, String name, boolean allowNestedFilters, int savePolicy, SystemFilterNamingPolicy namingPolicy)
logger
- A logging object into which to log errors as they happen in the frameworkcaller
- Objects which instantiate this class should implement the
SystemFilterPoolManagerProvider interface, and pass "this" for this parameter.
Given any filter framework object, it is possible to retrieve the caller's
object via the getProvider method call.mgrFolder
- the folder that will be the manager folder. This is
the parent of the filter pool folders the manager folder will hold, or the single
xmi file for the save policy of one file per manager. This folder will be created
if it does not already exist.name
- the name of the filter pool manager. Typically this is also the name
of the given folder, but this is not required. For the save policy of one file
per manager, the name of the file is derived from this. For other save policies,
the name is not used.allowNestedFilters
- true if filters inside filter pools in this manager are
to allow nested filters. This is the default, but can be overridden at the
individual filter pool level.savePolicy
- The save policy for the filter pools and filters. One of the
following constants from the
SystemFilterConstants
interface:
namingPolicy
- The names to use for file and folders when persisting to disk. Pass
null to just use the defaults, or if using SAVE_POLICY_NONE.protected static SystemFilterPoolManagerImpl createManager()
protected void initialize(Logger logger, SystemFilterPoolManagerProvider caller, IFolder folder, String name, boolean allowNestedFilters, int savePolicy, SystemFilterNamingPolicy namingPolicy)
protected void initialize(Logger logger, SystemFilterPoolManagerProvider caller, IFolder folder, String name, int savePolicy, SystemFilterNamingPolicy namingPolicy)
protected Vector deducePoolNames()
public boolean wasRestored()
wasRestored
in interface SystemFilterPoolManager
public SystemFilterPoolManagerProvider getProvider()
getProvider
in interface SystemFilterPoolManager
public void setProvider(SystemFilterPoolManagerProvider caller)
setProvider
in interface SystemFilterPoolManager
public void setNamingPolicy(SystemFilterNamingPolicy namingPolicy)
setNamingPolicy
in interface SystemFilterPoolManager
SystemFilterNamingPolicy
public SystemFilterNamingPolicy getNamingPolicy()
getNamingPolicy
in interface SystemFilterPoolManager
SystemFilterNamingPolicy
public void setName(String name)
setName
in interface SystemFilterPoolManager
public boolean supportsNestedFilters()
supportsNestedFilters
in interface SystemFilterPoolManager
public boolean supportsDuplicateFilterStrings()
supportsDuplicateFilterStrings
in interface SystemFilterPoolManager
public void setSupportsNestedFilters(boolean newSupportsNestedFilters)
setSupportsNestedFilters
in interface SystemFilterPoolManager
public void setSupportsDuplicateFilterStrings(boolean newSupportsDuplicateFilterStrings)
setSupportsDuplicateFilterStrings
in interface SystemFilterPoolManager
public void setSupportsDuplicateFilterStringsGen(boolean newSupportsDuplicateFilterStrings)
public boolean isStringsCaseSensitive()
isStringsCaseSensitive
in interface SystemFilterPoolManager
public boolean areStringsCaseSensitive()
areStringsCaseSensitive
in interface SystemFilterPoolManager
public void setStringsCaseSensitive(boolean newStringsCaseSensitive)
setStringsCaseSensitive
in interface SystemFilterPoolManager
newStringsCaseSensitive
- The new value of the StringsCaseSensitive attributepublic void setStringsCaseSensitiveGen(boolean newStringsCaseSensitive)
protected void setFilterPoolManager()
public void setSystemFilterPoolManagerData(Object data)
setSystemFilterPoolManagerData
in interface SystemFilterPoolManager
public Object getSystemFilterPoolManagerData()
getSystemFilterPoolManagerData
in interface SystemFilterPoolManager
public SystemFilterPool[] getSystemFilterPools()
getSystemFilterPools
in interface SystemFilterPoolManager
public String[] getSystemFilterPoolNames()
getSystemFilterPoolNames
in interface SystemFilterPoolManager
public Vector getSystemFilterPoolNamesVector()
getSystemFilterPoolNamesVector
in interface SystemFilterPoolManager
public SystemFilterPool createSystemFilterPool(String poolName, 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.
Calls back to inform provider of this event
createSystemFilterPool
in interface SystemFilterPoolManager
Exception
public void deleteSystemFilterPool(SystemFilterPool pool) throws Exception
Does the following:
deleteSystemFilterPool
in interface SystemFilterPoolManager
pool
- The filter pool object to physically delete
Exception
public void deleteAllSystemFilterPools()
deleteAllSystemFilterPools
in interface SystemFilterPoolManager
public boolean preTestRenameFilterPool(SystemFilterPool pool) throws Exception
preTestRenameFilterPool
in interface SystemFilterPoolManager
Exception
public void renameSystemFilterPool(SystemFilterPool pool, String newName) throws Exception
Does the following:
renameSystemFilterPool
in interface SystemFilterPoolManager
pool
- The filter pool object to physically renamenewName
- The new name to give the pool
Exception
public SystemFilterPool copySystemFilterPool(SystemFilterPoolManager targetMgr, SystemFilterPool oldPool, String newName) throws Exception
Does the following:
copySystemFilterPool
in interface SystemFilterPoolManager
targetMgr
- The target manager to copy our filter pool to. Can be this manager, but target pool name must be unique.oldPool
- The filter pool to copynewName
- The new name to give the copied pool
Exception
public SystemFilterPool moveSystemFilterPool(SystemFilterPoolManager targetMgr, SystemFilterPool oldPool, String newName) throws Exception
Does the following:
copySystemFilterPool
operation.
moveSystemFilterPool
in interface SystemFilterPoolManager
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 void copySystemFilterPools(SystemFilterPoolManager targetMgr) throws Exception
Does the following:
copySystemFilterPools
in interface SystemFilterPoolManager
targetMgr
- The target manager to copy our filter pools to
Exception
public SystemFilterPool getSystemFilterPool(String name)
getSystemFilterPool
in interface SystemFilterPoolManager
public SystemFilterPool getFirstDefaultSystemFilterPool()
getFirstDefaultSystemFilterPool
in interface SystemFilterPoolManager
public SystemFilter createSystemFilter(SystemFilterContainer parent, String aliasName, Vector filterStrings) throws Exception
Calls back to inform provider of this event (filterEventFilterCreated)
createSystemFilter
in interface SystemFilterPoolManager
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.
createSystemFilter
in interface SystemFilterPoolManager
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.
createSystemFilter
in interface SystemFilterPoolManager
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
deleteSystemFilter
in interface SystemFilterPoolManager
Exception
public void renameSystemFilter(SystemFilter filter, String newName) throws Exception
Does the following:
renameSystemFilter
in interface SystemFilterPoolManager
Exception
public void updateSystemFilter(SystemFilter filter, String newName, String[] strings) throws Exception
Does the following:
updateSystemFilter
in interface SystemFilterPoolManager
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.
setSystemFilterType
in interface SystemFilterPoolManager
Exception
public SystemFilter copySystemFilter(SystemFilterPool targetPool, SystemFilter oldFilter, String newName) throws Exception
copySystemFilter
in interface SystemFilterPoolManager
Exception
public SystemFilter moveSystemFilter(SystemFilterPool targetPool, SystemFilter oldFilter, String newName) throws Exception
moveSystemFilter
in interface SystemFilterPoolManager
Exception
public int getSystemFilterPosition(SystemFilter filter)
getSystemFilterPosition
in interface SystemFilterPoolManager
public void moveSystemFilters(SystemFilter[] filters, int delta) throws Exception
Does the following:
moveSystemFilters
in interface SystemFilterPoolManager
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.
orderSystemFilters
in interface SystemFilterPoolManager
Exception
public SystemFilterString addSystemFilterString(SystemFilter filter, String newString) throws Exception
Does the following:
addSystemFilterString
in interface SystemFilterPoolManager
Exception
public SystemFilterString addSystemFilterString(SystemFilter filter, String newString, int position) throws Exception
Does the following:
addSystemFilterString
in interface SystemFilterPoolManager
Exception
public boolean removeSystemFilterString(SystemFilter filter, String oldString) throws Exception
Does the following:
removeSystemFilterString
in interface SystemFilterPoolManager
Exception
public boolean removeSystemFilterString(SystemFilter filter, SystemFilterString filterString) throws Exception
Does the following:
removeSystemFilterString
in interface SystemFilterPoolManager
Exception
public boolean removeSystemFilterString(SystemFilter filter, int position) throws Exception
Does the following:
removeSystemFilterString
in interface SystemFilterPoolManager
Exception
public void updateSystemFilterString(SystemFilterString filterString, String newValue) throws Exception
Does the following:
updateSystemFilterString
in interface SystemFilterPoolManager
Exception
public int getSystemFilterStringPosition(SystemFilterString filterString)
getSystemFilterStringPosition
in interface SystemFilterPoolManager
public SystemFilterString copySystemFilterString(SystemFilter targetFilter, SystemFilterString oldFilterString) throws Exception
copySystemFilterString
in interface SystemFilterPoolManager
Exception
public SystemFilterString moveSystemFilterString(SystemFilter targetFilter, SystemFilterString oldFilterString) throws Exception
moveSystemFilterString
in interface SystemFilterPoolManager
Exception
public void moveSystemFilterStrings(SystemFilterString[] filterStrings, int delta) throws Exception
Does the following:
moveSystemFilterStrings
in interface SystemFilterPoolManager
filterStrings
- Array of SystemFilterStrings to move.
Exception
public void suspendCallbacks(boolean suspend)
suspendCallbacks
in interface SystemFilterPoolManager
public IFile getSaveFile(SystemFilterPool pool)
public void save(SystemFilterPool pool) throws Exception
save
in interface SystemFilterPoolManager
Exception
public void save() throws Exception
save
in interface SystemFilterPoolManager
Exception
protected void saveToOneFile() throws Exception
Exception
public static SystemFilterPoolManager restore(Logger logger, SystemFilterPoolManagerProvider caller, IFolder mgrFolder, String name, int savePolicy, SystemFilterNamingPolicy namingPolicy) throws Exception
logger
- The logging object to log errors tomgrFolder
- folder containing filter pool folders, or single file for that save policyname
- the name of the manager to restore. File name is derived from it when saving to one file.savePolicy
- How to persist filters. See SystemFilterConstants.namingPolicy
- Naming prefix information for persisted data file names.
Exception
public static SystemFilterPoolManager restore(Logger logger, SystemFilterPoolManagerProvider caller, IFolder mgrFolder, String name, int savePolicy) throws Exception
logger
- The logging object to log errors tomgrFolder
- folder containing filter pool folders, or single file for that save policyname
- the name of the manager to restore. File name is derived from it when saving to one file.savePolicy
- How to persist filters. See SystemFilterConstants.
Exception
protected static SystemFilterPoolManager restoreFromOneFile(Logger logger, IFolder mgrFolder, String name, SystemFilterNamingPolicy namingPolicy) throws Exception
logger
- The logging object to log errors tomgrFolder
- The folder containing the file to restore from.name
- The name of the manager, from which the file name is derived.namingPolicy
- Naming prefix information for persisted data file names.
Exception
public IFolder getFolder()
getFolder
in interface SystemFilterPoolManager
public void resetManagerFolder(IFolder newFolder)
resetManagerFolder
in interface SystemFilterPoolManager
protected static String getSaveFileName(SystemMOFHelpers mofHelpers, SystemFilterPoolManager manager)
protected static String getRootSaveFileName(SystemFilterPoolManager manager)
protected static String getRootSaveFileName(SystemFilterNamingPolicy namingPolicy, String managerName)
public static String getFolderPath(IFolder folder)
protected String derivePoolFolderName(String poolName)
public SystemMOFHelpers getMOFHelpers()
public static SystemMOFHelpers getMOFHelpers(Logger logger)
public Logger getLogger()
public void setLogger(Logger logger)
public void logInfo(String message)
message
- Message to be written to the log filepublic void logWarning(String message)
message
- Message to be written to the log filepublic void logError(String message, Throwable exception)
message
- Message to be written to the log fileexception
- Any exception that generated the error condition,
this will be used to print a stack trace in the log file.public void logDebugMessage(String prefix, String message)
message
- Message to be written to the log filepublic void logMessage(String msg)
public String toString()
public String getName()
SystemFilterPoolManager
getName
in interface SystemFilterPoolManager
public boolean isSupportsNestedFilters()
isSupportsNestedFilters
in interface SystemFilterPoolManager
public EList getPools()
getPools
in interface SystemFilterPoolManager
public Object eGet(EStructuralFeature eFeature, boolean resolve)
public boolean eIsSet(EStructuralFeature eFeature)
public void eSet(EStructuralFeature eFeature, Object newValue)
public void eUnset(EStructuralFeature eFeature)
public void setNameGen(String newName)
public void setSupportsNestedFiltersGen(boolean newSupportsNestedFilters)
public boolean isSupportsDuplicateFilterStrings()
isSupportsDuplicateFilterStrings
in interface SystemFilterPoolManager
public void unsetSupportsDuplicateFilterStrings()
unsetSupportsDuplicateFilterStrings
in interface SystemFilterPoolManager
public boolean isSetSupportsDuplicateFilterStrings()
isSetSupportsDuplicateFilterStrings
in interface SystemFilterPoolManager
public boolean isSingleFilterStringOnly()
isSingleFilterStringOnly
in interface SystemFilterPoolManager
SystemFilterPoolManager.setSingleFilterStringOnly(boolean)
,
FiltersPackage.getSystemFilterPoolManager_SingleFilterStringOnly()
public void setSingleFilterStringOnly(boolean newSingleFilterStringOnly)
setSingleFilterStringOnly
in interface SystemFilterPoolManager
newSingleFilterStringOnly
- the new value of the 'Single Filter String Only' attribute.SystemFilterPoolManager.isSingleFilterStringOnly()
|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |