|
Components |
|
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AdvancedFilterModelInterface
This interface defines the relationship between the AdvancedFilterPanel and an implemented adaptor.
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. |
com.sas.swing.dataselectors.editors.ExpressionValueEditorInterface |
getExpressionValueEditor()
Returns the editor to use to edit an expression value. |
java.lang.String |
getFilterDescription()
Gets the description for the overall filter. |
com.sas.swing.dataselectors.editors.FilterItemEditorInterface |
getFilterItemEditor()
Returns the editor to use to edit a filter item. |
java.lang.String |
getFilterLabel()
Returns the label for the overall filter. |
FilterLogicListInterface |
getFilterLogicList()
Returns a java.util.List of test nodes. |
com.sas.swing.dataselectors.editors.QualifiersEditorInterface |
getFilterQualifierEditor()
Returns the editor to use to edit a filter qualifier. |
java.util.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. |
com.sas.swing.dataselectors.editors.PromptValueEditorInterface |
getPromptValueEditor()
Returns the editor to use to edit a prompt value. |
java.util.List |
getPromptValueList(java.lang.Object testNode)
Returns a List containing all known prompts filter values. |
java.util.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(java.lang.Object value)
Returns TRUE if the given object represents a value that was created by the expression editor. |
boolean |
isPromptedValue(java.lang.Object value)
Returns TRUE if the given object represents a prompted value. |
boolean |
isQuotedValue(java.lang.Object value)
Returns TRUE if the given object represents a value that will be quoted during query generation. |
boolean |
isUserCreatedValue(java.lang.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(com.sas.swing.dataselectors.editors.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(java.lang.String value)
Sets the description for the overall filter. |
void |
setFilterItemEditor(com.sas.swing.dataselectors.editors.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(java.lang.String label)
Sets the label for the overall filter. |
void |
setFilterQualifierEditor(com.sas.swing.dataselectors.editors.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(java.util.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(com.sas.swing.dataselectors.editors.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 |
---|
java.lang.String getFilterLabel()
void setFilterLabel(java.lang.String label)
label
- the new labeljava.lang.String getFilterDescription()
void setFilterDescription(java.lang.String value)
value
- the new descriptionSimpleFilterLogicTreeInterface getSelectionTree()
FilterLogicTestNodeInterface
,
FilterLogicBaseNodeInterface
,
FilterLogicAndNodeInterface
,
FilterLogicOrNodeInterface
,
FilterLogicNotNodeInterface
FilterLogicListInterface getFilterLogicList()
DefaultFilterLogicList
void setSelectionCursor(int index)
int
- the 0 based index in the FilterLogicList to be the new selectionint getSelectionCursor()
boolean addSelection(FilterLogicTestNodeInterface value)
FilterLogicTestNodeInterface
- logic test node values to make up the new object
void removeSelection()
int getSelectionCount()
void clear()
void clear(boolean commit)
commit
- pass TRUE if the model should apply the changes to the
underlying data source.com.sas.swing.dataselectors.editors.PromptValueEditorInterface getPromptValueEditor()
void setPromptValueEditor(com.sas.swing.dataselectors.editors.PromptValueEditorInterface editor)
editor
- the prompt value editorcom.sas.swing.dataselectors.editors.ExpressionValueEditorInterface getExpressionValueEditor()
void setExpressionValueEditor(com.sas.swing.dataselectors.editors.ExpressionValueEditorInterface editor)
editor
- the expression value editorcom.sas.swing.dataselectors.editors.FilterItemEditorInterface getFilterItemEditor()
void setFilterItemEditor(com.sas.swing.dataselectors.editors.FilterItemEditorInterface editor)
editor
- the filter item editorcom.sas.swing.dataselectors.editors.QualifiersEditorInterface getFilterQualifierEditor()
void setFilterQualifierEditor(com.sas.swing.dataselectors.editors.QualifiersEditorInterface editor)
editor
- the filter qualifier editorvoid setFilterItemEditorInfo(FilterLogicTestNodeInterface testNode)
testNode
- the test node to examineFilterItemInterface applyFilterItemEditorChanges(FilterLogicTestNodeInterface testNode)
testNode
- the test node to examine
void setFilterQualifierEditorInfo(FilterLogicTestNodeInterface testNode)
testNode
- the test node to examineFilterQualifierInterface applyFilterQualifierEditorChanges(FilterLogicTestNodeInterface testNode)
testNode
- the test node to examine
void setPromptValueEditorInfo(FilterLogicTestNodeInterface testNode, int valueIndex)
testNode
- the test node to examinevalueIndex
- the index in the value list of the value to editFilterValueInterface applyPromptValueEditorChanges(FilterLogicTestNodeInterface testNode, int valueIndex)
testNode
- the test node to examinevalueIndex
- the index in the value list of the value to edit
void setExpressionValueEditorInfo(FilterLogicTestNodeInterface testNode, int valueIndex)
testNode
- the test node to examinevalueIndex
- the index in the value list of the value to editFilterValueInterface applyExpressionValueEditorChanges(FilterLogicTestNodeInterface testNode, int valueIndex)
testNode
- the test node to examinevalueIndex
- the index in the value list of the value to edit
boolean isPromptedValue(java.lang.Object value)
value
- the Object to examine
java.util.Map getPromptValueMap()
java.util.List getPromptValueList(java.lang.Object testNode)
testNode
- the object to return prompts for
boolean isEditedExpressionValue(java.lang.Object value)
value
- the Object to examine
void cancel()
java.util.Locale getLocale()
void setLocale(java.util.Locale locale)
locale
- the new Locale for the modelint getMaxOutputObservations()
void setMaxOutputObservations(int max)
max
- the new maximum number of output observationsGoverning
boolean isValidFilter(FilterLogicTestNodeInterface testNode) throws FilterException
testNode
- the testNode to validate the filter for
FilterException
- if any errors occurred during the validation of the filterboolean isUserCreatedValue(java.lang.Object value)
value
- the Object to examine
boolean isQuotedValue(java.lang.Object value)
value
- the Object to examine
|
Components |
|
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |