|
Components |
|
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SimpleFilterLogicTreeInterface
The SimpleFilterLogicTreeInterface provides a simpler tree structure than the FilterLogicTreeInterface.
Field Summary | |
---|---|
static java.lang.String |
AND
Constant value used when defining or determining the logical relationship between two expressions in a filter. |
static java.lang.String |
OR
Constant value used when defining or determining the logical relationship between two expressions in a filter. |
Method Summary | |
---|---|
void |
add(FilterLogicBaseNodeInterface rootNode)
Appends the given logic tree structure to this one. |
void |
add(SimpleFilterLogicTreeInterface tree)
Appends the given logic tree to this one. |
void |
addLeafAt(int index,
FilterLogicTestNodeInterface testNode)
Add a new test node at the given index in the list of understood test nodes. |
boolean |
areAllNodesUnderstood()
Returns TRUE if all leaf nodes in the tree have been marked as "understood", FALSE otherwise. |
void |
cancel(java.lang.Object initialFilter)
Returns the filter model to the state specified by the given filter object. |
boolean |
canGroupLeaves(int firstIndex,
int lastIndex)
Returns TRUE if the leaves (or the groups they're members of) at the given indices can be grouped together. |
void |
clear()
Removes all leaves from the tree and collapses any remaining support structure. |
boolean |
commitTree()
Commits any changes in the tree to the underlying native filter model. |
SimpleFilterLogicTreeInterface |
copy()
Constructs and returns a copy of this tree. |
SimpleFilterLogicTreeInterface |
copy(boolean copyTestNodes)
Copies the tree and optionally makes duplicates of the test nodes within it. |
FilterItemInterface |
findMatchingFilterItem(java.lang.Object itemObject)
Attempts to locate and return the filter model object that matches the specified search item from the native model. |
int |
getFirstLeafInGroup(int memberIndex)
Returns the index of the first leaf in the group that includes the leaf at the given index. |
int |
getLastLeafInGroup(int memberIndex)
Returns the index of the last leaf in the group that includes the leaf at the given index. |
FilterLogicTestNodeInterface |
getLeafAt(int index)
Returns the test node at the given index. |
java.lang.String |
getLeafConditionalRelationType(int index)
Returns the conditional relation type (AND/OR) between the leaf at the given index and the leaf at the next index. |
FilterLogicBaseNodeInterface |
getRoot()
Returns the root node of the logic tree. |
java.lang.Object |
getRootFilterItem()
Returns the root native filter object. |
java.util.List |
getUnderstoodTestNodeList()
Returns the list of understood nodes in the tree. |
void |
groupLeaves(int startIndex,
int endIndex)
Groups the leaves (including any groups they are members of) at the specified locations together (along with any nodes in between them). |
boolean |
isLeafGrouped(int index)
Returns TRUE if the leaf at the given index is part of a group. |
boolean |
isLeafNegated(int index)
Returns TRUE if the leaf at the given index or group that leaf is a member of is negated, FALSE otherwise. |
void |
moveLeafDown(int index)
Moves the leaf at the given index down one. |
void |
moveLeafUp(int index)
Moves the leaf at the given index up one. |
void |
refreshNodeList()
Refreshes the list of leaf nodes in the tree. |
FilterLogicTestNodeInterface |
removeLeafAt(int index)
Removes the test node at the given index. |
FilterLogicTestNodeInterface |
setLeafAt(int index,
FilterLogicTestNodeInterface testNode)
Sets the test node at the given index in the list of understood test nodes. |
void |
setLeafConditionalRelationType(int index,
java.lang.String value)
Sets the logical relationship between the leaf at the given index and the leaf at the next index. |
void |
setLeafNegated(int index,
boolean value)
Sets whether the leaf at the given index or group that leaf is a member of is negated. |
FilterLogicBaseNodeInterface |
setRoot(FilterLogicBaseNodeInterface root)
Sets the root tree node for this tree. |
void |
splitGroup(int indexOfMember)
Splits the inner-most group containing the member at the specified index. |
Field Detail |
---|
static final java.lang.String AND
static final java.lang.String OR
Method Detail |
---|
void addLeafAt(int index, FilterLogicTestNodeInterface testNode)
index
- the index in the list at which the new node will be insertedtestNode
- the new node to addFilterLogicTestNodeInterface setLeafAt(int index, FilterLogicTestNodeInterface testNode)
index
- the index in the list at which the new node will be settestNode
- the new node to put at the given index
FilterLogicTestNodeInterface removeLeafAt(int index)
index
- the index of the test node, in the list of understood nodes, to be removed
FilterLogicTestNodeInterface getLeafAt(int index)
index
- the index of the desired test node
FilterLogicBaseNodeInterface getRoot()
void refreshNodeList()
boolean areAllNodesUnderstood()
java.util.List getUnderstoodTestNodeList()
boolean commitTree()
void cancel(java.lang.Object initialFilter)
initialFilter
- the initial filter state to return toFilterItemInterface findMatchingFilterItem(java.lang.Object itemObject)
itemObject
- the search item
java.lang.Object getRootFilterItem()
boolean isLeafNegated(int index)
the
- index in the list of understood test nodes
void setLeafNegated(int index, boolean value)
the
- index in the list of understood test nodesvalue
- the new negation valuejava.lang.String getLeafConditionalRelationType(int index)
void setLeafConditionalRelationType(int index, java.lang.String value)
index
- the index of the first leaf in the pairvalue
- the logical conditionvoid splitGroup(int indexOfMember)
indexOfMember
- the index of the member of the group to splitvoid groupLeaves(int startIndex, int endIndex)
startIndex
- the start of the new groupendIndex
- the end of the new groupvoid moveLeafUp(int index)
index
- the index of the leaf to movevoid moveLeafDown(int index)
index
- the index of the leaf to moveboolean isLeafGrouped(int index)
index
- the index in the list of understood nodes of the leaf to check
void clear()
int getFirstLeafInGroup(int memberIndex)
memberIndex
- the index of the node that is a member of the group to return the
index of its first leaf
int getLastLeafInGroup(int memberIndex)
memberIndex
- the index of the node that is a member of the group to return the
index of its last leaf
boolean canGroupLeaves(int firstIndex, int lastIndex)
firstIndex
- the index of the first leaf selectedlastIndex
- the index of the last leaf selected
SimpleFilterLogicTreeInterface copy()
SimpleFilterLogicTreeInterface copy(boolean copyTestNodes)
copyTestNodes
- TRUE if the test nodes in this tree should be duplicated
FilterLogicBaseNodeInterface setRoot(FilterLogicBaseNodeInterface root)
root
- the new root node of the tree
void add(SimpleFilterLogicTreeInterface tree)
tree
- the tree to addvoid add(FilterLogicBaseNodeInterface rootNode)
rootNode
-
|
Components |
|
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |