org.eclipse.hyades.ui.filters
Interface IFilterQueryProvider

public interface IFilterQueryProvider

This interface is passed to an IFilterViewer object. The IFilterViewer implementor can then use the methods to get information about the filter or send information to the internal filtering code about the viewer.

Method Summary

SimpleSearchQuery	advancedQuery() Returns the current advanced tab filter applied to this IFilterViewer.
SimpleSearchQuery	getCurrentFilter() Returns the current filter applied to this IFilterViewer.
SimpleSearchQuery	standardQuery() Returns the current standard tab filter applied to this IFilterViewer.
void	updateAdvancedQuery(SimpleSearchQuery advancedQuery) Updates the advanced tab filter query with the given query and opens the filter dialog on the advanced tab.
void	updateAdvancedQuery(SimpleSearchQuery advancedQuery, int advancedTabSelectionIndex) Updates the advanced tab filter query with the given query and opens the filter dialog on the advanced tab.
void	updateStandardQuery(SimpleSearchQuery standardQuery) Updates the standard tab filter query with the given query and opens the filter dialog on the standard tab.
void	viewerDisposed() This method must be called when the class implementing IFilterViewer is disposed, so that the viewer can be dropped from the internal filter update listeners.

Method Detail

getCurrentFilter

SimpleSearchQuery getCurrentFilter()

Returns the current filter applied to this IFilterViewer. It is a merged query with the standard tab query and advanced tab query.

Returns:

returns a SimpleSearchQuery instance, being the current filter

standardQuery

SimpleSearchQuery standardQuery()

Returns the current standard tab filter applied to this IFilterViewer.

Returns:

returns a SimpleSearchQuery instance, being the current standard tab filter

advancedQuery

SimpleSearchQuery advancedQuery()

Returns the current advanced tab filter applied to this IFilterViewer.

Returns:

returns a SimpleSearchQuery instance, being the current advanced tab filter

updateStandardQuery

void updateStandardQuery(SimpleSearchQuery standardQuery)

Updates the standard tab filter query with the given query and opens the filter dialog on the standard tab.

Parameters:

standardQuery - a SimpleSearchQuery, the updated standard tab query instance

updateAdvancedQuery

void updateAdvancedQuery(SimpleSearchQuery advancedQuery)

Updates the advanced tab filter query with the given query and opens the filter dialog on the advanced tab.

Parameters:

advancedQuery - a SimpleSearchQuery, the updated advanced tab query instance

updateAdvancedQuery

void updateAdvancedQuery(SimpleSearchQuery advancedQuery,
                         int advancedTabSelectionIndex)

Updates the advanced tab filter query with the given query and opens the filter dialog on the advanced tab. When opening the advanced tab it selects the row in the advanced tab dialog with the given row index.

Parameters:

advancedQuery - a SimpleSearchQuery, the updated advanced tab query instance

advancedTabSelectionIndex - an integer, the row index to select when opening the advanced tab dialog

viewerDisposed

void viewerDisposed()

This method must be called when the class implementing IFilterViewer is disposed, so that the viewer can be dropped from the internal filter update listeners.