com.sparsity.sparksee.gdb

Class Type

java.lang.Object

com.sparsity.sparksee.gdb.Type

public class Type
extends java.lang.Object

Type data class.

It contains information about a node or edge type.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	EdgesType Identifier for all edgeType attributes.
static int	GlobalType Global type identifier constant.
static int	InvalidType Invalid type identifier constant.
static int	NodesType Identifier for all nodeType attributes.

Method Summary

Modifier and Type	Method and Description
boolean	getAreNeighborsIndexed() Gets if this is an edge type with neighbors index.
int	getId() Gets the Sparksee type identifier.
boolean	getIsDirected() Gets if this is a directed edge type.
boolean	getIsRestricted() Gets if this is a restricted edge type.
java.lang.String	getName() Gets the unique type name.
long	getNumObjects() Gets the number of objects belonging to the type.
ObjectType	getObjectType() Gets the object type.
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.

Methods inherited from class java.lang.Object

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

Field Detail

InvalidType

public static int InvalidType

Invalid type identifier constant.

NodesType

public static int NodesType

Identifier for all nodeType attributes.

Identifier for all nodeType attributes.

GlobalType

public static int GlobalType

Global type identifier constant.

EdgesType

public static int EdgesType

Identifier for all edgeType attributes.

Identifier for all edgeType attributes.

Method Detail

getObjectType

public ObjectType getObjectType()

Gets the object type.

Returns:

The object type.

getId

public int getId()

Gets the Sparksee type identifier.

Returns:

The Sparksee type identifier.

getRestrictedFrom

public 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.

getNumObjects

public long getNumObjects()

Gets the number of objects belonging to the type.

Returns:

The number of objects belonging to the type.

getAreNeighborsIndexed

public boolean getAreNeighborsIndexed()

Gets if this is an edge type with neighbors index.

Returns:

TRUE for edges types with neighbors index, FALSE otherwise.

getRestrictedTo

public 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.

getIsRestricted

public boolean getIsRestricted()

Gets if this is a restricted edge type.

Returns:

TRUE for restricted edge types, FALSE otherwise.

getName

public java.lang.String getName()

Gets the unique type name.

Returns:

The unique type name.

getIsDirected

public boolean getIsDirected()

Gets if this is a directed edge type.

Returns:

TRUE for directed edge types, FALSE otherwise.