com.sparsity.sparksee.algorithms.Context Class Reference

Context class. More...

Public Member Functions
void	ExcludeNodes (com.sparsity.sparksee.gdb.Objects nodes)
	Set which nodes can't be used.
	Context (com.sparsity.sparksee.gdb.Session session, long node)
	Creates a new instance.
void	ExcludeEdges (com.sparsity.sparksee.gdb.Objects edges)
	Set which edges can't be used.
boolean	IsClosed ()
	Gets if Context instance has been closed or not.
com.sparsity.sparksee.gdb.Objects	Compute ()
	Gets the resulting collection of nodes.
void	AddEdgeType (int t, com.sparsity.sparksee.gdb.EdgesDirection d)
	Allows for traversing edges of the given type.
void	Close ()
	Closes the Context instance.
void	SetMaximumHops (int maxhops, bool include)
	Sets the maximum hops restriction.
void	AddNodeType (int t)
	Allows for traversing nodes of the given type.
void	AddAllEdgeTypes (com.sparsity.sparksee.gdb.EdgesDirection d)
	Allows for traversing all edge types of the graph.
void	AddAllNodeTypes ()
	Allows for traversing all node types of the graph.

Static Public Member Functions
static com.sparsity.sparksee.gdb.Objects	Compute (com.sparsity.sparksee.gdb.Session session, long node, com.sparsity.sparksee.gdb.TypeList nodeTypes, com.sparsity.sparksee.gdb.TypeList edgeTypes, com.sparsity.sparksee.gdb.EdgesDirection dir, int maxhops, bool include)
	Helper method to easily compute a context from a node.

Detailed Description

Context class.

It provides a very similar functionality than the Traversal classes. The main difference is Context returns a resulting collection whereas Traversal provides an iterator behaviour.

Check out the 'Algorithms' section in the SPARKSEE User Manual for more details on this.

Author

Sparsity Technologies http://www.sparsity-technologies.com

Constructor & Destructor Documentation

Context()

com.sparsity.sparksee.algorithms.Context.Context	(	com.sparsity.sparksee.gdb.Session	session,
		long	node )

Creates a new instance.

Parameters

session	[in] Session to get the graph from and perform operation.
node	[in] Node to start traversal from.

Member Function Documentation

AddAllEdgeTypes()

void com.sparsity.sparksee.algorithms.Context.AddAllEdgeTypes

(

com.sparsity.sparksee.gdb.EdgesDirection

d

)

Allows for traversing all edge types of the graph.

Parameters

d	[in] Edge direction.

AddEdgeType()

void com.sparsity.sparksee.algorithms.Context.AddEdgeType	(	int	t,
		com.sparsity.sparksee.gdb.EdgesDirection	d )

Allows for traversing edges of the given type.

Parameters

t	[in] Edge type.
d	[in] Edge direction.

AddNodeType()

void com.sparsity.sparksee.algorithms.Context.AddNodeType

(

int

t

)

Allows for traversing nodes of the given type.

Parameters

t

null

Close()

void com.sparsity.sparksee.algorithms.Context.Close

(

)

Closes the Context instance.

It must be called to ensure the integrity of all data.

Compute() [1/2]

com.sparsity.sparksee.gdb.Objects com.sparsity.sparksee.algorithms.Context.Compute

(

)

Gets the resulting collection of nodes.

Returns

The resulting collection of nodes.

Compute() [2/2]

static com.sparsity.sparksee.gdb.Objects com.sparsity.sparksee.algorithms.Context.Compute ( com.sparsity.sparksee.gdb.Session session, long node, com.sparsity.sparksee.gdb.TypeList nodeTypes, com.sparsity.sparksee.gdb.TypeList edgeTypes, com.sparsity.sparksee.gdb.EdgesDirection dir, int maxhops, bool include )

static

Helper method to easily compute a context from a node.

Parameters

session	[in] Session to get the graph from and perform operation.
node	[in] Node to start traversal from.
nodeTypes	[in] Allowed node type list. NULL means all node types are allowed.
edgeTypes	[in] Allowed edge type list. NULL means all edge types are allowed.
dir	[in] Allowed direction for the allowed edge types.
maxhops	[in] The maximum hops restriction. It must be positive or zero. Zero, the default value, means unlimited.
include	[in] If TRUE, the resulting collection will include those nodes at distance less or equal than the given one, otherwise it will just include those nodes at distance equal than the given one. This parameter just makes sense if maxhops is different from 0; in that case it includes all nodes no matters the distance.

Returns

Returns an Objects with the computed context of a node.

ExcludeEdges()

void com.sparsity.sparksee.algorithms.Context.ExcludeEdges

(

com.sparsity.sparksee.gdb.Objects

edges

)

Set which edges can't be used.

This will replace any previously specified set of excluded edges. Should only be used to exclude the usage of specific edges from allowed edge types because it's less efficient than not allowing an edge type.

Parameters

edges

[in] A set of edge identifiers that must be kept intact until the destruction of the class.

ExcludeNodes()

void com.sparsity.sparksee.algorithms.Context.ExcludeNodes

(

com.sparsity.sparksee.gdb.Objects

nodes

)

Set which nodes can't be used.

This will replace any previously specified set of excluded nodes. Should only be used to exclude the usage of specific nodes from allowed node types because it's less efficient than not allowing a node type.

Parameters

nodes

[in] A set of node identifiers that must be kept intact until the destruction of the class.

IsClosed()

boolean com.sparsity.sparksee.algorithms.Context.IsClosed

(

)

Gets if Context instance has been closed or not.

See also

Close()

Returns

TRUE if the Context instance has been closed, FALSE otherwise.

SetMaximumHops()

void com.sparsity.sparksee.algorithms.Context.SetMaximumHops	(	int	maxhops,
		bool	include )

Sets the maximum hops restriction.

All paths longer than the maximum hops restriction will be ignored.

Parameters

maxhops	[in] The maximum hops restriction. It must be positive or zero. Zero, the default value, means unlimited.
include	[in] If TRUE, the resulting collection will include those nodes at distance less or equal than the given one, otherwise it will just include those nodes at distance equal than the given one. This parameter just makes sense if maxhops is different from 0; in that case it includes all nodes no matters the distance.