org.eclipse.rse.core.filters
Interface ISystemFilterPool

All Superinterfaces:

IPropertySetContainer, IRSEBasePersistableReferencedObject, IRSEBaseReferencedObject, IRSEModelObject, IRSEPersistableContainer, IRSEPersistableReferencedObject, IRSEReferencedObject, ISystemFilterContainer

public interface ISystemFilterPool
extends IRSEPersistableReferencedObject, ISystemFilterContainer, IRSEModelObject

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 this filter pools' attributes and filters into another filter pool.
ISystemFilter	copySystemFilter(ISystemFilterPool targetPool, ISystemFilter oldFilter, String newName) Copy a system filter to this or another filter pool.
List	getFilters()
String	getId()
String	getName()
IRSEFilterNamingPolicy	getNamingPolicy() Get the naming policy currently used when saving data to disk.
String	getOwningParentName() Returns the value of the 'Owning Parent Name' attribute
ISystemFilterPoolManagerProvider	getProvider() Return the caller which instantiated the filter pool manager overseeing this filter framework instance
int	getRelease()
Object	getSystemFilterPoolData() Return transient data set via setFilterPoolData.
ISystemFilterPoolManager	getSystemFilterPoolManager() Return the filter pool manager managing this collection of filter pools and their filters.
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 user preferences.
void	setDefault(boolean value)
void	setDeletable(boolean value)
void	setName(String value)
void	setNamingPolicy(IRSEFilterNamingPolicy namingPolicy) Set the naming policy used when saving data to disk.
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	setSavePolicy(int policy) Set the save file policy.
void	setSingleFilterStringOnly(boolean value) Sets the value of the 'Single Filter String Only' attribute
void	setStringsCaseSensitive(boolean value)
void	setSupportsDuplicateFilterStrings(boolean value)
void	setSupportsNestedFilters(boolean value)
void	setSystemFilterPoolData(Object data) This is to set transient data that is queryable via getFilterPoolData
void	setSystemFilterPoolManager(ISystemFilterPoolManager mgr) Set the filter pool manager.
void	setType(String value)
boolean	supportsDuplicateFilterStrings() Does this support duplicate filter strings?
boolean	supportsNestedFilters() Does this filter support nested filters?
void	unsetSingleFilterStringOnly() Unsets the value of the 'Single Filter String Only' attribute
void	unsetStringsCaseSensitive()

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, getSystemFiltersVector, 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

getProvider

ISystemFilterPoolManagerProvider getProvider()

Return the caller which instantiated the filter pool manager overseeing this filter framework instance

setNamingPolicy

void setNamingPolicy(IRSEFilterNamingPolicy namingPolicy)

Set the naming policy used when saving data to disk.

See Also:

IRSEFilterNamingPolicy

getNamingPolicy

IRSEFilterNamingPolicy getNamingPolicy()

Get the naming policy currently used when saving data to disk.

See Also:

IRSEFilterNamingPolicy

supportsNestedFilters

boolean supportsNestedFilters()

Does this filter support nested filters?

supportsDuplicateFilterStrings

boolean supportsDuplicateFilterStrings()

Does this support duplicate filter strings? Calls mof-generated isSupportsDuplicateFilterStrings.

isStringsCaseSensitive

boolean isStringsCaseSensitive()

Returns:

The value of the StringsCaseSensitive attribute Are filter strings in this filter case sensitive? If not set locally, queries the parent filter pool manager's atttribute.

setSystemFilterPoolManager

void setSystemFilterPoolManager(ISystemFilterPoolManager mgr)

Set the filter pool manager.

getSystemFilterPoolManager

ISystemFilterPoolManager getSystemFilterPoolManager()

Return the filter pool manager managing this collection of filter pools and their filters.

Specified by:

getSystemFilterPoolManager in interface ISystemFilterContainer

Returns:

the filter pool manager managing this collection of filter pools and their filters.

setSystemFilterPoolData

void setSystemFilterPoolData(Object data)

This is to set transient data that is queryable via getFilterPoolData

getSystemFilterPoolData

Object getSystemFilterPoolData()

Return transient data set via setFilterPoolData.

cloneSystemFilterPool

void cloneSystemFilterPool(ISystemFilterPool targetPool)
                           throws Exception

Clone this filter pools' attributes and filters into another filter pool. Assumes the core attributes were already set when filter pool was created:

• Name
• Deletable
• Supports nested filters
• Manager

Attributes we clone:

• Data
• Type
• Default

Throws:

Exception

copySystemFilter

ISystemFilter copySystemFilter(ISystemFilterPool targetPool,
                               ISystemFilter oldFilter,
                               String newName)
                               throws Exception

Copy a system filter to this or another filter pool.

Throws:

Exception

orderSystemFilters

void orderSystemFilters(String[] names)

Order filters according to user preferences.

While the framework has all the code necessary to arrange filters and save/restore that arrangement, you may choose to use preferences instead of this support. In this case, call this method and pass in the saved and sorted filter name list.

Called by someone after restore.

setSavePolicy

void setSavePolicy(int policy)

Set the save file policy. See constants in SystemFilterConstants. One of:

• SAVE_POLICY_ONE_FILE_PER_POOL
• SAVE_POLICY_ONE_FILE_PER_FILTER

This method is called by the SystemFilterPoolManager.

getId

String getId()

getName

String getName()

Specified by:

getName in interface IRSEModelObject

Returns:

The value of the Name attribute

setName

void setName(String value)

Parameters:

value - The new value of the Name attribute

getType

String getType()

Returns:

The value of the Type attribute Allows tools to have typed filter pools

setType

void setType(String value)

Parameters:

value - The new value of the Type attribute

isSupportsNestedFilters

boolean isSupportsNestedFilters()

Returns:

The value of the SupportsNestedFilters attribute

setSupportsNestedFilters

void setSupportsNestedFilters(boolean value)

Parameters:

value - The new value of the SupportsNestedFilters attribute

isDeletable

boolean isDeletable()

Returns:

The value of the Deletable attribute

setDeletable

void setDeletable(boolean value)

Parameters:

value - The new value of the Deletable attribute

isDefault

boolean isDefault()

Returns:

The value of the Default attribute Is this a default vendor-supplied pool versus user-created pool

setDefault

void setDefault(boolean value)

Parameters:

value - The new value of the Default attribute

setStringsCaseSensitive

void setStringsCaseSensitive(boolean value)

Parameters:

value - The new value of the StringsCaseSensitive attribute

unsetStringsCaseSensitive

void unsetStringsCaseSensitive()

isSetStringsCaseSensitive

boolean isSetStringsCaseSensitive()

Returns:

true if the StringsCaseSensitive attribute has been set

getFilters

List getFilters()

Returns:

The list of Filters references

isSupportsDuplicateFilterStrings

boolean isSupportsDuplicateFilterStrings()

Returns:

The value of the SupportsDuplicateFilterStrings attribute

setSupportsDuplicateFilterStrings

void setSupportsDuplicateFilterStrings(boolean value)

Parameters:

value - The new value of the SupportsDuplicateFilterStrings attribute

getRelease

int getRelease()

Returns:

The value of the Release attribute In what release was this created? Typically, will be the version and release times 10, as in 40 or 51.

setRelease

void setRelease(int value)

Parameters:

value - The new value of the Release attribute

isSingleFilterStringOnly

boolean isSingleFilterStringOnly()

Returns the value of the 'Single Filter String Only' attribute.

If the meaning of the 'Single Filter String Only' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Single Filter String Only' attribute.

See Also:

isSetSingleFilterStringOnly(), unsetSingleFilterStringOnly(), setSingleFilterStringOnly(boolean)

setSingleFilterStringOnly

void setSingleFilterStringOnly(boolean value)

Sets the value of the 'Single Filter String Only' attribute.

Parameters:

value - the new value of the 'Single Filter String Only' attribute.

See Also:

isSetSingleFilterStringOnly(), unsetSingleFilterStringOnly(), isSingleFilterStringOnly()

unsetSingleFilterStringOnly

void unsetSingleFilterStringOnly()

Unsets the value of the 'Single Filter String Only' attribute.

See Also:

isSetSingleFilterStringOnly(), isSingleFilterStringOnly(), setSingleFilterStringOnly(boolean)

isSetSingleFilterStringOnly

boolean isSetSingleFilterStringOnly()

Returns whether the value of the 'Single Filter String Only' attribute is set.

Returns:

whether the value of the 'Single Filter String Only' attribute is set.

See Also:

unsetSingleFilterStringOnly(), isSingleFilterStringOnly(), setSingleFilterStringOnly(boolean)

getOwningParentName

String getOwningParentName()

Returns the value of the 'Owning Parent Name' attribute.

If the meaning of the 'Owning Parent Name' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Owning Parent Name' attribute.

See Also:

setOwningParentName(String)

setOwningParentName

void setOwningParentName(String value)

Sets the value of the 'Owning Parent Name' attribute.

Parameters:

value - the new value of the 'Owning Parent Name' attribute.

See Also:

getOwningParentName()

isNonRenamable

boolean isNonRenamable()

Returns the value of the 'Non Renamable' attribute.

If the meaning of the 'Non Renamable' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Non Renamable' attribute.

See Also:

setNonRenamable(boolean)

setNonRenamable

void setNonRenamable(boolean value)

Sets the value of the 'Non Renamable' attribute.

Parameters:

value - the new value of the 'Non Renamable' attribute.

See Also:

isNonRenamable()