sparksee.Type Class Reference

Type data class. More...

List of all members.

Public Member Functions

def get_restricted_from
 Gets the tail or source type identifier for restricted edge types.
def get_are_neighbors_indexed
 Gets if this is an edge type with neighbors index.
def get_object_type
 Gets the object type.
def get_restricted_to
 Gets the head or target type identifier for restricted edge types.
def get_is_restricted
 Gets if this is a restricted edge type.
def get_num_objects
 Gets the number of objects belonging to the type.
def get_id
 Gets the Sparksee type identifier.
def get_is_directed
 Gets if this is a directed edge type.
def get_name
 Gets the unique type name.

Static Public Attributes

int GLOBAL_TYPE = 1
 Global type identifier constant.
int INVALID_TYPE = 0
 Invalid type identifier constant.


Detailed Description

Type data class.

It contains information about a node or edge type.

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

Member Function Documentation

def sparksee.Type.get_restricted_from (   self  ) 

Gets the tail or source type identifier for restricted edge types.

Returns:
For restricted edge types, the tail or source type identifier, the Type InvalidType otherwise.

def sparksee.Type.get_are_neighbors_indexed (   self  ) 

Gets if this is an edge type with neighbors index.

Returns:
TRUE for edges types with neighbors index, FALSE otherwise.

def sparksee.Type.get_object_type (   self  ) 

Gets the object type.

Returns:
The object type.

def sparksee.Type.get_restricted_to (   self  ) 

Gets the head or target type identifier for restricted edge types.

Returns:
For restricted edge types, the head or target type identifier, the Type InvalidType otherwise.

def sparksee.Type.get_is_restricted (   self  ) 

Gets if this is a restricted edge type.

Returns:
TRUE for restricted edge types, FALSE otherwise.

def sparksee.Type.get_num_objects (   self  ) 

Gets the number of objects belonging to the type.

Returns:
The number of objects belonging to the type.

def sparksee.Type.get_id (   self  ) 

Gets the Sparksee type identifier.

Returns:
The Sparksee type identifier.

def sparksee.Type.get_is_directed (   self  ) 

Gets if this is a directed edge type.

Returns:
TRUE for directed edge types, FALSE otherwise.

def sparksee.Type.get_name (   self  ) 

Gets the unique type name.

Returns:
The unique type name.


Generated on Fri Feb 7 13:22:18 2014 for SparkseePython by  doxygen 1.5.6