CDMA engine API  3.1.0
CDMA core library
org.gumtree.data.dictionary.impl.Key Class Reference
Inheritance diagram for org.gumtree.data.dictionary.impl.Key:
org.gumtree.data.interfaces.IKey

List of all members.

Public Member Functions

 Key (IFactory factory, String name)
 Key (IKey key)
List< IPathParameter > getParameterList ()
String getName ()
void setName (String name)
boolean equals (Object key)
int hashCode ()
String toString ()
void pushParameter (IPathParameter filter)
IPathParameter popParameter ()
IKey clone ()
String getFactoryName ()
int compareTo (Object arg0)

Constructor & Destructor Documentation

org.gumtree.data.dictionary.impl.Key.Key ( IFactory  factory,
String  name 
) [inline]

Member Function Documentation

Copy entirely the key : name and filters are cloned

Returns:
a copy of this key

Implements org.gumtree.data.interfaces.IKey.

int org.gumtree.data.dictionary.impl.Key.compareTo ( Object  arg0) [inline]
boolean org.gumtree.data.dictionary.impl.Key.equals ( Object  key) [inline]

Return true if both key have similar names. Filters are not compared.

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

Implements org.gumtree.data.interfaces.IKey.

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

Returns:
the name of this key

Implements org.gumtree.data.interfaces.IKey.

List<IPathParameter> org.gumtree.data.dictionary.impl.Key.getParameterList ( ) [inline]

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

Returns:
list of IPathParameter

Implements org.gumtree.data.interfaces.IKey.

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

Implements org.gumtree.data.interfaces.IKey.

void org.gumtree.data.dictionary.impl.Key.pushParameter ( IPathParameter  filter) [inline]

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

Implements org.gumtree.data.interfaces.IKey.

void org.gumtree.data.dictionary.impl.Key.setName ( String  name) [inline]

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

Parameters:
nameof this key

Implements org.gumtree.data.interfaces.IKey.


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