|
RSE Release 3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ISystemFilterPool
This interface represents a system filter pool, which is a means of grouping filters to be referenced together.
Field Summary |
---|
Fields inherited from interface org.eclipse.rse.core.model.IRSEPersistableContainer |
---|
NO_CHILDREN |
Fields inherited from interface org.eclipse.rse.core.model.IRSEPersistableContainer |
---|
NO_CHILDREN |
Method Summary | |
---|---|
void |
cloneSystemFilterPool(ISystemFilterPool targetPool)
Clone the attributes from this filter pool into another filter pool. |
ISystemFilter |
copySystemFilter(ISystemFilterPool targetPool,
ISystemFilter oldFilter,
String newName)
Copy a system filter to this or another filter pool. |
ISystemFilter[] |
getFilters()
Return the filters in this pool. |
String |
getId()
|
String |
getName()
|
String |
getOwningParentName()
Returns the value of the 'Owning Parent Name' attribute. |
ISystemFilterPoolManagerProvider |
getProvider()
|
int |
getRelease()
|
Object |
getSystemFilterPoolData()
|
ISystemFilterPoolManager |
getSystemFilterPoolManager()
|
String |
getType()
|
boolean |
isDefault()
|
boolean |
isDeletable()
|
boolean |
isNonRenamable()
Returns the value of the 'Non Renamable' attribute. |
boolean |
isSetSingleFilterStringOnly()
Returns whether the value of the ' Single Filter String Only ' attribute is set. |
boolean |
isSetStringsCaseSensitive()
|
boolean |
isSingleFilterStringOnly()
Returns the value of the 'Single Filter String Only' attribute. |
boolean |
isStringsCaseSensitive()
|
boolean |
isSupportsDuplicateFilterStrings()
|
boolean |
isSupportsNestedFilters()
|
void |
orderSystemFilters(String[] names)
Order filters according to the names in the list. |
void |
setDefault(boolean value)
|
void |
setDeletable(boolean value)
|
void |
setName(String value)
Sets the filter pool name for this filter pool. |
void |
setNonRenamable(boolean value)
Sets the value of the ' Non Renamable ' attribute. |
void |
setOwningParentName(String value)
Sets the value of the ' Owning Parent Name ' attribute. |
void |
setRelease(int value)
|
void |
setSingleFilterStringOnly(boolean value)
Sets the value of the ' Single Filter String Only ' attribute. |
void |
setStringsCaseSensitive(boolean value)
Sets the attribute for this filter pool that determines whether strings of filters contained in this pool are case sensitive or not. |
void |
setSupportsDuplicateFilterStrings(boolean value)
|
void |
setSupportsNestedFilters(boolean value)
|
void |
setSystemFilterPoolData(Object data)
Set a data object to be associated with this filter pool. |
void |
setSystemFilterPoolManager(ISystemFilterPoolManager mgr)
Set the filter pool manager for this filter pool. |
void |
setType(String value)
|
boolean |
supportsDuplicateFilterStrings()
|
boolean |
supportsNestedFilters()
|
void |
unsetSingleFilterStringOnly()
Unsets the value of the ' Single Filter String Only ' attribute. |
void |
unsetStringsCaseSensitive()
Unsets the StringsCaseSensitive attribute. |
Methods inherited from interface org.eclipse.rse.core.references.IRSEBaseReferencedObject |
---|
addReference, getReferenceCount, getReferencingObjects, removeAllReferences, removeReference |
Methods inherited from interface org.eclipse.rse.core.references.IRSEBasePersistableReferencedObject |
---|
getReferenceName |
Methods inherited from interface org.eclipse.rse.core.references.IRSEBaseReferencedObject |
---|
addReference, getReferenceCount, getReferencingObjects, removeAllReferences, removeReference |
Methods inherited from interface org.eclipse.rse.core.filters.ISystemFilterContainer |
---|
addSystemFilter, areStringsCaseSensitive, createSystemFilter, deleteSystemFilter, getSystemFilter, getSystemFilterCount, getSystemFilterNames, getSystemFilterPool, getSystemFilterPosition, getSystemFilters, moveSystemFilter, renameSystemFilter, updateSystemFilter |
Methods inherited from interface org.eclipse.rse.core.model.IRSEPersistableContainer |
---|
commit, getPersistableChildren, getPersistableParent, isDirty, isTainted, setDirty, setTainted, setWasRestored, wasRestored |
Methods inherited from interface org.eclipse.rse.core.model.IRSEModelObject |
---|
getDescription |
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 |
---|
commit, getPersistableChildren, getPersistableParent, isDirty, isTainted, setDirty, setTainted, setWasRestored, wasRestored |
Method Detail |
---|
ISystemFilterPoolManagerProvider getProvider()
boolean supportsNestedFilters()
boolean supportsDuplicateFilterStrings()
boolean isStringsCaseSensitive()
void setSystemFilterPoolManager(ISystemFilterPoolManager mgr)
mgr
- the manager of this filter poolISystemFilterPoolManager getSystemFilterPoolManager()
getSystemFilterPoolManager
in interface ISystemFilterContainer
void setSystemFilterPoolData(Object data)
data
- the data objectObject getSystemFilterPoolData()
void cloneSystemFilterPool(ISystemFilterPool targetPool) throws Exception
targetPool
- the filter pool that will receive the new attributes
Exception
ISystemFilter copySystemFilter(ISystemFilterPool targetPool, ISystemFilter oldFilter, String newName) throws Exception
targetPool
- the receiving poololdFilter
- the filter to copynewName
- the name which to give the new copy of the filter
Exception
void orderSystemFilters(String[] names)
names
- the names of the filters in this pool in the order they should be returned.String getId()
String getName()
getName
in interface IRSEModelObject
void setName(String value)
value
- The new value of the Name attribute.
IllegalArgumentException
- if the name contains three consecutive underscore characters.String getType()
void setType(String value)
value
- The new value of the Type attribute
Allows tools to have typed filter pools.
Type is not interpreted by the filter pool, but may be used by a subsystem.boolean isSupportsNestedFilters()
void setSupportsNestedFilters(boolean value)
value
- The new value of the SupportsNestedFilters attributeboolean isDeletable()
void setDeletable(boolean value)
value
- The new value of the Deletable attributeboolean isDefault()
void setDefault(boolean value)
value
- The new value of the Default attributevoid setStringsCaseSensitive(boolean value)
value
- The new value of the StringsCaseSensitive attributevoid unsetStringsCaseSensitive()
boolean isSetStringsCaseSensitive()
ISystemFilter[] getFilters()
boolean isSupportsDuplicateFilterStrings()
void setSupportsDuplicateFilterStrings(boolean value)
value
- The new value of the SupportsDuplicateFilterStrings attributeint getRelease()
void setRelease(int value)
value
- The new value of the Release attributeboolean isSingleFilterStringOnly()
If true then filters in this filter pool can have only a single filter string unless the filter has overriden this attribute.
isSetSingleFilterStringOnly()
,
unsetSingleFilterStringOnly()
,
setSingleFilterStringOnly(boolean)
void setSingleFilterStringOnly(boolean value)
Single Filter String Only
' attribute.
If set to true filters in this filter pool can hold only a single filter string unless overridden by the filter itself.
If false then the filter may hold more than one filter string.
value
- the new value of the 'Single Filter String Only' attribute.isSetSingleFilterStringOnly()
,
unsetSingleFilterStringOnly()
,
isSingleFilterStringOnly()
void unsetSingleFilterStringOnly()
Single Filter String Only
' attribute.
Causes the value of the single filter string attribute to be inherited from the containing filter pool manager.
isSetSingleFilterStringOnly()
,
isSingleFilterStringOnly()
,
setSingleFilterStringOnly(boolean)
boolean isSetSingleFilterStringOnly()
Single Filter String Only
' attribute is set.
This will be true if this attribute has been set for this filter pool. It will be false if this
attribute is inherited from the filter pool manager.
unsetSingleFilterStringOnly()
,
isSingleFilterStringOnly()
,
setSingleFilterStringOnly(boolean)
String getOwningParentName()
If the meaning of the 'Owning Parent Name' attribute isn't clear, there really should be more of a description here...
setOwningParentName(String)
void setOwningParentName(String value)
Owning Parent Name
' attribute.
value
- the new value of the 'Owning Parent Name' attribute.getOwningParentName()
boolean isNonRenamable()
If the meaning of the 'Non Renamable' attribute isn't clear, there really should be more of a description here...
setNonRenamable(boolean)
void setNonRenamable(boolean value)
Non Renamable
' attribute.
value
- the new value of the 'Non Renamable' attribute.isNonRenamable()
|
RSE Release 3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |