Sparksee  5.2.0
STSType Class Reference

Type data class. More...

Inheritance diagram for STSType:
Inheritance graph
Collaboration diagram for STSType:
Collaboration graph

Instance Methods

(int) - getId
 Gets the Sparksee type identifier.
 
(enum STSObjectType) - getObjectType
 Gets the object type.
 
(NSString *) - getName
 Gets the unique type name.
 
(long long) - getNumObjects
 Gets the number of objects belonging to the type.
 
(BOOL) - getIsDirected
 Gets if this is a directed edge type.
 
(BOOL) - getIsRestricted
 Gets if this is a restricted edge type.
 
(BOOL) - getAreNeighborsIndexed
 Gets if this is an edge type with neighbors index.
 
(int) - getRestrictedFrom
 Gets the tail or source type identifier for restricted edge types.
 
(int) - getRestrictedTo
 Gets the head or target type identifier for restricted edge types.
 

Class Methods

(int) + getInvalidType
 Invalid type identifier.
 
(int) + getGlobalType
 Global type identifier.
 
(int) + getNodesType
 Identifier for all nodeType attributes.
 
(int) + getEdgesType
 Identifier for all edgeType attributes.
 

Detailed Description

Type data class.

It contains information about a node or edge type.

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

Method Documentation

- (BOOL) getAreNeighborsIndexed

Gets if this is an edge type with neighbors index.

Returns
TRUE for edges types with neighbors index, FALSE otherwise.
- (int) getId

Gets the Sparksee type identifier.

Returns
The Sparksee type identifier.
- (BOOL) getIsDirected

Gets if this is a directed edge type.

Returns
TRUE for directed edge types, FALSE otherwise.
- (BOOL) getIsRestricted

Gets if this is a restricted edge type.

Returns
TRUE for restricted edge types, FALSE otherwise.
- (NSString*) getName

Gets the unique type name.

Returns
The unique type name.
- (long long) getNumObjects

Gets the number of objects belonging to the type.

Returns
The number of objects belonging to the type.
- (enum STSObjectType) getObjectType

Gets the object type.

Returns
The object type.
- (int) getRestrictedFrom

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.
- (int) getRestrictedTo

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.

The documentation for this class was generated from the following file: