Package io.permazen.core

Class SchemaItem

java.lang.Object
io.permazen.core.SchemaItem
Direct Known Subclasses:
Field, Index, ObjType
public abstract class SchemaItem extends Object
Superclass for the ObjType, Field, and Index classes which constitute a Schema.

Instances have a SchemaId and a storage ID. Instances also have a name which must be a valid Java identifier. Instances are associated with a specific Schema.

  • Method Details

    • getName

      public String getName()
      Get the name associated with this instance.
      Returns:
      name of this object type or field, never null

    • getStorageId

      public int getStorageId()
      Get the storage ID associated with this instance.
      Returns:
      storage ID, always greater than zero

    • getSchemaId

      public SchemaId getSchemaId()
      Get the schema ID associated with this instance.
      Returns:
      schema ID, never null

    • getSchema

      public Schema getSchema()
      Get the schema with which this instance is associated.
      Returns:
      associated schema

    • toString

      public abstract String toString()
      Overrides:
      toString in class Object