com.kabira.store

Class KeyField

java.lang.Object

com.kabira.store.KeyField

public class KeyField
extends java.lang.Object

Describes a field within the query performed by an application.

Passed as a list of KeyField to the query notification. For example, if the application query data is:

     KeyFieldValueList fieldValueList = new KeyFieldValueList();
     fieldValueList.add("firstName", "fred");
 

The Query.query() queryData param is:

     assert queryData.size() == 1;
     KeyField keyField = queryData.get(0);

     assert keyField.name == "firstName";
     String firstNameValue = (String) keyField.value;
     assert firstNameValue.equals("fred");
     assert keyField.comparisonOperator == KeyComparisonOperator.EQ;
 

If the application KeyQuery data is:

     KeyFieldValueRangeList fieldValueRangeList = new KeyFieldValueRangeList();
     fieldValueList.add("number", 12345, KeyComparisonOperator.GTE);
     fieldValueList.add("number", 22222, KeyComparisonOperator.GTE);
 

The Query.query() queryData param is:

     assert queryData.size() == 2;
     KeyField keyField = queryData.get(0);

     assert keyField.name == "number";
     int value = (Integer) keyField.value;
     assert value == 12345;
     assert keyField.comparisonOperator == KeyComparisonOperator.GTE;

     KeyField keyField = queryData.get(1);

     assert keyField.name == "number";
     int value = (Integer) keyField.value;
     assert value == 22222;
     assert keyField.comparisonOperator == KeyComparisonOperator.GTE;

 

Field Summary

Fields

Modifier and Type	Field and Description
KeyComparisonOperator	comparisonOperator The comparison operator for field and data.
java.lang.String	name The name of the field added to KeyFieldValueList or KeyFieldValueRangeList.
java.lang.Object	value The value for field name added to KeyFieldValueList or KeyFieldValueRangeList.

Method Summary

Modifier and Type	Method and Description
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

name

public final java.lang.String name

The name of the field added to KeyFieldValueList or KeyFieldValueRangeList.

value

public final java.lang.Object value

The value for field name added to KeyFieldValueList or KeyFieldValueRangeList.

comparisonOperator

public final KeyComparisonOperator comparisonOperator

The comparison operator for field and data. For queries using KeyFieldValueList the comparison operator will always be KeyComparisonOperator.EQ.

Method Detail

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object