org.hypergraphdb.atom

Class HGSubgraph

java.lang.Object

org.hypergraphdb.atom.HGSubgraph

All Implemented Interfaces:

HGGraphHolder, HGHandleHolder, HyperNode

public class HGSubgraph
extends Object
implements HyperNode, HGHandleHolder, HGGraphHolder

A HyperNode that encapsulates a set of atoms from the global HyperGraph database. A subgraph can be thought of as a hyper-edge in the standard set-theoretic formulation of hypergraphs.

Author:

Borislav Iordanov

Field Summary

Fields

Modifier and Type	Field and Description
protected HyperGraph	graph
protected HGHandle	thisHandle

Constructor Summary

Constructors

Constructor and Description
HGSubgraph()

Method Summary

Methods

Modifier and Type	Method and Description
HGHandle	add(HGHandle atom) Add an existing atom to this HyperNode.
HGHandle	add(Object atom, HGHandle type, int flags) Add to global graph and mark as member of this subgraph.
long	count(HGQueryCondition condition)
void	define(HGHandle handle, HGHandle type, Object instance, int flags) Define in global graph and mark as member of this subgraph.
<T> HGSearchResult<T>	find(HGQueryCondition condition)
List<HGHandle>	findAll(HGQueryCondition condition)
<T> T	findOne(HGQueryCondition condition)
<T> T	get(HGHandle handle)
<T> List<T>	getAll(HGQueryCondition condition)
HGHandle	getAtomHandle() Return the HyperGraphDB atom handle of this object.
HyperGraph	getHyperGraph()
IncidenceSet	getIncidenceSet(HGHandle handle) Return incidence set where each element is a member of this HGSubgraph.
static HGIndex<HGPersistentHandle,HGPersistentHandle>	getIndex(HyperGraph atGraph) DO NOT USE: internal method, implementation dependent, may disappear at any time.
<T> T	getOne(HGQueryCondition condition)
static HGIndex<HGPersistentHandle,HGPersistentHandle>	getReverseIndex(HyperGraph atGraph) DO NOT USE: internal method, implementation dependent, may disappear at any time.
HGHandle	getType(HGHandle handle)
boolean	isMember(HGHandle atom)
boolean	remove(HGHandle handle) Removes an atom from this scope.
boolean	removeGlobally(HGHandle handle) Removes the atom globally from the database as well as from the nested graph.
boolean	removeGlobally(HGHandle handle, boolean keepIncidentLinks) Removes the atom globally from the database as well as from the nested graph.
boolean	replace(HGHandle handle, Object newValue, HGHandle newType) Performs the replace in the global database as this only deals with an atom's value.
void	setAtomHandle(HGHandle handle) Set the HyperGraphDB atom handle of this object - used normally only by the HyperGraph instance holding this atom.
void	setHyperGraph(HyperGraph graph) During load time, set the HyperGraph instance to which this atom belongs.

Methods inherited from class java.lang.Object

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

Field Detail

graph

protected HyperGraph graph

thisHandle

protected HGHandle thisHandle

Constructor Detail

HGSubgraph

public HGSubgraph()

Method Detail

getReverseIndex

public static HGIndex<HGPersistentHandle,HGPersistentHandle> getReverseIndex(HyperGraph atGraph)

DO NOT USE: internal method, implementation dependent, may disappear at any time.

getIndex

public static HGIndex<HGPersistentHandle,HGPersistentHandle> getIndex(HyperGraph atGraph)

DO NOT USE: internal method, implementation dependent, may disappear at any time.

isMember

public boolean isMember(HGHandle atom)

add

public HGHandle add(HGHandle atom)

Add an existing atom to this HyperNode. The atom may be a member multiple nodes at a time.

Parameters:

atom -

Returns:

The atom parameter.

add

public HGHandle add(Object atom,
           HGHandle type,
           int flags)

Add to global graph and mark as member of this subgraph.

Specified by:

add in interface HyperNode

count

public long count(HGQueryCondition condition)

Specified by:

count in interface HyperNode

define

public void define(HGHandle handle,
          HGHandle type,
          Object instance,
          int flags)

Define in global graph and mark as member of this subgraph.

Specified by:

define in interface HyperNode

find

public <T> HGSearchResult<T> find(HGQueryCondition condition)

Specified by:

find in interface HyperNode

findOne

public <T> T findOne(HGQueryCondition condition)

Specified by:

findOne in interface HyperNode

getOne

public <T> T getOne(HGQueryCondition condition)

Specified by:

getOne in interface HyperNode

findAll

public List<HGHandle> findAll(HGQueryCondition condition)

Specified by:

findAll in interface HyperNode

getAll

public <T> List<T> getAll(HGQueryCondition condition)

Specified by:

getAll in interface HyperNode

get

public <T> T get(HGHandle handle)

Specified by:

get in interface HyperNode

getIncidenceSet

public IncidenceSet getIncidenceSet(HGHandle handle)

Return incidence set where each element is a member of this HGSubgraph. The atom itself whose incidence set is returned doesn't have to be a member of the subgraph!

Specified by:

getIncidenceSet in interface HyperNode

getType

public HGHandle getType(HGHandle handle)

Specified by:

getType in interface HyperNode

removeGlobally

public boolean removeGlobally(HGHandle handle)

Removes the atom globally from the database as well as from the nested graph.

Parameters:

handle - The atom to remove.

Returns:

The result of HyperGraph.remove.

removeGlobally

public boolean removeGlobally(HGHandle handle,
                     boolean keepIncidentLinks)

Removes the atom globally from the database as well as from the nested graph.

Parameters:

handle - The atom to remove.

keepIncidentLinks - - whether to also remove links pointing to the removed atom. This parameter applies recursively to the links removed.

Returns:

The result of HyperGraph.remove.

remove

public boolean remove(HGHandle handle)

Removes an atom from this scope. The atom is not deleted from the global HyperGraph database. If you wish to delete it globally, use HyperGraph.remove.

Specified by:

remove in interface HyperNode

Returns:

Return value is unreliable

replace

public boolean replace(HGHandle handle,
              Object newValue,
              HGHandle newType)

Performs the replace in the global database as this only deals with an atom's value.

Specified by:

replace in interface HyperNode

getAtomHandle

public HGHandle getAtomHandle()

Description copied from interface: HGHandleHolder

Return the HyperGraphDB atom handle of this object.

Specified by:

getAtomHandle in interface HGHandleHolder

setAtomHandle

public void setAtomHandle(HGHandle handle)

Description copied from interface: HGHandleHolder

Set the HyperGraphDB atom handle of this object - used normally only by the HyperGraph instance holding this atom.

Specified by:

setAtomHandle in interface HGHandleHolder

Parameters:

handle - The atom handle.

setHyperGraph

public void setHyperGraph(HyperGraph graph)

Description copied from interface: HGGraphHolder

During load time, set the HyperGraph instance to which this atom belongs.

Specified by:

setHyperGraph in interface HGGraphHolder

getHyperGraph

public HyperGraph getHyperGraph()