CDMA plugin API  3.1.0
CDMA core library
org.gumtree.data.interfaces.IKey Interface Reference

The IKey is used by group to interrogate the dictionary. More...

Inheritance diagram for org.gumtree.data.interfaces.IKey:
org.gumtree.data.dictionary.impl.Key

List of all members.

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 ()

Detailed Description

The IKey is used by group to interrogate the dictionary.

Note:
When developing a plug-in consider using the engine's implementation. You should redefine this interface implementation, only in case of very specific needs.

pluginAPI 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...

Author:
rodriguez

Member Function Documentation

Copy entirely the key : name and filters are cloned

Returns:
a copy of this key

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.

Parameters:
keyto compare
Returns:
true if both keys have same name

Implemented in org.gumtree.data.dictionary.impl.Key.

Get the entry name in the dictionary that will be searched when using this key.

Returns:
the name of this key

Implemented in org.gumtree.data.dictionary.impl.Key.

Get the list of parameters that will be applied when using this key.

Returns:
list of IPathParameter

Implemented in org.gumtree.data.dictionary.impl.Key.

Remove a IPathParameter to this IKey that will be used when searching an object with this key.

Returns:
parameter that won't be applied anymore
Note:
work as a FILO

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. .

Parameters:
parameterto be applied
Note:
work as a FILO

Implemented in org.gumtree.data.dictionary.impl.Key.

Set the entry name in the dictionary that will be searched when using this key.

Parameters:
nameof this key

Implemented in org.gumtree.data.dictionary.impl.Key.


The documentation for this interface was generated from the following file:
 All Classes Namespaces Files Functions Variables