|
RSE Release 3.0 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.rse.core.model.RSEPersistableObject
org.eclipse.rse.core.model.PropertySetContainer
org.eclipse.rse.core.model.RSEModelObject
org.eclipse.rse.core.references.SystemReferencingObject
org.eclipse.rse.core.filters.SystemFilterReference
public class SystemFilterReference
Represents a shadow or reference to a system filter. Such references are only transient, not savable to disk. All major function is inherited.
SystemFilter references typically exist for only one reason:
| Field Summary | |
|---|---|
protected ISubSystem |
_subSystem
|
protected HashMap |
cachedContents
|
protected boolean |
isStale
|
protected boolean |
persistent
|
static boolean |
PERSISTENT_NO
|
static boolean |
PERSISTENT_YES
|
| Fields inherited from class org.eclipse.rse.core.references.SystemReferencingObject |
|---|
referenceBroken |
| Fields inherited from interface org.eclipse.rse.core.model.IRSEPersistableContainer |
|---|
NO_CHILDREN |
| Constructor Summary | |
|---|---|
protected |
SystemFilterReference()
Constructor. |
| Method Summary | |
|---|---|
boolean |
commit()
Request a persistence manager to persist this object. |
static ISystemFilterReference |
createSystemFilterReference(ISubSystem subSystem,
ISystemFilterContainerReference parent,
ISystemFilter filter,
boolean persistent)
Create a new instance of this class. |
Object |
getAdapter(Class adapterType)
This is the method required by the IAdaptable interface. |
Object[] |
getContents(ISystemContentsType contentsType)
Returns all the contents of the object (combining results of all filters |
ISystemFilterReference |
getExistingSystemFilterReference(ISubSystem subSystem,
ISystemFilter filter)
Return an existing reference to a given system filter. |
int |
getFilterCount()
Return count of the number of filters in the referenced pool or filter |
ISystemFilterPoolReferenceManager |
getFilterPoolReferenceManager()
Return the reference manager which is managing this filter reference framework object. |
String |
getName()
Return the name of the SystemFilter or SystemFilterPool that we reference. |
ISystemFilterContainerReference |
getParent()
The parent will either by a SystemFilterPoolReference or a SystemFilterReference. |
ISystemFilterPoolReference |
getParentSystemFilterReferencePool()
If this is a reference to a nested filter, the parent is the reference to the nested filter's parent. |
IRSEPersistableContainer[] |
getPersistableChildren()
Retrieves the children of this object in the persistence containment hierarchy. |
IRSEPersistableContainer |
getPersistableParent()
Retrieve the parent of this object in the persistence containment hierarchy. |
ISystemFilterPoolReferenceManagerProvider |
getProvider()
Return the object which instantiated the pool reference manager object. |
ISystemFilter |
getReferencedFilter()
Return the filter to which we reference... |
IRSEBaseReferencedObject |
getReferencedObject()
Get the object which we reference. |
ISystemFilterContainer |
getReferencedSystemFilterContainer()
Return the object to which we hold a reference. |
ISubSystem |
getSubSystem()
Gets the subsystem that contains this reference |
ISystemFilterReference |
getSystemFilterReference(ISubSystem subSystem,
ISystemFilter filter)
Create a single filter refererence to a given filter. |
ISystemFilterReference[] |
getSystemFilterReferences(ISubSystem subSystem)
Build and return an array of SystemFilterReference objects. |
int |
getSystemFilterStringCount()
Return the number of filter strings in the referenced filter |
ISystemFilterStringReference |
getSystemFilterStringReference(ISystemFilterString filterString)
Create a single filter string refererence to a given filter string |
ISystemFilterStringReference[] |
getSystemFilterStringReferences()
Get the filter strings contained by this filter. |
boolean |
hasContents(ISystemContentsType contentsType)
Returns whether the object has contents of a particular type. |
boolean |
hasFilters()
Return true if the referenced pool or filter has filters. |
boolean |
isStale()
Indicates whether the cached object is stale |
void |
markStale(boolean isStale)
Marks the object as stale or not |
void |
markStale(boolean isStale,
boolean clearCache)
Marks the object as stale or not |
int |
removeReference()
Fastpath to getReferencedObject().removeReference(this). |
void |
setContents(ISystemContentsType type,
Object[] cachedContents)
|
void |
setParent(ISystemFilterContainerReference parent)
If this is a reference to a nested filter, the parent is the reference to the nested filter's parent. |
void |
setReferencedFilter(ISystemFilter filter)
Set the filter to which we reference... |
void |
setReferencedObject(IRSEBaseReferencedObject obj)
Set the object to which we reference. |
void |
setSubSystem(ISubSystem subSystem)
Sets the subsystem that contains this reference |
String |
toString()
Override of Object method. |
| Methods inherited from class org.eclipse.rse.core.references.SystemReferencingObject |
|---|
getDescription, getHelper, isReferenceBroken, setReferenceBroken |
| Methods inherited from class org.eclipse.rse.core.model.PropertySetContainer |
|---|
addPropertySet, addPropertySets, createPropertySet, createPropertySet, getPropertySet, getPropertySets, removePropertySet |
| Methods inherited from class org.eclipse.rse.core.model.RSEPersistableObject |
|---|
compareStrings, isDirty, isTainted, setDirty, setTainted, setWasRestored, wasRestored |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface org.eclipse.rse.core.references.IRSEBaseReferencingObject |
|---|
isReferenceBroken, setReferenceBroken |
| Methods inherited from interface org.eclipse.rse.core.model.IPropertySetContainer |
|---|
addPropertySet, addPropertySets, createPropertySet, createPropertySet, getPropertySet, getPropertySets, removePropertySet |
| Methods inherited from interface org.eclipse.rse.core.model.IRSEPersistableContainer |
|---|
isDirty, isTainted, setDirty, setTainted, setWasRestored, wasRestored |
| Field Detail |
|---|
protected boolean persistent
protected boolean isStale
protected ISubSystem _subSystem
protected HashMap cachedContents
public static final boolean PERSISTENT_YES
public static final boolean PERSISTENT_NO
| Constructor Detail |
|---|
protected SystemFilterReference()
| Method Detail |
|---|
public static ISystemFilterReference createSystemFilterReference(ISubSystem subSystem,
ISystemFilterContainerReference parent,
ISystemFilter filter,
boolean persistent)
parent - The SystemFilterReference or SystemFilterPoolReference object that we are a child of.filter - The master object to be referenced.persistent - Whether we should formally register our reference with the target filter or not.public ISubSystem getSubSystem()
getSubSystem in interface ISystemFilterReferencepublic void setSubSystem(ISubSystem subSystem)
setSubSystem in interface ISystemFilterReferencesubSystem - the subsystem that holds this referencepublic ISystemFilterPoolReferenceManager getFilterPoolReferenceManager()
getFilterPoolReferenceManager in interface ISystemFilterReferencepublic ISystemFilterPoolReferenceManagerProvider getProvider()
getProvider in interface ISystemFilterReferencepublic void setParent(ISystemFilterContainerReference parent)
public ISystemFilterContainerReference getParent()
getParent in interface ISystemFilterReferencepublic ISystemFilter getReferencedFilter()
getReferencedFilter in interface ISystemFilterReferencepublic void setReferencedFilter(ISystemFilter filter)
setReferencedFilter in interface ISystemFilterReferencepublic ISystemFilterPoolReference getParentSystemFilterReferencePool()
getParentSystemFilterReferencePool in interface ISystemFilterReferencepublic Object getAdapter(Class adapterType)
getAdapter in interface IAdaptablepublic ISystemFilterContainer getReferencedSystemFilterContainer()
Of course, this is a generic method, and in our case it is always true that we only hold a SystemFilter. Hence, this is the same as calling getReferenceFilter and casting the result.
getReferencedSystemFilterContainer in interface ISystemFilterContainerReferencepublic ISystemFilterReference[] getSystemFilterReferences(ISubSystem subSystem)
getSystemFilterReferences in interface ISystemFilterContainerReferencesubSystem - the subsystem from which to get the filter references.
public ISystemFilterReference getSystemFilterReference(ISubSystem subSystem,
ISystemFilter filter)
getSystemFilterReference in interface ISystemFilterContainerReferencesubSystem - the subsystem in which to find or create the filter.filter - the filter to for which to create a reference.getExistingSystemFilterReference(ISubSystem, ISystemFilter)
public ISystemFilterReference getExistingSystemFilterReference(ISubSystem subSystem,
ISystemFilter filter)
getExistingSystemFilterReference in interface ISystemFilterContainerReferencesubSystem - the subsystem in which to look for the filter reference.filter - the filter for which to look.
getSystemFilterReference(ISubSystem, ISystemFilter)public boolean hasFilters()
hasFilters in interface ISystemFilterContainerReferencepublic int getFilterCount()
getFilterCount in interface ISystemFilterContainerReferencepublic String getName()
getName in interface ISystemFilterContainerReferencegetName in interface IRSEModelObjectpublic String toString()
toString in class Objectpublic int getSystemFilterStringCount()
getSystemFilterStringCount in interface ISystemFilterReferencepublic ISystemFilterStringReference[] getSystemFilterStringReferences()
getSystemFilterStringReferences in interface ISystemFilterReferencepublic ISystemFilterStringReference getSystemFilterStringReference(ISystemFilterString filterString)
getSystemFilterStringReference in interface ISystemFilterReferencepublic void setReferencedObject(IRSEBaseReferencedObject obj)
setReferencedObject in interface IRSEBaseReferencingObjectsetReferencedObject in class SystemReferencingObjectobj - the object to referencepublic IRSEBaseReferencedObject getReferencedObject()
getReferencedObject in interface IRSEBaseReferencingObjectgetReferencedObject in class SystemReferencingObjectpublic int removeReference()
removeReference in interface IRSEBaseReferencingObjectremoveReference in class SystemReferencingObjectpublic boolean hasContents(ISystemContentsType contentsType)
ISystemContainer
hasContents in interface ISystemContainercontentsType - type of contents
true if the object has contents, false otherwise.public Object[] getContents(ISystemContentsType contentsType)
ISystemContainer
getContents in interface ISystemContainercontentsType - type of contents
public void setContents(ISystemContentsType type,
Object[] cachedContents)
setContents in interface ISystemFilterReferencepublic boolean isStale()
ISystemContainer
isStale in interface ISystemContainerpublic void markStale(boolean isStale)
ISystemContainer
markStale in interface ISystemContainerisStale - whether the object is to be marked stale or not
public void markStale(boolean isStale,
boolean clearCache)
ISystemContainer
markStale in interface ISystemContainerisStale - whether the object is to be marked stale or notclearCache - indicates whether or not to clear the cachepublic boolean commit()
IRSEPersistableContainer
commit in interface IRSEPersistableContainerpublic IRSEPersistableContainer getPersistableParent()
IRSEPersistableContainer
getPersistableParent in interface IRSEPersistableContainerpublic IRSEPersistableContainer[] getPersistableChildren()
IRSEPersistableContainer
getPersistableChildren in interface IRSEPersistableContainerIRSEPersistableContainer.NO_CHILDREN.
|
RSE Release 3.0 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||