org.eclipse.rse.filters
Class SystemFilterStartHere

java.lang.Object
  org.eclipse.rse.filters.SystemFilterStartHere

All Implemented Interfaces:

ISystemFilterConstants, ISystemFilterSavePolicies, ISystemFilterStartHere

public class SystemFilterStartHere

extends Object

implements ISystemFilterConstants, ISystemFilterStartHere

Static methods for creating and restoring the "front doors" to the filter framework

• SystemFilterNamingPolicy. This tells the framework what to use for file names when saving and restoring to/from disk.
• SystemFilterPoolManager. This manages master lists of filter pools. Use only these APIs for creating:
  • SystemFilterPools.
  • SystemFilters
• SystemFilterPoolReferenceManager. This manages a persistable list of filter pool references. Use its APIs for creating:
  • SystemFilterPoolReferences.

Field Summary

Fields inherited from interface org.eclipse.rse.core.filters.ISystemFilterConstants

DEFAULT_TYPE, SAVEFILE_SUFFIX, TRY_TO_RESTORE_NO, TRY_TO_RESTORE_YES

Fields inherited from interface org.eclipse.rse.core.filters.ISystemFilterSavePolicies

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

IRSEFilterNamingPolicy	createSystemFilterNamingPolicy() Factory method to return an instance populated with defaults.
ISystemFilterPoolManager	createSystemFilterPoolManager(ISystemProfile profile, Logger logger, ISystemFilterPoolManagerProvider 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.
ISystemFilterPoolReferenceManager	createSystemFilterPoolReferenceManager(ISystemFilterPoolReferenceManagerProvider caller, ISystemFilterPoolManagerProvider relatedPoolMgrProvider, String name, IRSEFilterNamingPolicy namingPolicy) Create a SystemFilterPoolReferenceManager instance, when you do NOT want it to be saved and restored to its own file.
static SystemFilterStartHere	getDefault()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SystemFilterStartHere

public SystemFilterStartHere()

Method Detail

getDefault

public static SystemFilterStartHere getDefault()

createSystemFilterNamingPolicy

public IRSEFilterNamingPolicy createSystemFilterNamingPolicy()

Factory method to return an instance populated with defaults. You can then simply override whatever is desired via setXXX methods.

Specified by:

createSystemFilterNamingPolicy in interface ISystemFilterStartHere

createSystemFilterPoolManager

public ISystemFilterPoolManager createSystemFilterPoolManager(ISystemProfile profile,
                                                              Logger logger,
                                                              ISystemFilterPoolManagerProvider 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. Rather, you will save and restore yourself.

Specified by:

createSystemFilterPoolManager in interface ISystemFilterStartHere

Parameters:

logger - A logging object into which to log errors as they happen in the framework

caller - 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.

createSystemFilterPoolReferenceManager

public ISystemFilterPoolReferenceManager createSystemFilterPoolReferenceManager(ISystemFilterPoolReferenceManagerProvider caller,
                                                                                ISystemFilterPoolManagerProvider relatedPoolMgrProvider,
                                                                                String name,
                                                                                IRSEFilterNamingPolicy namingPolicy)

Create a SystemFilterPoolReferenceManager instance, when you do NOT want it to be saved and restored to its own file. Rather, you will save and restore it yourself.

Specified by:

createSystemFilterPoolReferenceManager in interface ISystemFilterStartHere

Parameters:

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.