|
RSE Release 3.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ISystemFilterPoolReferenceManager
This class manages a persistable list of objects each of which reference a filter pool. This class builds on the parent class SystemPersistableReferenceManager, offering convenience versions of the parent methods that are typed to the classes in the filters framework.
Method Summary | |
---|---|
ISystemFilterPoolReference |
addReferenceToSystemFilterPool(ISystemFilterPool filterPool)
Given a filter pool, create a referencing object and add it to the list. |
ISystemFilterPoolReference |
addReferenceToSystemFilterPool(String filterPoolName)
Given a filter pool name, create a referencing object and add it to the list. |
int |
addSystemFilterPoolReference(ISystemFilterPoolReference filterPoolReference)
Add a filter pool referencing object to the list. |
ISystemFilterPoolManager[] |
getAdditionalSystemFilterPoolManagers()
Get the managers of the master list of filter pools, from which objects in this list reference, but which are not in the list of managers our pool manager supplier gives us. |
ISystemFilterPoolManager |
getDefaultSystemFilterPoolManager()
Get the default manager of the master list of filter pools, from which objects in this list reference. |
ISystemFilterPoolReferenceManagerProvider |
getProvider()
Get the object which instantiated this instance of the filter pool reference manager. |
ISystemFilterPool[] |
getReferencedSystemFilterPools()
Return array of filter pools currently referenced by this manager Result will never be null, although it may be an array of length zero. |
ISystemFilterPoolReference |
getReferenceToSystemFilterPool(ISystemFilterPool filterPool)
Given a filter pool, locate the referencing object for it and return it. |
ISystemFilterPoolManagerProvider |
getSystemFilterPoolManagerProvider()
Get the associated master pool manager provider. |
ISystemFilterPoolManager[] |
getSystemFilterPoolManagers()
Get the managers of the master list of filter pools, from which objects in this list reference. |
int |
getSystemFilterPoolReferenceCount()
Return count of referenced filter pools |
int |
getSystemFilterPoolReferencePosition(ISystemFilterPoolReference filterPoolRef)
Return the zero-based position of a SystemFilterPoolReference object within this list |
ISystemFilterPoolReference[] |
getSystemFilterPoolReferences()
Return array of SystemFilterPoolReference objects. |
ISystemFilterReference |
getSystemFilterReference(ISubSystem subSystem,
ISystemFilter filter)
Create a single filter refererence to a given filter. |
int |
getSystemFilterReferencePosition(ISubSystem subSystem,
ISystemFilter filter)
Given a filter, return its position within this reference manager when you think of all filter references from all filter pool references as being concatenated |
int |
getSystemFilterReferencePosition(ISystemFilterReference filterRef)
Given a filter reference, return its position within this reference manager when you think of all filter references from all filter pool references as being concatenated |
ISystemFilterReference[] |
getSystemFilterReferences(ISubSystem subSystem)
Concatenate all filter references from all filter pools we reference, into one big list. |
boolean |
isSystemFilterPoolReferenced(ISystemFilterPool filterPool)
Return true if the given filter pool has a referencing object in this list. |
void |
moveSystemFilterPoolReference(ISystemFilterPoolReference filterPoolRef,
int pos)
Move a given filter pool reference to a given zero-based location Calls back to inform provider |
void |
moveSystemFilterPoolReferences(ISystemFilterPoolReference[] filterPoolRefs,
int delta)
Move existing filter pool references a given number of positions. |
void |
regenerateReferencedSystemFilterPoolNames()
Ask each referenced pool for its name, and update it. |
int |
removeReferenceToSystemFilterPool(ISystemFilterPool filterPool)
Given a filter pool, locate the referencing object for it and remove it from the list. |
int |
removeSystemFilterPoolReference(ISystemFilterPoolReference filterPoolReference,
boolean deReference)
Remove a filter pool referencing object from the list. |
void |
renameReferenceToSystemFilterPool(ISystemFilterPool pool)
A reference filter pool has been renamed. |
void |
resetSystemFilterPoolReference(ISystemFilterPoolReference filterPoolReference,
ISystemFilterPool newPool)
Reset the filter pool a reference points to. |
void |
setDefaultSystemFilterPoolManager(ISystemFilterPoolManager mgr)
Set the default manager of the master list of filter pools, from which objects in this list reference. |
void |
setProvider(ISystemFilterPoolReferenceManagerProvider caller)
Set the object which instantiated this instance of the filter pool reference manager. |
void |
setProviderEventNotification(boolean fireEvents)
Turn off callbacks to the provider until turned on again. |
void |
setSystemFilterPoolManagerProvider(ISystemFilterPoolManagerProvider poolMgrProvider)
Set the associated master pool manager provider. |
void |
setSystemFilterPoolReferences(ISystemFilterPool[] filterPools,
boolean deReference)
In one shot, set the filter pool references to new references to supplied filter pools. |
void |
setSystemFilterPoolReferences(ISystemFilterPoolReference[] filterPoolReferences,
boolean deReference)
In one shot, set the filter pool references Calls back to inform provider |
Methods inherited from interface org.eclipse.rse.core.references.IRSEBasePersistableReferenceManager |
---|
addReferencingObject, getName, getReferencedObject, getReferencingObjectCount, getReferencingObjectList, getReferencingObjectPosition, getReferencingObjects, isReferenced, moveReferencingObjectPosition, removeAllReferencingObjects, removeAndDeReferenceAllReferencingObjects, removeAndDeReferenceReferencingObject, removeReferencingObject, setName, setReferencingObjects |
Method Detail |
---|
ISystemFilterPoolReferenceManagerProvider getProvider()
void setProvider(ISystemFilterPoolReferenceManagerProvider caller)
void setProviderEventNotification(boolean fireEvents)
void setSystemFilterPoolManagerProvider(ISystemFilterPoolManagerProvider poolMgrProvider)
ISystemFilterPoolManagerProvider getSystemFilterPoolManagerProvider()
ISystemFilterPoolManager[] getSystemFilterPoolManagers()
ISystemFilterPoolManager[] getAdditionalSystemFilterPoolManagers()
void setDefaultSystemFilterPoolManager(ISystemFilterPoolManager mgr)
ISystemFilterPoolManager getDefaultSystemFilterPoolManager()
void regenerateReferencedSystemFilterPoolNames()
ISystemFilterPoolReference[] getSystemFilterPoolReferences()
void setSystemFilterPoolReferences(ISystemFilterPoolReference[] filterPoolReferences, boolean deReference)
Calls back to inform provider
filterPoolReferences
- of filter pool reference objects to set the list to.deReference
- true to first de-reference all objects in the existing list.int addSystemFilterPoolReference(ISystemFilterPoolReference filterPoolReference)
void resetSystemFilterPoolReference(ISystemFilterPoolReference filterPoolReference, ISystemFilterPool newPool)
int removeSystemFilterPoolReference(ISystemFilterPoolReference filterPoolReference, boolean deReference)
filterPoolReference
- the reference to removedeReference
- true if we want to dereference the referenced object (call removeReference on it)
int getSystemFilterPoolReferenceCount()
int getSystemFilterPoolReferencePosition(ISystemFilterPoolReference filterPoolRef)
void moveSystemFilterPoolReference(ISystemFilterPoolReference filterPoolRef, int pos)
Calls back to inform provider
void moveSystemFilterPoolReferences(ISystemFilterPoolReference[] filterPoolRefs, int delta)
Calls back to inform provider
filterPoolRefs
- Array of SystemFilterPoolReferences to move.delta
- the amount by which to move the filter pool references.ISystemFilterPool[] getReferencedSystemFilterPools()
boolean isSystemFilterPoolReferenced(ISystemFilterPool filterPool)
ISystemFilterPoolReference getReferenceToSystemFilterPool(ISystemFilterPool filterPool)
ISystemFilterPoolReference addReferenceToSystemFilterPool(ISystemFilterPool filterPool)
Calls back to inform provider
ISystemFilterPoolReference addReferenceToSystemFilterPool(String filterPoolName)
Calls back to inform provider
filterPoolName
- the name of the filter pool being referenced.
int removeReferenceToSystemFilterPool(ISystemFilterPool filterPool)
Calls back to inform provider
void renameReferenceToSystemFilterPool(ISystemFilterPool pool)
Calls back to inform provider
void setSystemFilterPoolReferences(ISystemFilterPool[] filterPools, boolean deReference)
Calls back to inform provider
filterPools
- of filter pool objects to create references fordeReference
- true to first de-reference all objects in the existing list.ISystemFilterReference getSystemFilterReference(ISubSystem subSystem, ISystemFilter filter)
ISystemFilterReference[] getSystemFilterReferences(ISubSystem subSystem)
int getSystemFilterReferencePosition(ISystemFilterReference filterRef)
int getSystemFilterReferencePosition(ISubSystem subSystem, ISystemFilter filter)
|
RSE Release 3.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |