|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.etools.systems.filters.SystemFilterStartHere
Static methods for creating and restoring the "front doors" to the filter framework
Field Summary | |
---|---|
static String |
copyright
|
Fields inherited from interface com.ibm.etools.systems.filters.SystemFilterConstants |
---|
DEFAULT_TYPE, SAVEFILE_SUFFIX, TRY_TO_RESTORE_NO, TRY_TO_RESTORE_YES |
Fields inherited from interface com.ibm.etools.systems.filters.SystemFilterSavePolicies |
---|
SAVE_POLICY_NONE, SAVE_POLICY_ONE_FILE_PER_FILTER, SAVE_POLICY_ONE_FILE_PER_MANAGER, SAVE_POLICY_ONE_FILE_PER_POOL_SAME_FOLDER, SAVE_POLICY_ONE_FILEANDFOLDER_PER_POOL |
Constructor Summary | |
---|---|
SystemFilterStartHere()
|
Method Summary | |
---|---|
static SystemFilterNamingPolicy |
createSystemFilterNamingPolicy()
Factory method to return an instance populated with defaults. |
static SystemFilterPoolManager |
createSystemFilterPoolManager(Logger logger,
SystemFilterPoolManagerProvider caller,
IFolder mgrFolder,
String name,
boolean allowNestedFilters,
int savePolicy,
SystemFilterNamingPolicy namingPolicy)
Factory to create a filter pool manager, when you want it to worry about saving and restoring the filter data to disk. |
static SystemFilterPoolManager |
createSystemFilterPoolManager(Logger logger,
SystemFilterPoolManagerProvider caller,
String name,
boolean allowNestedFilters)
Factory to create a filter pool manager, when you do NOT want it to worry about saving and restoring the filter data to disk. |
static SystemFilterPoolReferenceManager |
createSystemFilterPoolReferenceManager(SystemFilterPoolReferenceManagerProvider caller,
SystemFilterPoolManagerProvider relatedPoolMgrProvider,
IFolder mgrFolder,
String name,
SystemFilterNamingPolicy namingPolicy)
Create a SystemFilterPoolReferenceManager instance, when you want it to be saved and restored to its own file. |
static SystemFilterPoolReferenceManager |
createSystemFilterPoolReferenceManager(SystemFilterPoolReferenceManagerProvider caller,
SystemFilterPoolManagerProvider relatedPoolMgrProvider,
String name,
SystemFilterNamingPolicy namingPolicy)
Create a SystemFilterPoolReferenceManager instance, when you do NOT want it to be saved and restored to its own file. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String copyright
Constructor Detail |
public SystemFilterStartHere()
Method Detail |
public static SystemFilterNamingPolicy createSystemFilterNamingPolicy()
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.public static SystemFilterPoolManager createSystemFilterPoolManager(Logger logger, SystemFilterPoolManagerProvider caller, String name, boolean allowNestedFilters)
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.name
- the name of the filter pool manager. Not currently used but you may
find a use for it.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.public static SystemFilterPoolReferenceManager createSystemFilterPoolReferenceManager(SystemFilterPoolReferenceManagerProvider caller, SystemFilterPoolManagerProvider relatedPoolMgrProvider, IFolder mgrFolder, String name, SystemFilterNamingPolicy namingPolicy)
caller
- Objects which instantiate this class should implement the
SystemFilterPoolReferenceManagerProvider 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 hold the persisted file.name
- the name of the filter pool reference manager.namingPolicy
- the naming policy object which will return the name of that one file.public static SystemFilterPoolReferenceManager createSystemFilterPoolReferenceManager(SystemFilterPoolReferenceManagerProvider caller, SystemFilterPoolManagerProvider relatedPoolMgrProvider, String name, SystemFilterNamingPolicy namingPolicy)
caller
- Objects which instantiate this class should implement the
SystemFilterPoolReferenceManagerProvider 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.name
- the name of the filter pool reference manager. This is not currently
used, but you may find a use for it.namingPolicy
- the naming policy object which will return the name of that one file.
|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |