|
RSE Release 3.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ISystemFilter
A filter consists of filter strings and may be contained in a filter pool. Filter pools are referenced by subsystems. Subsystems are responsible for interpreting the filters. Filters, in and of themselves, provide no interpretation of themselves when applied to the resources managed by a subsystem.
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 | |
---|---|
ISystemFilterString |
addFilterString(String newString)
Append a new filter string to this filter's list of filter strings. |
ISystemFilterString |
addFilterString(String newString,
int position)
Insert a new filter string to this filter's list, at the given zero-based position. |
void |
clone(ISystemFilter targetFilter)
Clones a given filter to the given target filter. |
ISystemFilterString |
copySystemFilterString(ISystemFilter targetFilter,
ISystemFilterString oldFilterString)
Copies a given filter string from this filter to another filter in this pool or another pool in this manager or another manager. |
int |
getFilterStringCount()
|
String[] |
getFilterStrings()
|
String |
getName()
Returns the value of the 'Name' attribute. |
ISystemFilter[] |
getNestedFilters()
Returns the value of the 'Nested Filters' containment reference list. |
ISystemFilter |
getParentFilter()
Returns the value of the 'Parent Filter' container reference. |
ISystemFilterContainer |
getParentFilterContainer()
|
ISystemFilterPool |
getParentFilterPool()
|
ISystemFilterPoolManagerProvider |
getProvider()
|
int |
getRelativeOrder()
Returns the value of the 'Relative Order' attribute. |
int |
getRelease()
Returns the value of the 'Release' attribute. |
ISystemFilterString[] |
getStrings()
Returns the value of the 'Strings' containment reference list. |
Object |
getSubSystem()
Get the subsystem for this filter. |
ISystemFilterString |
getSystemFilterString(String string)
|
ISystemFilterString[] |
getSystemFilterStrings()
|
String |
getType()
Returns the value of the 'Type' attribute. |
boolean |
isDefault()
Returns the value of the 'Default' attribute. |
boolean |
isNested()
|
boolean |
isNonChangable()
Returns the value of the 'Non Changable' attribute. |
boolean |
isNonDeletable()
Returns the value of the 'Non Deletable' attribute. |
boolean |
isNonRenamable()
Returns the value of the 'Non Renamable' attribute. |
boolean |
isPromptable()
Returns the value of the 'Promptable' attribute. |
boolean |
isSetSingleFilterStringOnly()
Returns whether the value of the ' Single Filter String Only ' attribute is set. |
boolean |
isSetStringsCaseSensitive()
Returns whether the value of the ' Strings Case Sensitive ' attribute is set. |
boolean |
isSingleFilterStringOnly()
Returns the value of the 'Single Filter String Only' attribute. |
boolean |
isStringsCaseSensitive()
Returns the value of the 'Strings Case Sensitive' attribute. |
boolean |
isStringsNonChangable()
Returns the value of the 'Strings Non Changable' attribute. |
boolean |
isSupportsDuplicateFilterStrings()
Returns the value of the 'Supports Duplicate Filter Strings' attribute. |
boolean |
isSupportsNestedFilters()
Returns the value of the 'Supports Nested Filters' attribute. |
boolean |
isTransient()
|
void |
moveSystemFilterString(int pos,
ISystemFilterString filterString)
Move a given filter string to a given zero-based location. |
ISystemFilterString |
removeFilterString(int position)
Remove a filter string from this filter's list, given its zero-based position |
boolean |
removeFilterString(ISystemFilterString filterString)
Remove a filter string from this filter's list, given its SystemFilterString object. |
ISystemFilterString |
removeFilterString(String oldString)
Delete a filter string from this filter's list. |
void |
setDefault(boolean value)
Sets the value of the ' Default ' attribute. |
void |
setFilterStrings(String[] strings)
Set this filter's filter strings by giving an array of String objects. |
void |
setName(String value)
Sets the value of the ' Name ' attribute. |
void |
setNonChangable(boolean value)
Sets the value of the ' Non Changable ' attribute. |
void |
setNonDeletable(boolean value)
Sets the value of the ' Non Deletable ' attribute. |
void |
setNonRenamable(boolean value)
Sets the value of the ' Non Renamable ' attribute. |
void |
setParentFilter(ISystemFilter value)
Sets the value of the ' Parent Filter ' container reference. |
void |
setParentFilterPool(ISystemFilterPool parentPool)
Internal use method to set the parent filter pool. |
void |
setPromptable(boolean value)
Sets the value of the ' Promptable ' attribute. |
void |
setRelativeOrder(int value)
Sets the value of the ' Relative Order ' attribute. |
void |
setRelease(int value)
Sets the value of the ' Release ' attribute. |
void |
setSingleFilterStringOnly(boolean value)
Sets the value of the ' Single Filter String Only ' attribute. |
void |
setStringsCaseSensitive(boolean value)
Sets the value of the ' Strings Case Sensitive ' attribute. |
void |
setStringsNonChangable(boolean value)
Sets the value of the ' Strings Non Changable ' attribute. |
void |
setSubSystem(ISubSystem subsystem)
Set the subsytem of this filter. |
void |
setSupportsDuplicateFilterStrings(boolean value)
Sets the value of the ' Supports Duplicate Filter Strings ' attribute. |
void |
setSupportsNestedFilters(boolean value)
Sets the value of the ' Supports Nested Filters ' attribute. |
void |
setType(String value)
Sets the value of the ' Type ' attribute. |
boolean |
supportsDuplicateFilterStrings()
Does this support duplicate filter strings? |
void |
unsetSingleFilterStringOnly()
Unsets the value of the ' Single Filter String Only ' attribute. |
void |
unsetStringsCaseSensitive()
Unsets the value of the ' Strings Case Sensitive ' attribute. |
void |
updateFilterString(ISystemFilterString filterString,
String newValue)
Update a new filter string's string value. |
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, getSystemFilterPoolManager, 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, clonePropertySets, 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 |
---|
String getName()
This is the name of the filter. It may be present in the user interface and is also used to refer to the filter when it is persisted.
getName
in interface IRSEModelObject
setName(String)
void setName(String value)
Name
' attribute.
This is the name of the filter. It may be present in the user interface and is also
used to refer to the filter when it is persisted.
value
- the new value of the 'Name' attribute.getName()
String getType()
Filters may be further typed for use by subsystems. The type is also uninterpreted by the filter. The type may be used to select a parser/interpreter for the filter strings.
setType(String)
void setType(String value)
Type
' attribute.
Filters may be further typed for use by subsystems. The type is also uninterpreted by the
filter. The type may be used to select a parser/interpreter for the filter strings.
value
- the new value of the 'Type' attribute.getType()
boolean isSupportsNestedFilters()
Specifies whether filters may be nested or not. If nested the intent is to apply this filter to the results of the parent filter - further restricting the resources selected by the parent filter. However, it is up to the subsystem to interpret exactly what "nesting" means.
setSupportsNestedFilters(boolean)
void setSupportsNestedFilters(boolean value)
Supports Nested Filters
' attribute.
Specifies whether filters may be nested or not. If nested the intent is to apply this filter to the results of the parent filter - further restricting the resources selected by the parent filter. However, it is up to the subsystem to interpret exactly what "nesting" means.
value
- the new value of the 'Supports Nested Filters' attribute.isSupportsNestedFilters()
int getRelativeOrder()
The relative order of a filter is intended to be used by a persistence mechanism to keep the filters in a particular order when restoring them into a filter pool. Filters with higher numbers should occur later in the pool. It may be employed in the absence of another mechanism for maintaining order.
setRelativeOrder(int)
void setRelativeOrder(int value)
Relative Order
' attribute.
The relative order of a filter is intended to be used
by a persistence mechanism to keep the filters in a particular order
when restoring them into a filter pool. Filters with higher numbers should
occur later in the pool. It may be employed in the absence of another
mechanism for maintaining order.
value
- the new value of the 'Relative Order' attribute.getRelativeOrder()
boolean isDefault()
This filter is a "default" filter in this filter pool. The meaning of "default" is determined by the subsystem in which it is deployed. It typically means that the filter is supplied by the subsystem at the time the subsystem is created. That is, the filter is "vendor supplied". There is no restriction on the number of default filters in a pool.
setDefault(boolean)
void setDefault(boolean value)
Default
' attribute.
Make this filter is a "default" filter in this filter pool.
The meaning of "default" is determined by the subsystem in which it is deployed.
It typically means that the filter is supplied by the subsystem at the time the subsystem is created.
That is, the filter is "vendor supplied".
There is no restriction on the number of default filters in a pool.
value
- the new value of the 'Default' attribute.isDefault()
boolean isStringsCaseSensitive()
An attribute that may be used by the subystems when interpreting the filter. Used to indicate whether or not comparisons involving the filter should be considered case sensitive. This attribute is optional and may be known (set) or unknown (unset).
If unset the value returned is from the parent filter pool.
isSetStringsCaseSensitive()
,
unsetStringsCaseSensitive()
,
setStringsCaseSensitive(boolean)
void setStringsCaseSensitive(boolean value)
Strings Case Sensitive
' attribute.
An attribute that may be used by the subystems when interpreting the filter. Used to indicate whether or not comparisons involving the filter should be considered case sensitive. This attribute is optional and may be known (set) or unknown (unset).
This will cause this attribute to be set in this filter.
value
- the new value of the 'Strings Case Sensitive' attribute.isSetStringsCaseSensitive()
,
unsetStringsCaseSensitive()
,
isStringsCaseSensitive()
void unsetStringsCaseSensitive()
Strings Case Sensitive
' attribute.
An attribute that may be used by the subystems when interpreting the filter. Used to indicate whether or not comparisons involving the filter should be considered case sensitive. This attribute is optional and may be known (set) or unknown (unset).
Causes this filter to use the value specified by the parent filter pool.
isSetStringsCaseSensitive()
,
isStringsCaseSensitive()
,
setStringsCaseSensitive(boolean)
boolean isSetStringsCaseSensitive()
Strings Case Sensitive
' attribute is set.
An attribute that may be used by the subystems when interpreting the filter. Used to indicate whether or not comparisons involving the filter should be considered case sensitive. This attribute is optional and may be known (set) or unknown (unset).
This will be true if this attribute is explicitly specified for this filter. It will be false if this is being inherited from the parent filter pool.
unsetStringsCaseSensitive()
,
isStringsCaseSensitive()
,
setStringsCaseSensitive(boolean)
boolean isPromptable()
An attribute that may be used by the subystems when interpreting the filter. Typically used to indicate whether or not some sort of prompting is to occur when the filter is used. Typically used when applying a filter in the UI to indicate the start of a wizard or dialog. It may also have an effect on whether the state of the filter is saved when the workbench is shut down.
setPromptable(boolean)
void setPromptable(boolean value)
Promptable
' attribute.
An attribute that may be used by the subystems when interpreting the filter. Typically used to indicate whether or not some sort of prompting is to occur when the filter is used. Typically used when applying a filter in the UI to indicate the start of a wizard or dialog. It may also have an effect on whether the state of the filter is saved when the workbench is shut down.
value
- the new value of the 'Promptable' attribute.isPromptable()
boolean isSupportsDuplicateFilterStrings()
This attribute may be used by subsystems when interpreting the filter. Typically used when adding filter strings to the filter or as a hint when applying the filter to the resources understood by the subsystem.
setSupportsDuplicateFilterStrings(boolean)
boolean supportsDuplicateFilterStrings()
isSupportsDuplicateFilterStrings()
.
void setSupportsDuplicateFilterStrings(boolean value)
Supports Duplicate Filter Strings
' attribute.
This attribute may be used by subsystems when interpreting the filter. Typically used when adding filter strings to the filter or as a hint when applying the filter to the resources understood by the subsystem.
value
- the new value of the 'Supports Duplicate Filter Strings' attribute.isSupportsDuplicateFilterStrings()
boolean isNonDeletable()
An attribute that can be used when managing filters in filter pools. Some filters should not be deleted.
setNonDeletable(boolean)
void setNonDeletable(boolean value)
Non Deletable
' attribute.
An attribute that can be used when managing filters in filter pools. Some filters should not be deleted.
value
- the new value of the 'Non Deletable' attribute.isNonDeletable()
boolean isNonRenamable()
An attribute that can be used when managing filters in filter pools. Some filters should not be renamed.
setNonRenamable(boolean)
void setNonRenamable(boolean value)
Non Renamable
' attribute.
An attribute that can be used when managing filters in filter pools. Some filters should not be renamed.
value
- the new value of the 'Non Renamable' attribute.isNonRenamable()
boolean isNonChangable()
An attribute that can be used when managing filters in filter pools. Some filters should not be modifiable.
setNonChangable(boolean)
void setNonChangable(boolean value)
Non Changable
' attribute.
An attribute that can be used when managing filters in filter pools. Some filters should not be modifiable.
value
- the new value of the 'Non Changable' attribute.isNonChangable()
boolean isStringsNonChangable()
An attribute that can be used when managing filters in filter pools. Some filters contain filter strings that should not be modifiable.
setStringsNonChangable(boolean)
void setStringsNonChangable(boolean value)
Strings Non Changable
' attribute.
An attribute that can be used when managing filters in filter pools. Some filters contain filter strings that should not be modifiable.
value
- the new value of the 'Strings Non Changable' attribute.isStringsNonChangable()
int getRelease()
This is an attribute specifying the release level of the filter. This will be persisted in the filter definition and can be used to migrate the internal form of the filter.
setRelease(int)
void setRelease(int value)
Release
' attribute.
This is an attribute specifying the release level of the filter. This will be persisted in the filter definition and can be used to migrate the internal form of the filter.
value
- the new value of the 'Release' attribute.getRelease()
boolean isSingleFilterStringOnly()
This attribute specifies that the filter may contain only a single filter string. Used by a filter manager to ensure that the filter contains only one string. May, alternatively, be enforced by the filter implementation.
This attribute may be set or unset. If unset this value will be inherited from the parent filter pool.
isSetSingleFilterStringOnly()
,
unsetSingleFilterStringOnly()
,
setSingleFilterStringOnly(boolean)
void setSingleFilterStringOnly(boolean value)
Single Filter String Only
' attribute.
This attribute specifies that the filter may contain only a single filter string. Used by a filter manager to ensure that the filter contains only one string. May, alternatively, be enforced by the filter implementation.
This causes the attribute to be set for this filter, ignoring the value specified for the parent filter pool.
value
- the new value of the 'Single Filter String Only' attribute.isSetSingleFilterStringOnly()
,
unsetSingleFilterStringOnly()
,
isSingleFilterStringOnly()
void unsetSingleFilterStringOnly()
Single Filter String Only
' attribute.
This causes the value of this attribute to be inherited from the parent filter pool.
isSetSingleFilterStringOnly()
,
isSingleFilterStringOnly()
,
setSingleFilterStringOnly(boolean)
boolean isSetSingleFilterStringOnly()
Single Filter String Only
' attribute is set.
If true then the value of this attribute is set in this filter. If false it is inherited from the parent filter pool.
unsetSingleFilterStringOnly()
,
isSingleFilterStringOnly()
,
setSingleFilterStringOnly(boolean)
ISystemFilter[] getNestedFilters()
Parent Filter
'.
If this filter can contain child filters this will return the list of children.
getParentFilter()
ISystemFilter getParentFilter()
Nested Filters
'.
If this filter can be nested inside another this will return the parent filter. Will be null if there is no parent.
setParentFilter(ISystemFilter)
,
getNestedFilters()
void setParentFilter(ISystemFilter value)
Parent Filter
' container reference.
This is used by a filter manager to set the parent filter when one filter is nested inside another.
value
- the new value of the 'Parent Filter' container reference.getParentFilter()
ISystemFilterString[] getStrings()
ISystemFilterPool getParentFilterPool()
void setParentFilterPool(ISystemFilterPool parentPool)
parentPool
- the filter pool that contains or will contain this filter.void setFilterStrings(String[] strings)
strings
- the array of String objects.String[] getFilterStrings()
ISystemFilterString[] getSystemFilterStrings()
int getFilterStringCount()
ISystemFilterString getSystemFilterString(String string)
ISystemFilterString addFilterString(String newString)
newString
- the string to appendISystemFilterString addFilterString(String newString, int position)
newString
- the string from which to construct the filter string to be added.position
- the zero-based position at which to add the string.void updateFilterString(ISystemFilterString filterString, String newValue)
filterString
- the string update.newValue
- the new value of that string.ISystemFilterString removeFilterString(String oldString)
oldString
- the string to remove
ISystemFilterString removeFilterString(int position)
position
- the position of the filter string.
boolean removeFilterString(ISystemFilterString filterString)
filterString
- the filterString to be removed.
void moveSystemFilterString(int pos, ISystemFilterString filterString)
pos
- the new position of this filter stringfilterString
- the filter string to moveISystemFilterString copySystemFilterString(ISystemFilter targetFilter, ISystemFilterString oldFilterString)
targetFilter
- the filter to which to copy the filter stringoldFilterString
- the filter string to copyboolean isNested()
boolean isTransient()
void setSubSystem(ISubSystem subsystem)
subsystem
- a subsystem associated with this transient filterObject getSubSystem()
void clone(ISystemFilter targetFilter)
targetFilter
- new filter into which all the data of this filter will be copied.ISystemFilterContainer getParentFilterContainer()
ISystemFilterPoolManagerProvider getProvider()
|
RSE Release 3.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |