org.hypergraphdb.query.impl

Class SearchableBasedQuery<Key,Value>

java.lang.Object

org.hypergraphdb.HGQuery<Value>

org.hypergraphdb.query.impl.KeyBasedQuery<Key,Value>

org.hypergraphdb.query.impl.SearchableBasedQuery<Key,Value>

All Implemented Interfaces:

HGGraphHolder

public class SearchableBasedQuery<Key,Value>
extends KeyBasedQuery<Key,Value>

A simple query that operates on a single HGSearchable entity, usually a HGIndex.

Author:

Borislav Iordanov

Nested Class Summary

Nested classes/interfaces inherited from class org.hypergraphdb.HGQuery

HGQuery.hg

Field Summary

Fields

Modifier and Type	Field and Description
protected Ref<Key>	key
protected HGSearchable<Key,Value>	searchable

Fields inherited from class org.hypergraphdb.HGQuery

ctx, graph

Constructor Summary

Constructors

Constructor and Description
SearchableBasedQuery(HGSearchable<Key,Value> searchable, Key key, ComparisonOperator operator) Construct a new HGSearchable based query.
SearchableBasedQuery(HGSearchable<Key,Value> searchable, Ref<Key> key, ComparisonOperator operator)

Method Summary

Methods

Modifier and Type	Method and Description
HGSearchResult<Value>	execute() Execute the query and return the result set.
Key	getKey() Retrieve the key object used to perform this query.
Ref<Key>	getKeyReference()
ComparisonOperator	getOperator()
HGSearchable<Key,Value>	getSearchable()
void	setKey(Key key) Specify the key on which this query operates.
void	setKeyReference(Ref<Key> key)
void	setOperator(ComparisonOperator operator)
void	setSearchable(HGSearchable<Key,Value> searchable)

Methods inherited from class org.hypergraphdb.HGQuery

compile, findAll, findInSet, findOne, getHyperGraph, initialValue, initialVar, make, make, NOP, setHyperGraph, var, var

Methods inherited from class java.lang.Object

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

Field Detail

searchable

protected HGSearchable<Key,Value> searchable

key

protected Ref<Key> key

Constructor Detail

SearchableBasedQuery

public SearchableBasedQuery(HGSearchable<Key,Value> searchable,
                    Key key,
                    ComparisonOperator operator)

Construct a new HGSearchable based query.

Parameters:

searchable - The instance that will be searched.

key - The search key.

operator - A ComparisonOperator for the search. If it is something else than a ComparisonOperator.EQ operator, it must be supported by the concrete HGSearchable object passed. For instance, an order operator like ComparisonOperator.LT and the like requires a HGOrderedSearchable instance.

SearchableBasedQuery

public SearchableBasedQuery(HGSearchable<Key,Value> searchable,
                    Ref<Key> key,
                    ComparisonOperator operator)

Method Detail

execute

public HGSearchResult<Value> execute()

Description copied from class: HGQuery

Execute the query and return the result set. Note that queries are lazily executed so that results are actually obtained when one iterates (using the next and prev of the returned object).

Specified by:

execute in class HGQuery<Value>

setKeyReference

public void setKeyReference(Ref<Key> key)

getKeyReference

public Ref<Key> getKeyReference()

setKey

public void setKey(Key key)

Description copied from class: KeyBasedQuery

Specify the key on which this query operates.

Specified by:

setKey in class KeyBasedQuery<Key,Value>

Parameters:

key - The key object. The value may be interpreted differently based on the concrete HGQuery instance. Usually it should be either a byte [] or convertible to one.

getKey

public Key getKey()

Description copied from class: KeyBasedQuery

Retrieve the key object used to perform this query.

Specified by:

getKey in class KeyBasedQuery<Key,Value>

setOperator

public void setOperator(ComparisonOperator operator)

getOperator

public ComparisonOperator getOperator()

setSearchable

public void setSearchable(HGSearchable<Key,Value> searchable)

getSearchable

public HGSearchable<Key,Value> getSearchable()