|
CDMA engine API
3.1.0
CDMA core library
|
The IKey is used by group to interrogate the dictionary. More...
Public Member Functions | |
| String | getName () |
| void | setName (String name) |
| boolean | equals (Object key) |
| List< IPathParameter > | getParameterList () |
| void | pushParameter (IPathParameter filter) |
| IPathParameter | popParameter () |
| String | toString () |
| IKey | clone () |
The IKey is used by group to interrogate the dictionary.
engineAPI The key's name corresponds to an entry in the dictionary. This entry targets a path in the currently explored document. The group will open it.
The IKey can carry some filters to help group to decide which node is relevant. The filters can specify an order index to open a particular type of node, an attribute, a part of the name...
Copy entirely the key : name and filters are cloned
Implemented in org.gumtree.data.dictionary.impl.Key.
| boolean org.gumtree.data.interfaces.IKey.equals | ( | Object | key | ) |
Return true if both key have similar names. Filters are not compared.
| key | to compare |
Implemented in org.gumtree.data.dictionary.impl.Key.
| String org.gumtree.data.interfaces.IKey.getName | ( | ) |
Get the entry name in the dictionary that will be searched when using this key.
Implemented in org.gumtree.data.dictionary.impl.Key.
| List<IPathParameter> org.gumtree.data.interfaces.IKey.getParameterList | ( | ) |
Get the list of parameters that will be applied when using this key.
Implemented in org.gumtree.data.dictionary.impl.Key.
| IPathParameter org.gumtree.data.interfaces.IKey.popParameter | ( | ) |
Remove a IPathParameter to this IKey that will be used when searching an object with this key.
Implemented in org.gumtree.data.dictionary.impl.Key.
| void org.gumtree.data.interfaces.IKey.pushParameter | ( | IPathParameter | filter | ) |
Add a IPathParameter to this IKey that will be used when searching an object with this key. .
| parameter | to be applied |
Implemented in org.gumtree.data.dictionary.impl.Key.
| void org.gumtree.data.interfaces.IKey.setName | ( | String | name | ) |
Set the entry name in the dictionary that will be searched when using this key.
| name | of this key |
Implemented in org.gumtree.data.dictionary.impl.Key.
| String org.gumtree.data.interfaces.IKey.toString | ( | ) |
Implemented in org.gumtree.data.dictionary.impl.Key.