|
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.references.impl.SystemPersistableReferenceManagerImpl
com.ibm.etools.systems.filters.impl.SystemFilterPoolReferenceManagerImpl
Field Summary | |
---|---|
static String |
copyright
|
Fields inherited from class com.ibm.etools.systems.references.impl.SystemPersistableReferenceManagerImpl |
---|
debug, EMPTY_MAP, name, NAME_EDEFAULT, referencingObjectList |
Constructor Summary | |
---|---|
protected |
SystemFilterPoolReferenceManagerImpl()
Default constructor. |
Method Summary | |
---|---|
SystemFilterPoolReference |
addReferenceToSystemFilterPool(SystemFilterPool filterPool)
Given a filter pool, create a referencing object and add it to the list. |
int |
addSystemFilterPoolReference(SystemFilterPoolReference filterPoolReference)
Add a filter pool referencing object to the list. |
protected static SystemFilterPoolReferenceManagerImpl |
createManager()
|
SystemFilterPoolReference |
createSystemFilterPoolReference(SystemFilterPool filterPool)
Create a filter pool referencing object, but do NOT add it to the list, do NOT call back. |
static SystemFilterPoolReferenceManager |
createSystemFilterPoolReferenceManager(SystemFilterPoolReferenceManagerProvider caller,
SystemFilterPoolManagerProvider relatedPoolManagerProvider,
IFolder mgrFolder,
String name,
int savePolicy,
SystemFilterNamingPolicy namingPolicy)
Create a SystemFilterPoolReferenceManager instance. |
Object |
eGet(EStructuralFeature eFeature,
boolean resolve)
|
NotificationChain |
eInverseAdd(InternalEObject otherEnd,
int featureID,
Class baseClass,
NotificationChain msgs)
|
NotificationChain |
eInverseRemove(InternalEObject otherEnd,
int featureID,
Class baseClass,
NotificationChain msgs)
|
boolean |
eIsSet(EStructuralFeature eFeature)
|
void |
eSet(EStructuralFeature eFeature,
Object newValue)
|
protected EClass |
eStaticClass()
|
void |
eUnset(EStructuralFeature eFeature)
|
SystemFilterPoolManager[] |
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. |
SystemFilterPoolManager |
getDefaultSystemFilterPoolManager()
Get the default manager of the master list of filter pools, from which objects in this list reference. |
static SystemFilterPool |
getFilterPool(SystemFilterPoolManager[] mgrs,
String mgrName,
String poolName)
Utility method to scan across all filter pools in a given named filter pool manager, for a match on a given filter pool name. |
static SystemFilterPoolManager |
getFilterPoolManager(SystemFilterPoolManager[] mgrs,
String mgrName)
Utility method to scan across all filter pool managers for a match on a give name. |
IFolder |
getFolder()
Return the folder that this manager is contained in. |
String |
getFolderPath()
Return the path of the folder |
static String |
getFolderPath(IFolder folder)
Return the path of the given folder |
SystemFilterNamingPolicy |
getNamingPolicy()
Get the naming policy currently used when saving data to disk. |
SystemFilterPoolReferenceManagerProvider |
getProvider()
Get the object which instantiated this instance of the filter pool reference manager. |
SystemFilterPool[] |
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. |
SystemFilterPoolReference |
getReferenceToSystemFilterPool(SystemFilterPool filterPool)
Given a filter pool, locate the referencing object for it and return it. |
protected String |
getSaveFileName()
non-static version. |
protected static String |
getSaveFileName(String fileNameNoSuffix)
Derive and return the unqualified file name used to store this to disk. |
protected String |
getSaveFilePathAndName()
non-static version. |
protected static String |
getSaveFilePathAndName(IFolder mgrFolder,
String name,
SystemFilterNamingPolicy namingPolicy)
If saving all info in one file, this returns the fully qualified name of that file, given the unadorned manager name and the prefix (if any) to adorn with. |
SystemFilterPoolManagerProvider |
getSystemFilterPoolManagerProvider()
Get the associated master pool manager provider. |
SystemFilterPoolManager[] |
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 |
Object |
getSystemFilterPoolReferenceManagerData()
Return transient data set via setFilterPoolData. |
int |
getSystemFilterPoolReferencePosition(SystemFilterPoolReference filterPoolRef)
Return the zero-based position of a SystemFilterPoolReference object within this list |
SystemFilterPoolReference[] |
getSystemFilterPoolReferences()
Return array of SystemFilterPoolReference objects. |
SystemFilterReference |
getSystemFilterReference(SystemFilter filter)
Create a single filter refererence to a given filter. |
int |
getSystemFilterReferencePosition(SystemFilter 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(SystemFilterReference 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 |
SystemFilterReference[] |
getSystemFilterReferences()
Concatenate all filter references from all filter pools we reference, into one big list. |
protected void |
initialize(SystemFilterPoolReferenceManagerProvider caller,
IFolder folder,
String name,
int savePolicy,
SystemFilterNamingPolicy namingPolicy)
|
protected void |
initialize(SystemFilterPoolReferenceManagerProvider caller,
IFolder folder,
String name,
int savePolicy,
SystemFilterNamingPolicy namingPolicy,
SystemFilterPoolManagerProvider relatedPoolManagerProvider)
|
boolean |
isSystemFilterPoolReferenced(SystemFilterPool filterPool)
Return true if the given filter pool has a referencing object in this list. |
void |
moveSystemFilterPoolReference(SystemFilterPoolReference filterPoolRef,
int pos)
Move a given filter pool reference to a given zero-based location Calls back to inform provider of the event |
void |
moveSystemFilterPoolReferences(SystemFilterPoolReference[] 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(SystemFilterPool filterPool)
Given a filter pool, locate the referencing object for it and remove it from the list. |
int |
removeSystemFilterPoolReference(SystemFilterPoolReference filterPoolReference,
boolean deReference)
Remove a filter pool referencing object from the list. |
void |
renameReferenceToSystemFilterPool(SystemFilterPool pool)
A reference filter pool has been renamed. |
void |
resetManagerFolder(IFolder newFolder)
Reset the folder that this manager is contained in. |
void |
resetSystemFilterPoolReference(SystemFilterPoolReference filterPoolReference,
SystemFilterPool newPool)
Reset the filter pool a reference points to. |
Vector |
resolveReferencesAfterRestore(SystemFilterPoolManagerProvider relatedPoolMgrProvider,
SystemFilterPoolReferenceManagerProvider provider)
After restoring this from disk, there is only the referenced object name, not the referenced object pointer, for each referencing object. |
static SystemFilterPoolReferenceManager |
restore(SystemFilterPoolReferenceManagerProvider caller,
IFolder mgrFolder,
String name)
Restore the filter pools from disk, assuming default for prefix of name. |
static SystemFilterPoolReferenceManager |
restore(SystemFilterPoolReferenceManagerProvider caller,
IFolder mgrFolder,
String name,
SystemFilterNamingPolicy namingPolicy)
Restore the filter pools from disk. |
protected static SystemFilterPoolReferenceManager |
restoreFromOneFile(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. |
protected boolean |
saveToOneFile()
Save this reference manager to disk. |
void |
setDefaultSystemFilterPoolManager(SystemFilterPoolManager mgr)
Set the default manager of the master list of filter pools, from which objects in this list reference. |
void |
setName(String name)
Set the name. |
void |
setNamingPolicy(SystemFilterNamingPolicy namingPolicy)
Set the naming policy used when saving data to disk. |
void |
setProvider(SystemFilterPoolReferenceManagerProvider 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(SystemFilterPoolManagerProvider poolMgrProvider)
Set the associated master pool manager provider. |
void |
setSystemFilterPoolReferenceManagerData(Object data)
This is to set transient data that is subsequently queryable. |
void |
setSystemFilterPoolReferences(SystemFilterPool[] filterPools,
boolean deReference)
In one shot, set the filter pool references to new references to supplied filter pools. |
void |
setSystemFilterPoolReferences(SystemFilterPoolReference[] filterPoolReferences,
boolean deReference)
In one shot, set the filter pool references Calls back to inform provider |
String |
toString()
Return string identifying this filter |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final String copyright
Constructor Detail |
protected SystemFilterPoolReferenceManagerImpl()
Method Detail |
protected EClass eStaticClass()
eStaticClass
in class SystemPersistableReferenceManagerImpl
public NotificationChain eInverseAdd(InternalEObject otherEnd, int featureID, Class baseClass, NotificationChain msgs)
eInverseAdd
in class SystemPersistableReferenceManagerImpl
public NotificationChain eInverseRemove(InternalEObject otherEnd, int featureID, Class baseClass, NotificationChain msgs)
eInverseRemove
in class SystemPersistableReferenceManagerImpl
public Object eGet(EStructuralFeature eFeature, boolean resolve)
eGet
in class SystemPersistableReferenceManagerImpl
public void eSet(EStructuralFeature eFeature, Object newValue)
eSet
in class SystemPersistableReferenceManagerImpl
public void eUnset(EStructuralFeature eFeature)
eUnset
in class SystemPersistableReferenceManagerImpl
public boolean eIsSet(EStructuralFeature eFeature)
eIsSet
in class SystemPersistableReferenceManagerImpl
public static SystemFilterPoolReferenceManager createSystemFilterPoolReferenceManager(SystemFilterPoolReferenceManagerProvider caller, SystemFilterPoolManagerProvider relatedPoolManagerProvider, IFolder mgrFolder, String name, int savePolicy, 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. This is used when
the save policy is SAVE_POLICY_ONE_FILE_PER_MANAGER. For SAVE_POLICY_NONE, this
is not used. If it is used, it is created if it does not already exist.name
- the name of the filter pool reference manager. This is used when
the save policy is SAVE_POLICY_ONE_FILE_PER_MANAGER, to deduce the file name.savePolicy
- The save policy for the filter pool references list. One of the
following 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 SystemFilterPoolReferenceManagerImpl createManager()
protected void initialize(SystemFilterPoolReferenceManagerProvider caller, IFolder folder, String name, int savePolicy, SystemFilterNamingPolicy namingPolicy, SystemFilterPoolManagerProvider relatedPoolManagerProvider)
protected void initialize(SystemFilterPoolReferenceManagerProvider caller, IFolder folder, String name, int savePolicy, SystemFilterNamingPolicy namingPolicy)
public void setSystemFilterPoolManagerProvider(SystemFilterPoolManagerProvider poolMgrProvider)
setSystemFilterPoolManagerProvider
in interface SystemFilterPoolReferenceManager
public SystemFilterPoolManagerProvider getSystemFilterPoolManagerProvider()
getSystemFilterPoolManagerProvider
in interface SystemFilterPoolReferenceManager
public SystemFilterPoolManager[] getSystemFilterPoolManagers()
getSystemFilterPoolManagers
in interface SystemFilterPoolReferenceManager
public SystemFilterPoolManager[] getAdditionalSystemFilterPoolManagers()
getAdditionalSystemFilterPoolManagers
in interface SystemFilterPoolReferenceManager
public void setDefaultSystemFilterPoolManager(SystemFilterPoolManager mgr)
setDefaultSystemFilterPoolManager
in interface SystemFilterPoolReferenceManager
public SystemFilterPoolManager getDefaultSystemFilterPoolManager()
getDefaultSystemFilterPoolManager
in interface SystemFilterPoolReferenceManager
public SystemFilterPoolReferenceManagerProvider getProvider()
getProvider
in interface SystemFilterPoolReferenceManager
public void setProvider(SystemFilterPoolReferenceManagerProvider caller)
setProvider
in interface SystemFilterPoolReferenceManager
public void setProviderEventNotification(boolean fireEvents)
setProviderEventNotification
in interface SystemFilterPoolReferenceManager
public void setNamingPolicy(SystemFilterNamingPolicy namingPolicy)
SystemFilterNamingPolicy
public SystemFilterNamingPolicy getNamingPolicy()
SystemFilterNamingPolicy
public void setSystemFilterPoolReferenceManagerData(Object data)
public Object getSystemFilterPoolReferenceManagerData()
public void setName(String name)
setName
in interface SystemPersistableReferenceManager
setName
in class SystemPersistableReferenceManagerImpl
public void regenerateReferencedSystemFilterPoolNames()
regenerateReferencedSystemFilterPoolNames
in interface SystemFilterPoolReferenceManager
public SystemFilterPoolReference[] getSystemFilterPoolReferences()
getSystemFilterPoolReferences
in interface SystemFilterPoolReferenceManager
public void setSystemFilterPoolReferences(SystemFilterPoolReference[] filterPoolReferences, boolean deReference)
Calls back to inform provider
setSystemFilterPoolReferences
in interface SystemFilterPoolReferenceManager
deReference
- true to first de-reference all objects in the existing list.public SystemFilterPoolReference createSystemFilterPoolReference(SystemFilterPool filterPool)
createSystemFilterPoolReference
in interface SystemFilterPoolReferenceManager
public int addSystemFilterPoolReference(SystemFilterPoolReference filterPoolReference)
addSystemFilterPoolReference
in interface SystemFilterPoolReferenceManager
public void resetSystemFilterPoolReference(SystemFilterPoolReference filterPoolReference, SystemFilterPool newPool)
resetSystemFilterPoolReference
in interface SystemFilterPoolReferenceManager
public int removeSystemFilterPoolReference(SystemFilterPoolReference filterPoolReference, boolean deReference)
removeSystemFilterPoolReference
in interface SystemFilterPoolReferenceManager
deReference
- true if we want to dereference the referenced object (call removeReference on it)
public int getSystemFilterPoolReferenceCount()
getSystemFilterPoolReferenceCount
in interface SystemFilterPoolReferenceManager
public int getSystemFilterPoolReferencePosition(SystemFilterPoolReference filterPoolRef)
getSystemFilterPoolReferencePosition
in interface SystemFilterPoolReferenceManager
public void moveSystemFilterPoolReference(SystemFilterPoolReference filterPoolRef, int pos)
moveSystemFilterPoolReference
in interface SystemFilterPoolReferenceManager
public void moveSystemFilterPoolReferences(SystemFilterPoolReference[] filterPoolRefs, int delta)
Calls back to inform provider
moveSystemFilterPoolReferences
in interface SystemFilterPoolReferenceManager
filterPoolRefs
- Array of SystemFilterPoolReferences to move.public SystemFilterPool[] getReferencedSystemFilterPools()
getReferencedSystemFilterPools
in interface SystemFilterPoolReferenceManager
public boolean isSystemFilterPoolReferenced(SystemFilterPool filterPool)
isSystemFilterPoolReferenced
in interface SystemFilterPoolReferenceManager
public SystemFilterPoolReference getReferenceToSystemFilterPool(SystemFilterPool filterPool)
getReferenceToSystemFilterPool
in interface SystemFilterPoolReferenceManager
public SystemFilterPoolReference addReferenceToSystemFilterPool(SystemFilterPool filterPool)
addReferenceToSystemFilterPool
in interface SystemFilterPoolReferenceManager
filterPool
- what to reference
public int removeReferenceToSystemFilterPool(SystemFilterPool filterPool)
removeReferenceToSystemFilterPool
in interface SystemFilterPoolReferenceManager
public void renameReferenceToSystemFilterPool(SystemFilterPool pool)
Calls back to inform provider
renameReferenceToSystemFilterPool
in interface SystemFilterPoolReferenceManager
public void setSystemFilterPoolReferences(SystemFilterPool[] filterPools, boolean deReference)
setSystemFilterPoolReferences
in interface SystemFilterPoolReferenceManager
deReference
- true to first de-reference all objects in the existing list.public SystemFilterReference getSystemFilterReference(SystemFilter filter)
getSystemFilterReference
in interface SystemFilterPoolReferenceManager
public SystemFilterReference[] getSystemFilterReferences()
getSystemFilterReferences
in interface SystemFilterPoolReferenceManager
public int getSystemFilterReferencePosition(SystemFilterReference filterRef)
getSystemFilterReferencePosition
in interface SystemFilterPoolReferenceManager
public int getSystemFilterReferencePosition(SystemFilter filter)
getSystemFilterReferencePosition
in interface SystemFilterPoolReferenceManager
public void save() throws Exception
save
in interface SystemFilterPoolReferenceManager
Exception
protected boolean saveToOneFile() throws Exception
Exception
public static SystemFilterPoolReferenceManager restore(SystemFilterPoolReferenceManagerProvider caller, IFolder mgrFolder, String name, SystemFilterNamingPolicy namingPolicy) throws Exception
caller
- The object that is calling this, which must implement SystemFilterPoolReferenceManagerProvidermgrFolder
- folder containing filter pool references file.name
- the name of the manager to restore. File name is derived from it when saving to one file.namingPolicy
- to get file name prefix, via getFilterPoolReferenceManagerFileNamePrefix(). Pass null to use default.
Exception
public static SystemFilterPoolReferenceManager restore(SystemFilterPoolReferenceManagerProvider caller, IFolder mgrFolder, String name) throws Exception
Exception
protected static SystemFilterPoolReferenceManager restoreFromOneFile(IFolder mgrFolder, String name, SystemFilterNamingPolicy namingPolicy) throws Exception
mgrFolder
- 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 Vector resolveReferencesAfterRestore(SystemFilterPoolManagerProvider relatedPoolMgrProvider, SystemFilterPoolReferenceManagerProvider provider)
This method is called after restore and for each restored object in the list must:
resolveReferencesAfterRestore
in interface SystemFilterPoolReferenceManager
provider
- the host of this reference manager, so you can later call getProvider
public static SystemFilterPool getFilterPool(SystemFilterPoolManager[] mgrs, String mgrName, String poolName)
mgrs
- The list of filter pool managers to scan for the given filter pool.mgrName
- The name of the manager to restrict the search topublic static SystemFilterPoolManager getFilterPoolManager(SystemFilterPoolManager[] mgrs, String mgrName)
mgrs
- The list of filter pool managers to scan for the given namemgrName
- The name of the manager to restrict the search toprotected static String getSaveFilePathAndName(IFolder mgrFolder, String name, SystemFilterNamingPolicy namingPolicy)
protected static String getSaveFileName(String fileNameNoSuffix)
protected String getSaveFilePathAndName()
protected String getSaveFileName()
public IFolder getFolder()
getFolder
in interface SystemFilterPoolReferenceManager
public void resetManagerFolder(IFolder newFolder)
resetManagerFolder
in interface SystemFilterPoolReferenceManager
public String getFolderPath()
public static String getFolderPath(IFolder folder)
public String toString()
SystemPersistableReferenceManagerImpl
toString
in class SystemPersistableReferenceManagerImpl
|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |