org.hypergraphdb.type

Interface HGProjection

All Known Implementing Classes:

BeanPropertyBasedProjection, HGAbstractCompositeType.Projection

public interface HGProjection

A HGProjection represents a dimension of a composite type. The defining properties of a projection are its name and its type. A composite type may have several projections with the same name as long as they are of different types.

Author:

Borislav Iordanov

Method Summary

Methods

Modifier and Type	Method and Description
int[]	getLayoutPath() Return the layout path in the HGStore from the composite value to the value along this dimension.
String	getName() Return the name of the dimension that this projection represents.
HGHandle	getType() Return the handle of the type of the dimension that this projection represents.
void	inject(Object atomValue, Object value) Modify an atom's projections.
Object	project(Object atomValue) Return the projection of the passed in value along the dimension represented by this object.

Method Detail

getName

String getName()

Return the name of the dimension that this projection represents.

getType

HGHandle getType()

Return the handle of the type of the dimension that this projection represents.

getLayoutPath

int[] getLayoutPath()

Return the layout path in the HGStore from the composite value to the value along this dimension. May return null if the precise layout is not know, or not well-defined.

TODO: not sure this is needed...

project

Object project(Object atomValue)

Return the projection of the passed in value along the dimension represented by this object.

Parameters:

atomValue - The value of the atom whose projection value is desired.

Returns:

The value along the dimension embedded within the HGProjection.

inject

void inject(Object atomValue,
          Object value)

Modify an atom's projections.

Parameters:

atomValue - The value of the atom whose projection value is desired.

The - new value along the dimension embedded within the HGProjection.