org.hypergraphdb.indexing

Class ByPartIndexer<KeyType>

java.lang.Object

org.hypergraphdb.indexing.HGKeyIndexer<KeyType>

org.hypergraphdb.indexing.ByPartIndexer<KeyType>

All Implemented Interfaces:

HGIndexer<KeyType,HGPersistentHandle>

public class ByPartIndexer<KeyType>
extends HGKeyIndexer<KeyType>

Represents by the value of a part in a composite type.

Author:

Borislav Iordanov

Constructor Summary

Constructors

Constructor and Description
ByPartIndexer()
ByPartIndexer(HGHandle type, String dimensionPath) Convenience constructor that allows passing a dot separated dimension path that is converted to a String[].
ByPartIndexer(HGHandle type, String[] dimensionPath)
ByPartIndexer(String name, HGHandle type, String dimensionPath) Convenience constructor that allows passing a dot separated dimension path that is converted to a String[].
ByPartIndexer(String name, HGHandle type, String[] dimensionPath)

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<KeyType>	getConverter(HyperGraph graph) Return a ByteArrayConverter capable of translating keys returned by this indexer to/from a byte[].
String[]	getDimensionPath()
KeyType	getKey(HyperGraph graph, Object atom) Returns an index key for the given atom.
int	hashCode() Declared to enforce implementation.
void	setDimensionPath(String[] dimensionPath)

Methods inherited from class org.hypergraphdb.indexing.HGKeyIndexer

getName, getType, index, setName, setType, unindex

Methods inherited from class java.lang.Object

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

Constructor Detail

ByPartIndexer

public ByPartIndexer()

ByPartIndexer

public ByPartIndexer(HGHandle type,
             String dimensionPath)

Convenience constructor that allows passing a dot separated dimension path that is converted to a String[].

Parameters:

type - The type of the atoms to be indexed.

dimensionPath - The dimension path in dot format (e.g. "person.address.street")

ByPartIndexer

public ByPartIndexer(String name,
             HGHandle type,
             String dimensionPath)

Convenience constructor that allows passing a dot separated dimension path that is converted to a String[].

Parameters:

name - The name of the index.

type - The type of the atoms to be indexed.

dimensionPath - The dimension path in dot format (e.g. "person.address.street")

ByPartIndexer

public ByPartIndexer(HGHandle type,
             String[] dimensionPath)

ByPartIndexer

public ByPartIndexer(String name,
             HGHandle type,
             String[] dimensionPath)

Method Detail

getDimensionPath

public String[] getDimensionPath()

setDimensionPath

public void setDimensionPath(String[] dimensionPath)

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<KeyType> 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[].

getKey

public KeyType getKey(HyperGraph graph,
             Object atom)

Description copied from class: HGKeyIndexer

Returns an index key for the given atom.

Specified by:

getKey in class HGKeyIndexer<KeyType>

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.

equals

public boolean equals(Object other)

Description copied from interface: HGIndexer

Declared to enforce implementation.

Specified by:

equals in interface HGIndexer<KeyType,HGPersistentHandle>

Overrides:

equals in class Object

hashCode

public int hashCode()

Description copied from interface: HGIndexer

Declared to enforce implementation.

Specified by:

hashCode in interface HGIndexer<KeyType,HGPersistentHandle>

Overrides:

hashCode in class Object