org.hypergraphdb.atom

Class AtomProjection

java.lang.Object

org.hypergraphdb.HGPlainLink

org.hypergraphdb.atom.AtomProjection

All Implemented Interfaces:

Iterable<HGHandle>, HGLink

public class AtomProjection
extends HGPlainLink

This link represents a relationship between a composite type and one of its projections. It states that the projection in question is an atom in itself and therefore must be recorded as a HGAtomRef in all values of this composite type. The mode of the atom reference projection is the sole attribute of the relationship.

The link is between the type whose projection is an atom reference and the type of the projection's value.

An AtomProjection also holds the name of the projection as an attribute. the name together with the value type are enough (and generally necessary) to identify the projection.

Author:

Borislav Iordanov

Field Summary

Fields inherited from class org.hypergraphdb.HGPlainLink

outgoingSet

Constructor Summary

Constructors

Constructor and Description
AtomProjection(HGHandle[] targetSet)
AtomProjection(HGHandle type, String name, HGHandle valueType, HGAtomRef.Mode mode) Construct an atom projection link.

Method Summary

Methods

Modifier and Type	Method and Description
HGAtomRef.Mode	getMode()
String	getName()
HGHandle	getProjectionValueType()
HGHandle	getType()
void	setMode(HGAtomRef.Mode mode)
void	setName(String name)

Methods inherited from class org.hypergraphdb.HGPlainLink

getArity, getTargetAt, iterator, notifyTargetHandleUpdate, notifyTargetRemoved, toString, toStringHdlArr

Methods inherited from class java.lang.Object

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

Constructor Detail

AtomProjection

public AtomProjection(HGHandle[] targetSet)

AtomProjection

public AtomProjection(HGHandle type,
              String name,
              HGHandle valueType,
              HGAtomRef.Mode mode)

Construct an atom projection link.

Parameters:

type - The handle to a HGCompositeType.

name - The name of the projection.

valueType - The type of the projection's value.

mode - The mode of the atom reference to be used when managing atoms of the composite type.

Method Detail

getType

public HGHandle getType()

getProjectionValueType

public HGHandle getProjectionValueType()

getMode

public HGAtomRef.Mode getMode()

setMode

public void setMode(HGAtomRef.Mode mode)

getName

public String getName()

setName

public void setName(String name)