*** This class is subject to change ***

com.sas.dataselectors.filters
Interface AdvancedFilterModelInterface

All Superinterfaces:

AdvancedFilterDefinitionModelInterface, SimpleFilterDefinitionModelInterface

All Known Implementing Classes:

DefaultAdvancedFilterModelAdapter

public interface AdvancedFilterModelInterface

extends AdvancedFilterDefinitionModelInterface

This interface defines the relationship between the AdvancedFilterPanel and an implemented adaptor.

See Also:

SimpleFilterDefinitionModelInterface, SimpleFilterListEditorModelInterface

Method Summary

boolean	addSelection(FilterLogicTestNodeInterface value) adds a new selection to the end of the FilterLogicList (cursor position undefined after an add)
FilterValueInterface	applyExpressionValueEditorChanges(FilterLogicTestNodeInterface testNode, int valueIndex) Applies the changes made in the ExpressionValueEditor to the given FilterLogicTestNodeInterface.
FilterItemInterface	applyFilterItemEditorChanges(FilterLogicTestNodeInterface testNode) Applies the changes made in the FilterItemEditor to the given FilterLogicTestNodeInterface.
FilterQualifierInterface	applyFilterQualifierEditorChanges(FilterLogicTestNodeInterface testNode) Applies the changes made in the FilterQualifierEditor to the given FilterLogicTestNodeInterface.
FilterValueInterface	applyPromptValueEditorChanges(FilterLogicTestNodeInterface testNode, int valueIndex) Applies the changes made in the PromptValueEditor to the given FilterLogicTestNodeInterface.
void	cancel() Returns the filter model to its initial state.
void	clear() Clear the filter selection model and commit the changes.
void	clear(boolean commit) Clear the filter selection model and optionally commit the changes.
ExpressionValueEditorInterface	getExpressionValueEditor() Returns the editor to use to edit an expression value.
String	getFilterDescription() Gets the description for the overall filter.
FilterItemEditorInterface	getFilterItemEditor() Returns the editor to use to edit a filter item.
String	getFilterLabel() Returns the label for the overall filter.
FilterLogicListInterface	getFilterLogicList() Returns a java.util.List of test nodes.
QualifiersEditorInterface	getFilterQualifierEditor() Returns the editor to use to edit a filter qualifier.
Locale	getLocale() Returns the Locale currently set on the model.
int	getMaxOutputObservations() Returns the current maximum number of output observations returned when gathering a list of possible values to select from when creating a filter expression.
PromptValueEditorInterface	getPromptValueEditor() Returns the editor to use to edit a prompt value.
List	getPromptValueList(Object testNode) Returns a List containing all known prompts filter values.
Map	getPromptValueMap() Returns a Map containing all known prompts using their names for keys.
int	getSelectionCount() get the number of selectable entries in the model.
int	getSelectionCursor() get the index of the model cursor
SimpleFilterLogicTreeInterface	getSelectionTree() Returns a tree model that defines a single compound filter.
boolean	isEditedExpressionValue(Object value) Returns TRUE if the given object represents a value that was created by the expression editor.
boolean	isPromptedValue(Object value) Returns TRUE if the given object represents a prompted value.
boolean	isQuotedValue(Object value) Returns TRUE if the given object represents a value that will be quoted during query generation.
boolean	isUserCreatedValue(Object value) Returns TRUE if the given object represents a value that was created by a user entering a String expression value in the filter selector.
boolean	isValidFilter(FilterLogicTestNodeInterface testNode) Validates the filter.
void	removeSelection() removes the current selection from the FilterLogicList (cursor position is undefined after remove)
void	setExpressionValueEditor(ExpressionValueEditorInterface editor) Sets the editor to use to edit an expression value.
void	setExpressionValueEditorInfo(FilterLogicTestNodeInterface testNode, int valueIndex) Prepares the ExpressionValueEditor to edit the current filter value based on the given FilterLogicTestNodeInterface.
void	setFilterDescription(String value) Sets the description for the overall filter.
void	setFilterItemEditor(FilterItemEditorInterface editor) Sets the editor to use to edit a filter item.
void	setFilterItemEditorInfo(FilterLogicTestNodeInterface testNode) Prepares the FilterItemEditor to edit the current filter value based on the given FilterLogicTestNodeInterface.
void	setFilterLabel(String label) Sets the label for the overall filter.
void	setFilterQualifierEditor(QualifiersEditorInterface editor) Sets the editor to use to edit a filter qualifier.
void	setFilterQualifierEditorInfo(FilterLogicTestNodeInterface testNode) Prepares the FilterQualifierEditor to edit the selected qualifiers based on the given FilterLogicTestNodeInterface.
void	setLocale(Locale locale) Sets the Locale to be used by the model.
void	setMaxOutputObservations(int max) Sets the current maximum number of output observations to be returned when gathering a list of possible values to select from when creating a filter expression.
void	setPromptValueEditor(PromptValueEditorInterface editor) Sets the editor to use to edit a prompt value.
void	setPromptValueEditorInfo(FilterLogicTestNodeInterface testNode, int valueIndex) Prepares the PromptValueEditor to edit the current filter value based on the given FilterLogicTestNodeInterface.
void	setSelectionCursor(int index) move the model cursor to a new selection index

Methods inherited from interface com.sas.dataselectors.filters.AdvancedFilterDefinitionModelInterface

isOLAP

Methods inherited from interface com.sas.dataselectors.filters.SimpleFilterDefinitionModelInterface

commitChanges, getApplicationData, getDataSource, getRootFilterObject, getSelection, setApplicationData, setSelection

Method Detail

getFilterLabel

public String getFilterLabel()

Returns the label for the overall filter.

Returns:

String

setFilterLabel

public void setFilterLabel(String label)

Sets the label for the overall filter.

Parameters:

label - the new label

getFilterDescription

public String getFilterDescription()

Gets the description for the overall filter.

Returns:

String

setFilterDescription

public void setFilterDescription(String value)

Sets the description for the overall filter.

Parameters:

value - the new description

getSelectionTree

public SimpleFilterLogicTreeInterface getSelectionTree()

Returns a tree model that defines a single compound filter. Individual filter expressions defined by FilterLogicTestNodeInterface objects are connected by AND, OR, and NOT nodes. All children of a single node are grouped together in the query.

Returns:

the filter logic tree that defines the filter

See Also:

FilterLogicTestNodeInterface, FilterLogicBaseNodeInterface, FilterLogicAndNodeInterface, FilterLogicOrNodeInterface, FilterLogicNotNodeInterface

getFilterLogicList

public FilterLogicListInterface getFilterLogicList()

Returns a java.util.List of test nodes. See the rules in SimpleFilterDefintionModelInterface for allowing directly modfiable nodes using FilterLogicEditableTestNodeInterface. The underlying implementation of the list will have to handle inserting and updating new nodes. The objects passed in such calls will either be the objects implemented by the adapter OR in the case of an insert the new item will be of instance DefaultFilterLogicTestNode.

Returns:

FilterLogicListInterface

See Also:

DefaultFilterLogicList

setSelectionCursor

public void setSelectionCursor(int index)

move the model cursor to a new selection index

Parameters:

int - the 0 based index in the FilterLogicList to be the new selection

getSelectionCursor

public int getSelectionCursor()

get the index of the model cursor

Returns:

int the 0 based indes in the FilterLogicList of the current selection

addSelection

public boolean addSelection(FilterLogicTestNodeInterface value)

adds a new selection to the end of the FilterLogicList (cursor position undefined after an add)

Parameters:

FilterLogicTestNodeInterface - logic test node values to make up the new object

Returns:

boolean true if successful

removeSelection

public void removeSelection()

removes the current selection from the FilterLogicList (cursor position is undefined after remove)

getSelectionCount

public int getSelectionCount()

get the number of selectable entries in the model.

Returns:

the number of selectable entries in the model

clear

public void clear()

Clear the filter selection model and commit the changes.

clear

public void clear(boolean commit)

Clear the filter selection model and optionally commit the changes.

Parameters:

commit - pass TRUE if the model should apply the changes to the underlying data source.

getPromptValueEditor

public PromptValueEditorInterface getPromptValueEditor()

Returns the editor to use to edit a prompt value.

Returns:

the prompt value editor

setPromptValueEditor

public void setPromptValueEditor(PromptValueEditorInterface editor)

Sets the editor to use to edit a prompt value.

Parameters:

editor - the prompt value editor

getExpressionValueEditor

public ExpressionValueEditorInterface getExpressionValueEditor()

Returns the editor to use to edit an expression value.

Returns:

the expression value editor

setExpressionValueEditor

public void setExpressionValueEditor(ExpressionValueEditorInterface editor)

Sets the editor to use to edit an expression value.

Parameters:

editor - the expression value editor

getFilterItemEditor

public FilterItemEditorInterface getFilterItemEditor()

Returns the editor to use to edit a filter item.

Returns:

the filter item editor

setFilterItemEditor

public void setFilterItemEditor(FilterItemEditorInterface editor)

Sets the editor to use to edit a filter item.

Parameters:

editor - the filter item editor

getFilterQualifierEditor

public QualifiersEditorInterface getFilterQualifierEditor()

Returns the editor to use to edit a filter qualifier.

Returns:

the filter qualifier editor

setFilterQualifierEditor

public void setFilterQualifierEditor(QualifiersEditorInterface editor)

Sets the editor to use to edit a filter qualifier.

Parameters:

editor - the filter qualifier editor

setFilterItemEditorInfo

public void setFilterItemEditorInfo(FilterLogicTestNodeInterface testNode)

Prepares the FilterItemEditor to edit the current filter value based on the given FilterLogicTestNodeInterface.

Parameters:

testNode - the test node to examine

applyFilterItemEditorChanges

public FilterItemInterface applyFilterItemEditorChanges(FilterLogicTestNodeInterface testNode)

Applies the changes made in the FilterItemEditor to the given FilterLogicTestNodeInterface. This should set the Filter Item on the test node to one that represents the selection made in the editor.

Parameters:

testNode - the test node to examine

Returns:

the new/selected FilterItemInterface that represents the user's selections

setFilterQualifierEditorInfo

public void setFilterQualifierEditorInfo(FilterLogicTestNodeInterface testNode)

Prepares the FilterQualifierEditor to edit the selected qualifiers based on the given FilterLogicTestNodeInterface.

Parameters:

testNode - the test node to examine

applyFilterQualifierEditorChanges

public FilterQualifierInterface applyFilterQualifierEditorChanges(FilterLogicTestNodeInterface testNode)

Applies the changes made in the FilterQualifierEditor to the given FilterLogicTestNodeInterface. This should set the Filter Qualifier list on the test node to one that represents the selection made in the editor.

Parameters:

testNode - the test node to examine

Returns:

the new/selected FilterQualifierInterface that represents the user's selections

setPromptValueEditorInfo

public void setPromptValueEditorInfo(FilterLogicTestNodeInterface testNode,
                                     int valueIndex)

Prepares the PromptValueEditor to edit the current filter value based on the given FilterLogicTestNodeInterface.

Parameters:

testNode - the test node to examine

valueIndex - the index in the value list of the value to edit

applyPromptValueEditorChanges

public FilterValueInterface applyPromptValueEditorChanges(FilterLogicTestNodeInterface testNode,
                                                          int valueIndex)

Applies the changes made in the PromptValueEditor to the given FilterLogicTestNodeInterface. This should set the Filter Value list on the test node to one that represents the selection made in the editor.

Parameters:

testNode - the test node to examine

valueIndex - the index in the value list of the value to edit

Returns:

the new/selected FilterValueInterface that represents the user's selections

setExpressionValueEditorInfo

public void setExpressionValueEditorInfo(FilterLogicTestNodeInterface testNode,
                                         int valueIndex)

Prepares the ExpressionValueEditor to edit the current filter value based on the given FilterLogicTestNodeInterface.

Parameters:

testNode - the test node to examine

valueIndex - the index in the value list of the value to edit

applyExpressionValueEditorChanges

public FilterValueInterface applyExpressionValueEditorChanges(FilterLogicTestNodeInterface testNode,
                                                              int valueIndex)

Applies the changes made in the ExpressionValueEditor to the given FilterLogicTestNodeInterface. This should set the Filter Value list on the test node to one that represents the selection made in the editor.

Parameters:

testNode - the test node to examine

valueIndex - the index in the value list of the value to edit

Returns:

the new/selected FilterValueInterface that represents the user's selections

isPromptedValue

public boolean isPromptedValue(Object value)

Returns TRUE if the given object represents a prompted value.

Parameters:

value - the Object to examine

Returns:

TRUE if the given object represents a prompted value, FALSE otherwise

getPromptValueMap

public Map getPromptValueMap()

Returns a Map containing all known prompts using their names for keys.

Returns:

the prompt lookup table

getPromptValueList

public List getPromptValueList(Object testNode)

Returns a List containing all known prompts filter values.

Parameters:

testNode - the object to return prompts for

Returns:

a List of FilterValueInterface objects containing all known prompts filter values

isEditedExpressionValue

public boolean isEditedExpressionValue(Object value)

Returns TRUE if the given object represents a value that was created by the expression editor.

Parameters:

value - the Object to examine

Returns:

TRUE if the given object was created by the expression editor

cancel

public void cancel()

Returns the filter model to its initial state.

getLocale

public Locale getLocale()

Returns the Locale currently set on the model.

Returns:

the current Locale

setLocale

public void setLocale(Locale locale)

Sets the Locale to be used by the model.

Parameters:

locale - the new Locale for the model

getMaxOutputObservations

public int getMaxOutputObservations()

Returns the current maximum number of output observations returned when gathering a list of possible values to select from when creating a filter expression.

Returns:

the maximum number of output observations

setMaxOutputObservations

public void setMaxOutputObservations(int max)

Sets the current maximum number of output observations to be returned when gathering a list of possible values to select from when creating a filter expression.

Parameters:

max - the new maximum number of output observations

See Also:

Governing

isValidFilter

public boolean isValidFilter(FilterLogicTestNodeInterface testNode)
                      throws FilterException

Validates the filter. Returns true if the filter is valid. If the filter is invalid, then either a FilterException is thrown or false is returned. It may be possible to get more information about the reason of failure by calling getMessage() on the FilterException.

Parameters:

testNode - the testNode to validate the filter for

Returns:

true if the filter is valid otherwise false or a FilterException is thrown

Throws:

FilterException - if any errors occurred during the validation of the filter

isUserCreatedValue

public boolean isUserCreatedValue(Object value)

Returns TRUE if the given object represents a value that was created by a user entering a String expression value in the filter selector.

Parameters:

value - the Object to examine

Returns:

TRUE if the given object was created by a user entering a String expression value in the filter selector

isQuotedValue

public boolean isQuotedValue(Object value)

Returns TRUE if the given object represents a value that will be quoted during query generation.

Parameters:

value - the Object to examine

Returns:

TRUE if the given object represents a value that will be quoted during query generation

*** This class is subject to change ***