org.gcube.indexmanagement.common
Interface ForwardIndex

All Known Implementing Classes:

BDBWrapper

public interface ForwardIndex

This interface contains the methods that are specified for the forward index, and that is used and known by the clients of the service. These operations are also specified in the WSDL for the service Since the implementation of the service uses Derby, there is also another interface that is specified in the DerbyInterface. If the service is implemented using the Derby Db, the service also must implement the DerbyInterface. Interface for Index Searching Wrapper Classes.

Method Summary

String	getEQ(String keyName, Object keyEQ, ResultType resType) Gets the key and value pairs where keys are equal the input key.
String	getGE(String keyName, Object key, ResultType resType) Gets the key and value pairs where keys are GE the input key.
String	getGEandLE(String keyName, Object keyGE, Object keyLE, ResultType resType) Gets the key and value pairs where keys are GE the input key1 and LE the input key2.
String	getGEandLT(String keyName, Object keyGE, Object keyLT, ResultType resType) Gets the key and value pairs where keys are GE the input key1 and LT the input key2.
String	getGT(String keyName, Object key, ResultType resType) Gets the key and value pairs where keys are GT the input key.
String	getGTandLE(String keyName, Object keyGT, Object keyLE, ResultType resType) Gets the key and value pairs where keys are GT the input key1 and LE the input key2.
String	getGTandLT(String keyName, Object keyGT, Object keyLT, ResultType resType) Gets the key and value pairs where keys are GT the input key1.
String	getLE(String keyName, Object keyLE, ResultType resType) Gets the key and value pairs where keys are LE the input key.
String	getLT(String keyName, Object keyLT, ResultType resType) Gets the key and value pairs where keys are LT the input key.

Method Detail

getEQ

String getEQ(String keyName,
             Object keyEQ,
             ResultType resType)
             throws IndexException

Gets the key and value pairs where keys are equal the input key.

Parameters:

keyEQ - - contains the ley.

bKeysOnly - return only keys, or full tuples?

Returns:

String - the result of the get request.

Throws:

IndexException - in case of failure.

getGE

String getGE(String keyName,
             Object key,
             ResultType resType)
             throws IndexException

Gets the key and value pairs where keys are GE the input key.

Parameters:

key - The key to search for.

bKeysOnly - return only keys, or full tuples?

Returns:

String The result of the get request.

Throws:

IndexException - Exception thrown in case of failure.

getGT

String getGT(String keyName,
             Object key,
             ResultType resType)
             throws IndexException

Gets the key and value pairs where keys are GT the input key.

Parameters:

key - The key to search for.

bKeysOnly - return only keys, or full tuples?

Returns:

String The result of the get request.

Throws:

IndexException - Exception thrown in case of failure.

getLT

String getLT(String keyName,
             Object keyLT,
             ResultType resType)
             throws IndexException

Gets the key and value pairs where keys are LT the input key.

Parameters:

keyLT - - contains the key.

bKeysOnly - return only keys, or full tuples?

Returns:

String - the result of the get request.

Throws:

IndexException - Exception thrown in case of failure.

getLE

String getLE(String keyName,
             Object keyLE,
             ResultType resType)
             throws IndexException

Gets the key and value pairs where keys are LE the input key.

Parameters:

keyLE - The key to search for.

bKeysOnly - return only keys, or full tuples?

Returns:

String The result of the get request.

Throws:

IndexException - Exception thrown in case of failure.

getGTandLT

String getGTandLT(String keyName,
                  Object keyGT,
                  Object keyLT,
                  ResultType resType)
                  throws IndexException

Gets the key and value pairs where keys are GT the input key1. and LT the input key2.

Parameters:

keyGT - The key to search for res > key.

keyLT - The key to search for res < key.

bKeysOnly - return only keys, or full tuples?

Returns:

String The result of the get request.

Throws:

IndexException - Thrown in case of failure.

getGEandLT

String getGEandLT(String keyName,
                  Object keyGE,
                  Object keyLT,
                  ResultType resType)
                  throws IndexException

Gets the key and value pairs where keys are GE the input key1 and LT the input key2.

Parameters:

keyGE - The key to search for res >= key.

keyLT - The key to search for res < key.

bKeysOnly - return only keys, or full tuples?

Returns:

String The result of the get request.

Throws:

IndexException - Thrown in the case of failure.

getGTandLE

String getGTandLE(String keyName,
                  Object keyGT,
                  Object keyLE,
                  ResultType resType)
                  throws IndexException

Gets the key and value pairs where keys are GT the input key1 and LE the input key2.

Parameters:

keyGT - The key to search for res > key.

keyLE - The key to search for res <= key.

bKeysOnly - return only keys, or full tuples?

Returns:

String The result of the get request.

Throws:

IndexException - Thrown in the case of failure.

getGEandLE

String getGEandLE(String keyName,
                  Object keyGE,
                  Object keyLE,
                  ResultType resType)
                  throws IndexException

Gets the key and value pairs where keys are GE the input key1 and LE the input key2.

Parameters:

keyGE - The key to search for res >= key.

keyLE - The key to search for res <= key.

bKeysOnly - return only keys, or full tuples?

Returns:

String The result of the get request.

Throws:

IndexException - Thrown in the case of failure.