SparkseeNet  5.1.0
Public Member Functions | List of all members
com.sparsity.sparksee.gdb.Graph Class Reference

Graph class. More...

Public Member Functions

void SetAttributeText (long oid, int attr, com.sparsity.sparksee.gdb.TextStream tstream)
 Sets the writable TextStream for the given text attribute and OID. More...
 
void DumpData (System.String file) throws System.IO.IOException, System.ApplicationException
 Dumps logical data to a file. More...
 
com.sparsity.sparksee.gdb.TypeList FindTypes ()
 Gets all existing Sparksee node and edge type identifiers. More...
 
void RenameAttribute (int attr, System.String newName)
 Renames an attribute. More...
 
com.sparsity.sparksee.gdb.Objects Select (int attr, com.sparsity.sparksee.gdb.Condition cond, com.sparsity.sparksee.gdb.Value value, com.sparsity.sparksee.gdb.Objects restriction)
 Selects all OIDs satisfying the given condition for the given attribute. More...
 
long GetAttributeIntervalCount (int attr, com.sparsity.sparksee.gdb.Value lower, bool includeLower, com.sparsity.sparksee.gdb.Value higher, bool includeHigher)
 Gets how many objects have a value into the given range for the given attribute. More...
 
void TailsAndHeads (com.sparsity.sparksee.gdb.Objects edges, com.sparsity.sparksee.gdb.Objects tails, com.sparsity.sparksee.gdb.Objects heads)
 Gets all the tails and heads from the given edges collection. More...
 
long Degree (long oid, int etype, com.sparsity.sparksee.gdb.EdgesDirection dir)
 Gets the number of edges from or to the given node OID and for the given edge type. More...
 
void RenameType (System.String oldName, System.String newName)
 Renames a type. More...
 
void DumpStorage (System.String file) throws System.IO.IOException, System.ApplicationException
 Dumps internal storage data to a file. More...
 
com.sparsity.sparksee.gdb.Objects Neighbors (com.sparsity.sparksee.gdb.Objects objs, int etype, com.sparsity.sparksee.gdb.EdgesDirection dir)
 Selects all neighbor nodes from or to each of the node OID in the given collection and for the given edge type. More...
 
com.sparsity.sparksee.gdb.AttributeList GetAttributes (long oid)
 Gets all Sparksee attribute identifiers with a non-NULL value for the given Sparksee OID. More...
 
com.sparsity.sparksee.gdb.AttributeStatistics GetAttributeStatistics (int attr, bool basic)
 Gets statistics from the given attribute. More...
 
long NewNode (int type)
 Creates a new node instance. More...
 
com.sparsity.sparksee.gdb.TextStream GetAttributeText (long oid, int attr)
 Gets the read-only TextStream for the given text attribute and OID. More...
 
long CountEdges ()
 Gets the number of edges. More...
 
com.sparsity.sparksee.gdb.TypeList FindEdgeTypes ()
 Gets all existing Sparksee edge type identifiers. More...
 
com.sparsity.sparksee.gdb.Objects Select (int attr, com.sparsity.sparksee.gdb.Condition cond, com.sparsity.sparksee.gdb.Value lower, com.sparsity.sparksee.gdb.Value higher)
 Selects all OIDs satisfying the given condition for the given attribute. More...
 
void IndexAttribute (int attr, com.sparsity.sparksee.gdb.AttributeKind kind)
 Updates the index of the given attribute. More...
 
com.sparsity.sparksee.gdb.Type GetType (int type)
 Gets information about the given type. More...
 
int FindAttribute (int type, System.String name)
 Gets the Sparksee attribute identifier for the given type identifier and attribute name. More...
 
int NewAttribute (int type, System.String name, com.sparsity.sparksee.gdb.DataType dt, com.sparsity.sparksee.gdb.AttributeKind kind)
 Creates a new attribute. More...
 
com.sparsity.sparksee.gdb.Objects Edges (int etype, long tail, long head)
 Gets all the edges of the given type between two given nodes (tail and head). More...
 
com.sparsity.sparksee.gdb.Objects Select (int type)
 Selects all OIDs belonging to the given type. More...
 
com.sparsity.sparksee.gdb.Objects Select (int attr, com.sparsity.sparksee.gdb.Condition cond, com.sparsity.sparksee.gdb.Value value)
 Selects all OIDs satisfying the given condition for the given attribute. More...
 
long FindOrCreateObject (int attr, com.sparsity.sparksee.gdb.Value value)
 Finds one object having the given Value for the attribute or it creates one does not exist any. More...
 
com.sparsity.sparksee.gdb.TypeList FindNodeTypes ()
 Gets all existing Sparksee node type identifiers. More...
 
com.sparsity.sparksee.gdb.Value GetAttribute (long oid, int attr)
 Gets the Value for the given attribute and OID. More...
 
void RemoveAttribute (int attr)
 Removes the given attribute. More...
 
void SetAttributeDefaultValue (int attr, com.sparsity.sparksee.gdb.Value value)
 Sets a default value for an attribute. More...
 
void Backup (System.String file) throws System.IO.IOException, System.ApplicationException
 Dumps all the data to a backup file. More...
 
int NewSessionAttribute (int type, com.sparsity.sparksee.gdb.DataType dt, com.sparsity.sparksee.gdb.AttributeKind kind, com.sparsity.sparksee.gdb.Value defaultValue)
 Creates a new Session attribute with a default value. More...
 
com.sparsity.sparksee.gdb.AttributeList FindAttributes (int type)
 Gets all existing Sparksee attribute identifiers for the given type identifier. More...
 
void GetAttribute (long oid, int attr, com.sparsity.sparksee.gdb.Value value)
 Gets the Value for the given attribute and OID. More...
 
long CountNodes ()
 Gets the number of nodes. More...
 
com.sparsity.sparksee.gdb.EdgeData GetEdgeData (long edge)
 Gets information about an edge. More...
 
void SetAttribute (long oid, int attr, com.sparsity.sparksee.gdb.Value value)
 Sets the Value for the given attribute and OID. More...
 
com.sparsity.sparksee.gdb.Objects Neighbors (long oid, int etype, com.sparsity.sparksee.gdb.EdgesDirection dir)
 Selects all neighbor nodes from or to the given node OID and for the given edge type. More...
 
void RenameType (int type, System.String newName)
 Renames a type. More...
 
com.sparsity.sparksee.gdb.Objects Explode (com.sparsity.sparksee.gdb.Objects objs, int etype, com.sparsity.sparksee.gdb.EdgesDirection dir)
 Selects all edges from or to each of the node OID in the given collection and for the given edge type. More...
 
int NewNodeType (System.String name)
 Creates a new node type. More...
 
int NewSessionAttribute (int type, com.sparsity.sparksee.gdb.DataType dt, com.sparsity.sparksee.gdb.AttributeKind kind)
 Creates a new Session attribute. More...
 
com.sparsity.sparksee.gdb.Objects Tails (com.sparsity.sparksee.gdb.Objects edges)
 Gets all the tails from the given edges collection. More...
 
long FindOrCreateEdge (int etype, long tail, long head)
 Gets any of the edges of the specified type between two given nodes (tail and head). More...
 
void Drop (long oid)
 Drops the given OID. More...
 
int NewEdgeType (System.String name, bool directed, bool neighbors)
 Creates a new edge type. More...
 
com.sparsity.sparksee.gdb.Objects Heads (com.sparsity.sparksee.gdb.Objects edges)
 Gets all the heads from the given edges collection. More...
 
long FindEdge (int etype, long tail, long head)
 Gets any of the edges of the given type between two given nodes (tail and head). More...
 
com.sparsity.sparksee.gdb.Objects Explode (long oid, int etype, com.sparsity.sparksee.gdb.EdgesDirection dir)
 Selects all edges from or to the given node OID and for the given edge type. More...
 
long FindObject (int attr, com.sparsity.sparksee.gdb.Value value)
 Finds one object having the given Value for the given attribute. More...
 
void Drop (com.sparsity.sparksee.gdb.Objects objs)
 Drops all the OIDs from the given collection. More...
 
int NewAttribute (int type, System.String name, com.sparsity.sparksee.gdb.DataType dt, com.sparsity.sparksee.gdb.AttributeKind kind, com.sparsity.sparksee.gdb.Value defaultValue)
 Creates a new attribute with a default value. More...
 
int GetObjectType (long oid)
 Gets the Sparksee node or edge type identifier for the given OID. More...
 
com.sparsity.sparksee.gdb.Attribute GetAttribute (int attr)
 Gets information about the given attribute. More...
 
void Export (System.String file, com.sparsity.sparksee.gdb.ExportType type, com.sparsity.sparksee.gdb.ExportManager em) throws System.IO.IOException
 Exports the Graph. More...
 
long NewEdge (int type, int tailAttr, com.sparsity.sparksee.gdb.Value tailV, int headAttr, com.sparsity.sparksee.gdb.Value headV)
 Creates a new edge instance. More...
 
com.sparsity.sparksee.gdb.Values GetValues (int attr)
 Gets the Value collection for the given attribute. More...
 
long GetEdgePeer (long edge, long node)
 Gets the other end for the given edge. More...
 
long NewEdge (int type, long tail, long head)
 Creates a new edge instance. More...
 
com.sparsity.sparksee.gdb.Objects Select (int attr, com.sparsity.sparksee.gdb.Condition cond, com.sparsity.sparksee.gdb.Value lower, com.sparsity.sparksee.gdb.Value higher, com.sparsity.sparksee.gdb.Objects restriction)
 Selects all OIDs satisfying the given condition for the given attribute. More...
 
int FindType (System.String name)
 Gets the Sparksee type identifier for the given type name. More...
 
void RemoveType (int type)
 Removes the given type. More...
 
int NewRestrictedEdgeType (System.String name, int tail, int head, bool neighbors)
 Creates a new restricted edge type. More...
 

Detailed Description

Graph class.

Each Database has a Graph associated, which is the persistent graph which contains all data stored into the graph database and is retrieved from a Session.

Check out the 'API' and the 'SPARKSEE graph database' sections in the SPARKSEE User Manual for more details on the use of this class.

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

Member Function Documentation

void com.sparsity.sparksee.gdb.Graph.Backup ( System.String  file) throws System.IO.IOException, System.ApplicationException

Dumps all the data to a backup file.

See the Sparksee class Restore method.

Parameters
file[in] Output backup file path.
Exceptions
System.IO.IOExceptionIf the given file cannot be created.
System.ApplicationExceptionnull
long com.sparsity.sparksee.gdb.Graph.CountEdges ( )

Gets the number of edges.

Returns
The number of edges.
long com.sparsity.sparksee.gdb.Graph.CountNodes ( )

Gets the number of nodes.

Returns
The number of nodes.
long com.sparsity.sparksee.gdb.Graph.Degree ( long  oid,
int  etype,
com.sparsity.sparksee.gdb.EdgesDirection  dir 
)

Gets the number of edges from or to the given node OID and for the given edge type.

Parameters
oid[in] Sparksee node OID.
etype[in] Sparksee edge type identifier.
dir[in] Direction.
Returns
The number of edges.
void com.sparsity.sparksee.gdb.Graph.Drop ( long  oid)

Drops the given OID.

It also removes its egdges as well as its attribute values.

Parameters
oid[in] Sparksee OID to be removed.
void com.sparsity.sparksee.gdb.Graph.Drop ( com.sparsity.sparksee.gdb.Objects  objs)

Drops all the OIDs from the given collection.

See Drop method with the single OID parameter. This performs that call for all the elements into the collection.

Parameters
objs[in] Objects collection with the OIDs to be removed.
void com.sparsity.sparksee.gdb.Graph.DumpData ( System.String  file) throws System.IO.IOException, System.ApplicationException

Dumps logical data to a file.

Parameters
file[in] Output file path.
Exceptions
System.IO.IOExceptionIf the given file cannot be created.
System.ApplicationExceptionnull
void com.sparsity.sparksee.gdb.Graph.DumpStorage ( System.String  file) throws System.IO.IOException, System.ApplicationException

Dumps internal storage data to a file.

Parameters
file[in] Output file path.
Exceptions
System.IO.IOExceptionIf the given file cannot be created.
System.ApplicationExceptionnull
com.sparsity.sparksee.gdb.Objects com.sparsity.sparksee.gdb.Graph.Edges ( int  etype,
long  tail,
long  head 
)

Gets all the edges of the given type between two given nodes (tail and head).

Parameters
etype[in] Sparksee edge type identifier.
tail[in] Tail node identifier.
head[in] Head node identifier.
Returns
Objects instance.
com.sparsity.sparksee.gdb.Objects com.sparsity.sparksee.gdb.Graph.Explode ( com.sparsity.sparksee.gdb.Objects  objs,
int  etype,
com.sparsity.sparksee.gdb.EdgesDirection  dir 
)

Selects all edges from or to each of the node OID in the given collection and for the given edge type.

Parameters
objs[in] Sparksee node OID collection.
etype[in] Sparksee edge type identifier.
dir[in] Direction.
Returns
Objects instance.
com.sparsity.sparksee.gdb.Objects com.sparsity.sparksee.gdb.Graph.Explode ( long  oid,
int  etype,
com.sparsity.sparksee.gdb.EdgesDirection  dir 
)

Selects all edges from or to the given node OID and for the given edge type.

Parameters
oid[in] Sparksee node OID.
etype[in] Sparksee edge type identifier.
dir[in] Direction.
Returns
Objects instance.
void com.sparsity.sparksee.gdb.Graph.Export ( System.String  file,
com.sparsity.sparksee.gdb.ExportType  type,
com.sparsity.sparksee.gdb.ExportManager  em 
) throws System.IO.IOException

Exports the Graph.

Parameters
file[in] Output file.
type[in] Export type.
em[in] Defines how to do the export for each graph object.
Exceptions
System.IO.IOExceptionnull
int com.sparsity.sparksee.gdb.Graph.FindAttribute ( int  type,
System.String  name 
)

Gets the Sparksee attribute identifier for the given type identifier and attribute name.

Parameters
type[in] Sparksee type identifier.
name[in] Unique attribute name.
Returns
The Sparksee attribute identifier for the given type and attribute name or InvalidAttribute if there is no attribute with the given name for the given type.
com.sparsity.sparksee.gdb.AttributeList com.sparsity.sparksee.gdb.Graph.FindAttributes ( int  type)

Gets all existing Sparksee attribute identifiers for the given type identifier.

Parameters
type[in] Sparksee type identifier.
Returns
Sparksee attribute identifier list.
long com.sparsity.sparksee.gdb.Graph.FindEdge ( int  etype,
long  tail,
long  head 
)

Gets any of the edges of the given type between two given nodes (tail and head).

If there are more than one, then any of them will be returned. And in case there are no edge between the given tail and head, the Objects InvalidOID will be returned.

Parameters
etype[in] Sparksee edge type identifier.
tail[in] Tail node identifier.
head[in] Head node identifier.
Returns
Any of the edges or the Objects InvalidOID.
com.sparsity.sparksee.gdb.TypeList com.sparsity.sparksee.gdb.Graph.FindEdgeTypes ( )

Gets all existing Sparksee edge type identifiers.

Returns
Sparksee edge type identifier list.
com.sparsity.sparksee.gdb.TypeList com.sparsity.sparksee.gdb.Graph.FindNodeTypes ( )

Gets all existing Sparksee node type identifiers.

Returns
Sparksee node type identifier list.
long com.sparsity.sparksee.gdb.Graph.FindObject ( int  attr,
com.sparsity.sparksee.gdb.Value  value 
)

Finds one object having the given Value for the given attribute.

If there are more than one, then any of them will be returned. And in case there are no object having this Value, the Objects InvalidOID will be returned.

Parameters
attr[in] Sparksee attribute identifier.
value[in] Value.
Returns
Sparksee OID or the Objects InvalidOID.
long com.sparsity.sparksee.gdb.Graph.FindOrCreateEdge ( int  etype,
long  tail,
long  head 
)

Gets any of the edges of the specified type between two given nodes (tail and head).

If it can not find any edge of this type between them it tries to create a new one.

Parameters
etype[in] Sparksee edge type identifier.
tail[in] Tail node identifier.
head[in] Head node identifier.
Returns
Any of the edges or the Objects InvalidOID.
long com.sparsity.sparksee.gdb.Graph.FindOrCreateObject ( int  attr,
com.sparsity.sparksee.gdb.Value  value 
)

Finds one object having the given Value for the attribute or it creates one does not exist any.

If the attribute is a node or edge attribute and at least one node/edge with that value is found, it returns one of them. But if it does not exist, then: If it's a node attribute it will create it and set the attribute. If it's an edge attribute it will return the InvalidOID.

Using this method with a global attribute will return the InvalidOID.

Parameters
attr[in] Sparksee attribute identifier.
value[in] Value.
Returns
Sparksee OID or the Objects InvalidOID.
int com.sparsity.sparksee.gdb.Graph.FindType ( System.String  name)

Gets the Sparksee type identifier for the given type name.

Parameters
name[in] Unique type name.
Returns
The Sparksee type identifier for the given type name or the Type InvalidType if there is no type with the given name.
com.sparsity.sparksee.gdb.TypeList com.sparsity.sparksee.gdb.Graph.FindTypes ( )

Gets all existing Sparksee node and edge type identifiers.

Returns
Sparksee node and edge type identifier list.
com.sparsity.sparksee.gdb.Value com.sparsity.sparksee.gdb.Graph.GetAttribute ( long  oid,
int  attr 
)

Gets the Value for the given attribute and OID.

The other version of this call, where the Value is an output parameter instead of the return, is better because it allows the user to reuse an existing Value instance, whereas this call always creates a new Value instance to be returned.

It never returns NULL. Thus, in case the OID has a NULL value for the attribute it returns a NULL Value instance.

Parameters
oid[in] Sparksee OID.
attr[in] Sparksee attribute identifier.
Returns
A new Value instance having the attribute value for the given OID.
void com.sparsity.sparksee.gdb.Graph.GetAttribute ( long  oid,
int  attr,
com.sparsity.sparksee.gdb.Value  value 
)

Gets the Value for the given attribute and OID.

Parameters
oid[in] Sparksee OID.
attr[in] Sparksee attribute identifier.
value[in|out] Value for the given attribute and for the given OID.
com.sparsity.sparksee.gdb.Attribute com.sparsity.sparksee.gdb.Graph.GetAttribute ( int  attr)

Gets information about the given attribute.

Parameters
attr[in] Sparksee attribute identifier.
Returns
The Attribute for the given Sparksee attribute identifier.
long com.sparsity.sparksee.gdb.Graph.GetAttributeIntervalCount ( int  attr,
com.sparsity.sparksee.gdb.Value  lower,
bool  includeLower,
com.sparsity.sparksee.gdb.Value  higher,
bool  includeHigher 
)

Gets how many objects have a value into the given range for the given attribute.

This only works for the attributes with the AttributeKind Indexed or Unique.

Given values must belong to the same DataType than the attribute.

Parameters
attr[in] Sparksee attribute identifier.
lower[in] Lower bound Value of the range.
includeLower[in] If TRUE, include lower bound Value of the range.
higher[in] Higher bound Value of the range.
includeHigher[in] If TRUE, include higher bound Value of the range.
Returns
Number of objects having a value into the given range.
com.sparsity.sparksee.gdb.AttributeList com.sparsity.sparksee.gdb.Graph.GetAttributes ( long  oid)

Gets all Sparksee attribute identifiers with a non-NULL value for the given Sparksee OID.

Parameters
oid[in] Sparksee OID.
Returns
Sparksee attribute identifier list.
com.sparsity.sparksee.gdb.AttributeStatistics com.sparsity.sparksee.gdb.Graph.GetAttributeStatistics ( int  attr,
bool  basic 
)

Gets statistics from the given attribute.

Parameters
attr[in] Sparksee attribute identifier.
basic[in] If FALSE all statistics are computed, if TRUE just those statistics marked as basic will be computed (see description of the AttributeStatistics class). Of course, computing just basic statistics will be faster than computing all of them.
Returns
An AttributeStatistics instace.
com.sparsity.sparksee.gdb.TextStream com.sparsity.sparksee.gdb.Graph.GetAttributeText ( long  oid,
int  attr 
)

Gets the read-only TextStream for the given text attribute and OID.

Parameters
oid[in] Sparksee OID.
attr[in] Sparksee attribute identifier.
Returns
A TextStream. This returns a TextStream to read.
com.sparsity.sparksee.gdb.EdgeData com.sparsity.sparksee.gdb.Graph.GetEdgeData ( long  edge)

Gets information about an edge.

Parameters
edge[in] Sparksee edge identifier.
Returns
An EdgeData instance.
long com.sparsity.sparksee.gdb.Graph.GetEdgePeer ( long  edge,
long  node 
)

Gets the other end for the given edge.

Parameters
edge[in] Sparksee edge identifier.
node[in] Sparksee node identifier. It must be one of the ends of the edge.
Returns
The other end of the edge.
int com.sparsity.sparksee.gdb.Graph.GetObjectType ( long  oid)

Gets the Sparksee node or edge type identifier for the given OID.

Parameters
oid[in] Sparksee OID.
Returns
Sparksee node or edge type identifier.
com.sparsity.sparksee.gdb.Type com.sparsity.sparksee.gdb.Graph.GetType ( int  type)

Gets information about the given type.

Parameters
type[in] Sparksee type identifier.
Returns
The Type for the given Sparksee type identifier.
com.sparsity.sparksee.gdb.Values com.sparsity.sparksee.gdb.Graph.GetValues ( int  attr)

Gets the Value collection for the given attribute.

Parameters
attr[in] Sparksee attribute identifier.
Returns
Returns a Values object.
com.sparsity.sparksee.gdb.Objects com.sparsity.sparksee.gdb.Graph.Heads ( com.sparsity.sparksee.gdb.Objects  edges)

Gets all the heads from the given edges collection.

Parameters
edges[in] Sparksee edge identifier collection.
Returns
The heads collection.
void com.sparsity.sparksee.gdb.Graph.IndexAttribute ( int  attr,
com.sparsity.sparksee.gdb.AttributeKind  kind 
)

Updates the index of the given attribute.

This just works if the current index of the attribute corresponds to the AttributeKind Basic and the new one is Indexed or Unique.

Parameters
attr[in] Sparksee attribute identifier.
kind[in] Attribute kind.
com.sparsity.sparksee.gdb.Objects com.sparsity.sparksee.gdb.Graph.Neighbors ( com.sparsity.sparksee.gdb.Objects  objs,
int  etype,
com.sparsity.sparksee.gdb.EdgesDirection  dir 
)

Selects all neighbor nodes from or to each of the node OID in the given collection and for the given edge type.

Parameters
objs[in] Sparksee node OID collection.
etype[in] Sparksee edge type identifier.
dir[in] Direction.
Returns
Objects instance.
com.sparsity.sparksee.gdb.Objects com.sparsity.sparksee.gdb.Graph.Neighbors ( long  oid,
int  etype,
com.sparsity.sparksee.gdb.EdgesDirection  dir 
)

Selects all neighbor nodes from or to the given node OID and for the given edge type.

Parameters
oid[in] Sparksee node OID.
etype[in] Sparksee edge type identifier.
dir[in] Direction.
Returns
Objects instance.
int com.sparsity.sparksee.gdb.Graph.NewAttribute ( int  type,
System.String  name,
com.sparsity.sparksee.gdb.DataType  dt,
com.sparsity.sparksee.gdb.AttributeKind  kind 
)

Creates a new attribute.

Parameters
type[in] Sparksee node or edge type identifier.
name[in] Unique name for the new attribute.
dt[in] Data type for the new attribute.
kind[in] Attribute kind.
Returns
Unique Sparksee attribute identifier.
int com.sparsity.sparksee.gdb.Graph.NewAttribute ( int  type,
System.String  name,
com.sparsity.sparksee.gdb.DataType  dt,
com.sparsity.sparksee.gdb.AttributeKind  kind,
com.sparsity.sparksee.gdb.Value  defaultValue 
)

Creates a new attribute with a default value.

Parameters
type[in] Sparksee node or edge type identifier.
name[in] Unique name for the new attribute.
dt[in] Data type for the new attribute.
kind[in] Attribute kind.
defaultValue[in] The default value to use in each new node/edge.
Returns
Unique Sparksee attribute identifier.
long com.sparsity.sparksee.gdb.Graph.NewEdge ( int  type,
int  tailAttr,
com.sparsity.sparksee.gdb.Value  tailV,
int  headAttr,
com.sparsity.sparksee.gdb.Value  headV 
)

Creates a new edge instance.

The tail of the edge will be any node having the given tailV Value for the given tailAttr attribute identifier, and the head of the edge will be any node having the given headV Value for the given headAttr attribute identifier.

Parameters
type[in] Sparksee type identifier.
tailAttr[in] Sparksee attribute identifier.
tailV[in] Value.
headAttr[in] Sparksee attribute identifier.
headV[in] Value.
Returns
Unique OID of the new edge instance.
long com.sparsity.sparksee.gdb.Graph.NewEdge ( int  type,
long  tail,
long  head 
)

Creates a new edge instance.

Parameters
type[in] Sparksee type identifier.
tail[in] Source Sparksee OID.
head[in] Target Sparksee OID.
Returns
Unique OID of the new edge instance.
int com.sparsity.sparksee.gdb.Graph.NewEdgeType ( System.String  name,
bool  directed,
bool  neighbors 
)

Creates a new edge type.

Parameters
name[in] Unique name for the new edge type.
directed[in] If TRUE, this creates a directed edge type, otherwise this creates a undirected edge type.
neighbors[in] If TRUE, this indexes neighbor nodes, otherwise not.
Returns
Unique Sparksee type identifier.
long com.sparsity.sparksee.gdb.Graph.NewNode ( int  type)

Creates a new node instance.

Parameters
type[in] Sparksee type identifier.
Returns
Unique OID of the new node instance.
int com.sparsity.sparksee.gdb.Graph.NewNodeType ( System.String  name)

Creates a new node type.

Parameters
name[in] Unique name for the new node type.
Returns
Unique Sparksee type identifier.
int com.sparsity.sparksee.gdb.Graph.NewRestrictedEdgeType ( System.String  name,
int  tail,
int  head,
bool  neighbors 
)

Creates a new restricted edge type.

Parameters
name[in] Unique name for the new edge type.
tail[in] Tail Sparksee node type identifier.
head[in] Head Sparksee node type identifier.
neighbors[in] If TRUE, this indexes neighbor nodes, otherwise not.
Returns
Unique Sparksee type identifier.
int com.sparsity.sparksee.gdb.Graph.NewSessionAttribute ( int  type,
com.sparsity.sparksee.gdb.DataType  dt,
com.sparsity.sparksee.gdb.AttributeKind  kind,
com.sparsity.sparksee.gdb.Value  defaultValue 
)

Creates a new Session attribute with a default value.

Session attributes are exclusive for the Session (just its Session can use the attribute) and are automatically removed when the Session is closed (thus, attribute data is not persistent into the database).

Since they are not persistent, they cannot be retrieved from the database, so they do not have an identifier name.

Parameters
type[in] Sparksee node or edge type identifier.
dt[in] Data type for the new attribute.
kind[in] Attribute kind.
defaultValue[in] The default value to use in each new node/edge.
Returns
Unique Sparksee attribute identifier.
int com.sparsity.sparksee.gdb.Graph.NewSessionAttribute ( int  type,
com.sparsity.sparksee.gdb.DataType  dt,
com.sparsity.sparksee.gdb.AttributeKind  kind 
)

Creates a new Session attribute.

Session attributes are exclusive for the Session (just its Session can use the attribute) and are automatically removed when the Session is closed (thus, attribute data is not persistent into the database).

Since they are not persistent, they cannot be retrieved from the database, so they do not have an identifier name.

Parameters
type[in] Sparksee node or edge type identifier.
dt[in] Data type for the new attribute.
kind[in] Attribute kind.
Returns
Unique Sparksee attribute identifier.
void com.sparsity.sparksee.gdb.Graph.RemoveAttribute ( int  attr)

Removes the given attribute.

Parameters
attr[in] Sparksee attribute identifier.
void com.sparsity.sparksee.gdb.Graph.RemoveType ( int  type)

Removes the given type.

This fails if there exist attributes defined for the type or if there exist restricted edges referencing this type.

Parameters
type[in] Sparksee type identifier.
void com.sparsity.sparksee.gdb.Graph.RenameAttribute ( int  attr,
System.String  newName 
)

Renames an attribute.

The new name must be available.

Parameters
attr[in] Sparksee attribute identifier.
newName[in] The new name for the attribute.
void com.sparsity.sparksee.gdb.Graph.RenameType ( System.String  oldName,
System.String  newName 
)

Renames a type.

The new name must be available.

Parameters
oldName[in] The current name of the type to be renamed.
newName[in] The new name for the type.
void com.sparsity.sparksee.gdb.Graph.RenameType ( int  type,
System.String  newName 
)

Renames a type.

The new name must be available.

Parameters
type[in] The type to be renamed.
newName[in] The new name for the type.
com.sparsity.sparksee.gdb.Objects com.sparsity.sparksee.gdb.Graph.Select ( int  attr,
com.sparsity.sparksee.gdb.Condition  cond,
com.sparsity.sparksee.gdb.Value  value,
com.sparsity.sparksee.gdb.Objects  restriction 
)

Selects all OIDs satisfying the given condition for the given attribute.

Parameters
attr[in] Sparksee attribute identifier.
cond[in] Condition to be satisfied.
value[in] Value to be satisfied.
restriction[in] Objects to limit the select in this set of objects.
Returns
Objects instance.
com.sparsity.sparksee.gdb.Objects com.sparsity.sparksee.gdb.Graph.Select ( int  attr,
com.sparsity.sparksee.gdb.Condition  cond,
com.sparsity.sparksee.gdb.Value  lower,
com.sparsity.sparksee.gdb.Value  higher 
)

Selects all OIDs satisfying the given condition for the given attribute.

This allows to perform the Between operation, thus it has two Value arguments.

Parameters
attr[in] Sparksee attribute identifier.
cond[in] Condition to be satisfied. It must be the Between Condition.
lower[in] Lower-bound Value to be satisfied.
higher[in] Higher-bound Value to be satisfied.
Returns
Objects instance.
com.sparsity.sparksee.gdb.Objects com.sparsity.sparksee.gdb.Graph.Select ( int  type)

Selects all OIDs belonging to the given type.

Parameters
type[in] Sparksee type identifier.
Returns
Objects instance.
com.sparsity.sparksee.gdb.Objects com.sparsity.sparksee.gdb.Graph.Select ( int  attr,
com.sparsity.sparksee.gdb.Condition  cond,
com.sparsity.sparksee.gdb.Value  value 
)

Selects all OIDs satisfying the given condition for the given attribute.

Parameters
attr[in] Sparksee attribute identifier.
cond[in] Condition to be satisfied.
value[in] Value to be satisfied.
Returns
Objects instance.

Selects all OIDs satisfying the given condition for the given attribute.

This allows to perform the Between operation, thus it has two Value arguments.

Parameters
attr[in] Sparksee attribute identifier.
cond[in] Condition to be satisfied. It must be the Between Condition.
lower[in] Lower-bound Value to be satisfied.
higher[in] Higher-bound Value to be satisfied.
restriction[in] Objects to limit the select in this set of objects.
Returns
Objects instance.
void com.sparsity.sparksee.gdb.Graph.SetAttribute ( long  oid,
int  attr,
com.sparsity.sparksee.gdb.Value  value 
)

Sets the Value for the given attribute and OID.

Parameters
oid[in] Sparksee OID.
attr[in] Sparksee attribute identifier.
value[in] Value for the given attribute and for the given OID.
void com.sparsity.sparksee.gdb.Graph.SetAttributeDefaultValue ( int  attr,
com.sparsity.sparksee.gdb.Value  value 
)

Sets a default value for an attribute.

The default value will be applied to all the new nodes or edges.

The given value must have the same DataType as the attribute or be a NULL value to remove the current default value.

Parameters
attr[in] The attribute.
value[in] The default value to use for this attribute.
void com.sparsity.sparksee.gdb.Graph.SetAttributeText ( long  oid,
int  attr,
com.sparsity.sparksee.gdb.TextStream  tstream 
)

Sets the writable TextStream for the given text attribute and OID.

Parameters
oid[in] Sparksee OID.
attr[in] Sparksee attribute identifier.
tstream[in] New Text value. This corresponds to a TextStream to write.
com.sparsity.sparksee.gdb.Objects com.sparsity.sparksee.gdb.Graph.Tails ( com.sparsity.sparksee.gdb.Objects  edges)

Gets all the tails from the given edges collection.

Parameters
edges[in] Sparksee edge identifier collection.
Returns
The tails collection.
void com.sparsity.sparksee.gdb.Graph.TailsAndHeads ( com.sparsity.sparksee.gdb.Objects  edges,
com.sparsity.sparksee.gdb.Objects  tails,
com.sparsity.sparksee.gdb.Objects  heads 
)

Gets all the tails and heads from the given edges collection.

Parameters
edges[in] Sparksee edge identifier collection.
tails[in|out] If not NULL, all the tails will be stored here.
heads[in|out] If not NULL, all the heads will be stored here.