org.hypergraphdb.indexing

Class TargetToTargetIndexer

java.lang.Object

org.hypergraphdb.indexing.HGValueIndexer<HGHandle,HGHandle>

org.hypergraphdb.indexing.TargetToTargetIndexer

All Implemented Interfaces:

HGIndexer<HGHandle,HGHandle>

public class TargetToTargetIndexer
extends HGValueIndexer<HGHandle,HGHandle>

A HGValueIndexer for HyperGraph links where the key in the index is one of the targets within a link and the value is another one of the targets.

Author:

Borislav Iordanov

Constructor Summary

Constructors

Constructor and Description
TargetToTargetIndexer()
TargetToTargetIndexer(HGHandle type, int fromTarget, int toTarget)
TargetToTargetIndexer(String name, HGHandle type, int fromTarget, int toTarget)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object other) Declared to enforce implementation.
Comparator<byte[]>	getComparator(HyperGraph graph) Return a comparator used to compare key values return by this indexer.
ByteArrayConverter<HGHandle>	getConverter(HyperGraph graph) Return a ByteArrayConverter capable of translating keys returned by this indexer to/from a byte[].
int	getFromTarget()
HGHandle	getKey(HyperGraph graph, Object atom) Returns an index key for the given atom.
int	getToTarget()
HGHandle	getValue(HyperGraph graph, Object atom) Return the value of an index entry based on the passed in atom.
ByteArrayConverter<HGHandle>	getValueConverter(HyperGraph graph) Return a ByteArrayConverter capable of converting index entry values to/from byte arrays.
int	hashCode() Declared to enforce implementation.
void	setFromTarget(int fromTarget)
void	setToTarget(int toTarget)

Methods inherited from class org.hypergraphdb.indexing.HGValueIndexer

getName, getType, index, setName, setType, unindex

Methods inherited from class java.lang.Object

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

Constructor Detail

TargetToTargetIndexer

public TargetToTargetIndexer()

TargetToTargetIndexer

public TargetToTargetIndexer(HGHandle type,
                     int fromTarget,
                     int toTarget)

TargetToTargetIndexer

public TargetToTargetIndexer(String name,
                     HGHandle type,
                     int fromTarget,
                     int toTarget)

Method Detail

getFromTarget

public int getFromTarget()

setFromTarget

public void setFromTarget(int fromTarget)

getToTarget

public int getToTarget()

setToTarget

public void setToTarget(int toTarget)

getKey

public HGHandle getKey(HyperGraph graph,
              Object atom)

Description copied from class: HGValueIndexer

Returns an index key for the given atom.

Specified by:

getKey in class HGValueIndexer<HGHandle,HGHandle>

Parameters:

graph - The current HyperGraph instance.

atom - The atom being indexed.

Returns:

The index key. If the return value is not a byte[], a non-null ByteArrayConverter must be provided by the getConverter method.

getValue

public HGHandle getValue(HyperGraph graph,
                Object atom)

Description copied from class: HGValueIndexer

Return the value of an index entry based on the passed in atom.

Specified by:

getValue in class HGValueIndexer<HGHandle,HGHandle>

getValueConverter

public ByteArrayConverter<HGHandle> getValueConverter(HyperGraph graph)

Description copied from class: HGValueIndexer

Return a ByteArrayConverter capable of converting index entry values to/from byte arrays.

Specified by:

getValueConverter in class HGValueIndexer<HGHandle,HGHandle>

Returns:

getComparator

public Comparator<byte[]> getComparator(HyperGraph graph)

Description copied from interface: HGIndexer

Return a comparator used to compare key values return by this indexer. Note that the comparator's compare method will be invoked with byte[] parameters. It is the comparator's responsibility to convert them to the appropriate run-time type for performing the comparison if need be.

The method may return null if a default byte-by-byte comparator is to be used.

Parameters:

graph - The current HyperGraph instance.

Returns:

A comparator used to compare key values return by this indexer or null to use a default byte-by-byte comparison of keys.

getConverter

public ByteArrayConverter<HGHandle> getConverter(HyperGraph graph)

Description copied from interface: HGIndexer

Return a ByteArrayConverter capable of translating keys returned by this indexer to/from a byte[].

Parameters:

graph - The current HyperGraph instance.

Returns:

The ByteArrayConverter for type of index keys return by this indexer or null if keys are of type byte[].

hashCode

public int hashCode()

Description copied from interface: HGIndexer

Declared to enforce implementation.

Specified by:

hashCode in interface HGIndexer<HGHandle,HGHandle>

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Description copied from interface: HGIndexer

Declared to enforce implementation.

Specified by:

equals in interface HGIndexer<HGHandle,HGHandle>

Overrides:

equals in class Object