Eclipse RSE Development Guide (Galileo) - ISystemFilterPool (RSE API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

RSE
Release 3.0

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.rse.core.filters
Interface ISystemFilterPool

All Superinterfaces:: IPropertySetContainer, IRSEBasePersistableReferencedObject, IRSEBaseReferencedObject, IRSEModelObject, IRSEPersistableContainer, IRSEPersistableReferencedObject, IRSEReferencedObject, ISystemFilterContainer

public interface ISystemFilterPool
extends IRSEPersistableReferencedObject, ISystemFilterContainer, IRSEModelObject
extends IRSEPersistableReferencedObject, ISystemFilterContainer, IRSEModelObject

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

getProvider


ISystemFilterPoolManagerProvider getProvider()

Returns:: the object that instantiated the filter pool manager owning this filter pool

supportsNestedFilters

boolean supportsNestedFilters()

Returns:: true if filters in this pool support nested filters.

supportsDuplicateFilterStrings

boolean supportsDuplicateFilterStrings()

Returns:: true if filters in this pool supports duplicate filter strings.

isStringsCaseSensitive

boolean isStringsCaseSensitive()

Returns:: true if the filters in this pool are case sensitive

setSystemFilterPoolManager

void setSystemFilterPoolManager(
ISystemFilterPoolManager mgr)

Set the filter pool manager for this filter pool. Should only be done when the filter pool is created by the manager.

Parameters:: mgr - the manager of this filter pool

getSystemFilterPoolManager


ISystemFilterPoolManager getSystemFilterPoolManager()

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)

Set a data object to be associated with this filter pool. This data is uninterpreted by this filter pool.

Parameters:: data - the data object

getSystemFilterPoolData


Object getSystemFilterPoolData()

Returns:: the data object set using setFilterPoolData.

cloneSystemFilterPool

void cloneSystemFilterPool(
ISystemFilterPool targetPool)
                           throws 
Exception

Clone the attributes from this filter pool 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

Parameters:: targetPool - the filter pool that will receive the new attributes
Throws:: Exception

copySystemFilter


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

Copy a system filter to this or another filter pool.

Parameters:: targetPool - the receiving pool; oldFilter - the filter to copy; newName - the name which to give the new copy of the filter
Returns:: the newly created filter
Throws:: Exception

orderSystemFilters

void orderSystemFilters(
String[] names)

Order filters according to the names in the list. Typically used to enforce a particular ordering in the filter list. If a name appears in this list and does not name a filter it is ignored. If there are filters in this pool that are not named in this list their order in the pool is undefined.

Parameters:: names - the names of the filters in this pool in the order they should be returned.

getId


String getId()

Returns:: the id of the filter pool. Used for referencing this filter pool from filter pool references.

getName


String getName()

Specified by:: getName in interface IRSEModelObject

Returns:: The value of the Name attribute

setName

void setName(
String value)

Sets the filter pool name for this filter pool. Filter pool names must not contain 3 consecutive underscores "___" since these are used to separate profile names from filter pool names in a filter pool reference.

Parameters:: value - The new value of the Name attribute.
Throws:: IllegalArgumentException - if the name contains three consecutive underscore characters.

getType


String getType()

Returns:: The 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.

setType

void setType(
String value)

Parameters:: 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.

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 true if this is a 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)

Sets the attribute for this filter pool that determines whether strings of filters contained in this pool are case sensitive or not. If not set this attribute is inherited from the containing filter pool manager.

Parameters:: value - The new value of the StringsCaseSensitive attribute

unsetStringsCaseSensitive

void unsetStringsCaseSensitive()

Unsets the StringsCaseSensitive attribute. Causes the case sensitivity of the filter pool to be determined by its filter pool manager.

isSetStringsCaseSensitive

boolean isSetStringsCaseSensitive()

Returns:: true if the StringsCaseSensitive attribute has been set

getFilters


ISystemFilter[] getFilters()

Return the filters in this pool.

Returns:: An array of filters in this pool
Since:: org.eclipse.rse.core 3.0

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 The release in which this filter pool was initially 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 true then filters in this filter pool can have only a single filter string unless the filter has overriden this attribute.

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. 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.

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. Causes the value of the single filter string attribute to be inherited from the containing filter pool manager.

See Also:: isSetSingleFilterStringOnly(), isSingleFilterStringOnly(), setSingleFilterStringOnly(boolean)

isSetSingleFilterStringOnly

boolean isSetSingleFilterStringOnly()

Returns whether the value of the ' 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.

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()