Class Type

java.lang.Object
com.sparsity.sparksee.gdb.Type

public class Type extends Object
Type data class.

It contains information about a node or edge type.

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

    • 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 Details

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