org.eclipse.rse.core.filters
Interface ISystemFilterStartHere

All Known Implementing Classes:

SystemFilterStartHere

public interface ISystemFilterStartHere

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.

Method Detail

createSystemFilterNamingPolicy

public IRSEFilterNamingPolicy createSystemFilterNamingPolicy()

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

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.

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.

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.