org.hypergraphdb.type

Class HGAbstractCompositeType.Projection

java.lang.Object

org.hypergraphdb.type.HGAbstractCompositeType.Projection

All Implemented Interfaces:

HGProjection

Enclosing class:

HGAbstractCompositeType

public static class HGAbstractCompositeType.Projection
extends Object
implements HGProjection

Constructor Summary

Constructors

Constructor and Description
HGAbstractCompositeType.Projection(String name, HGHandle type)

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

HGAbstractCompositeType.Projection

public HGAbstractCompositeType.Projection(String name,
                                  HGHandle type)

Method Detail

getLayoutPath

public int[] getLayoutPath()

Description copied from interface: HGProjection

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...

Specified by:

getLayoutPath in interface HGProjection

getName

public String getName()

Description copied from interface: HGProjection

Return the name of the dimension that this projection represents.

Specified by:

getName in interface HGProjection

getType

public HGHandle getType()

Description copied from interface: HGProjection

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

Specified by:

getType in interface HGProjection

inject

public void inject(Object atomValue,
          Object value)

Description copied from interface: HGProjection

Modify an atom's projections.

Specified by:

inject in interface HGProjection

Parameters:

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

project

public Object project(Object atomValue)

Description copied from interface: HGProjection

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

Specified by:

project in interface HGProjection

Parameters:

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

Returns:

The value along the dimension embedded within the HGProjection.