org.hypergraphdb

Interface HGSearchable<KeyType,ValueType>

All Known Subinterfaces:

HGBidirectionalIndex<KeyType,ValueType>, HGIndex<KeyType,ValueType>, HGOrderedSearchable<KeyType,ValueType>, HGSortIndex<KeyType,ValueType>

All Known Implementing Classes:

AtomRefType, BooleanType, ByteType, CalendarType, CharType, DateType, DateTypeBase, DoubleType, FloatType, HGHandleType, HGRelTypeConstructor, IntType, LongType, NumericTypeBase, PrimitiveTypeBase, ShortType, SlotType, StringType, TimestampType

public interface HGSearchable<KeyType,ValueType>

The HGSearchable interface specifies that an object can be searched by a key. Things HGSearchable in HyperGraph are indexes, certain types and the like.

Author:

Borislav Iordanov

Method Summary

Methods

Modifier and Type	Method and Description
HGSearchResult<ValueType>	find(KeyType key) Returns a HGSearchResult over all values matching a key in the searched entity.

Method Detail

find

HGSearchResult<ValueType> find(KeyType key)

Returns a HGSearchResult over all values matching a key in the searched entity.

If there are no matches, the method should return HGSearchResult.EMPTY. The method will never return a null. A HGException may be thrown in exceptional situations.