Package io.permazen.schema

Class MapSchemaField

java.lang.Object
io.permazen.util.AbstractXMLStreaming
io.permazen.schema.SchemaItem
io.permazen.schema.SchemaField
io.permazen.schema.ComplexSchemaField
io.permazen.schema.MapSchemaField
All Implemented Interfaces:
DiffGenerating<MapSchemaField>, Cloneable
public class MapSchemaField extends ComplexSchemaField implements DiffGenerating<MapSchemaField>
A map field in one version of a SchemaObjectType.

  • Field Details

    • ITEM_TYPE

      public static final ItemType ITEM_TYPE
      The ItemType that this class represents.

  • Constructor Details

    • MapSchemaField

      public MapSchemaField()

  • Method Details

    • getKeyField

      public SimpleSchemaField getKeyField()
      Get this map field's key sub-field.
      Returns:
      key sub-field

    • setKeyField

      public void setKeyField(SimpleSchemaField keyField)
      Set this map field's key sub-field.
      Parameters:
      keyField - key sub-field
      Throws:
      UnsupportedOperationException - if this instance is locked down

    • getValueField

      public SimpleSchemaField getValueField()
      Get this map field's value sub-field.
      Returns:
      value sub-field

    • setValueField

      public void setValueField(SimpleSchemaField valueField)
      Set this map field's value sub-field.
      Parameters:
      valueField - value sub-field
      Throws:
      UnsupportedOperationException - if this instance is locked down

    • getSubFields

      public NavigableMap<String,SimpleSchemaField> getSubFields()
      Description copied from class: ComplexSchemaField
      Get the sub-fields of this field.
      Specified by:
      getSubFields in class ComplexSchemaField
      Returns:
      list of sub-fields, which will be unmodifiable if this instance is locked down

    • getItemType

      public final ItemType getItemType()
      Get the ItemType corresponding to this instance.
      Returns:
      schema item type

    • visit

      public <R> R visit(SchemaFieldSwitch<R> target)
      Description copied from class: SchemaField
      Apply visitor pattern.
      Specified by:
      visit in class SchemaField
      Type Parameters:
      R - visitor return type
      Parameters:
      target - target to invoke
      Returns:
      value from the method of target corresponding to this instance's type

    • differencesFrom

      public Diffs differencesFrom(MapSchemaField that)
      Description copied from interface: DiffGenerating
      Detect the differences of this instance when compared to the given instance.
      Specified by:
      differencesFrom in interface DiffGenerating<MapSchemaField>
      Parameters:
      that - other instance
      Returns:
      differences; will be empty if there are none detected

    • toString

      public String toString()
      Overrides:
      toString in class SchemaField

    • clone

      public MapSchemaField clone()
      Deep-clone this instance.

      The returned instance will not be locked down even if this one is.

      Overrides:
      clone in class ComplexSchemaField

    • getObjectType

      public SchemaObjectType getObjectType()
      Get the SchemaObjectType of which this field is a member.
      Returns:
      containing object type

    • setObjectType

      public final void setObjectType(SchemaObjectType objectType)
      Set the SchemaObjectType of which this field is a member.

      Note: this field is considered derived information, and will be set automatically when a referrring SchemaObjectType is locked down.

      Parameters:
      objectType - containing object type
      Throws:
      UnsupportedOperationException - if this instance is locked down

    • visitSchemaItems

      public final <T extends SchemaItem> void visitSchemaItems(Class<T> nodeType, Consumer<? super T> visitor)
      Visit this schema item and all of its descendents matching the given type with the given visitor.

      The traversal is depth first, post-order.

      Parameters:
      nodeType - node type to include
      visitor - visitor for schema items
      Throws:
      IllegalArgumentException - if either parameter is null

    • isLockedDown

      public final boolean isLockedDown(boolean includingStorageIds)
      Determine whether this instance is locked down.
      Parameters:
      includingStorageIds - false to test all but storage ID's, true to require storage ID's to be locked down as well
      Returns:
      true if instance is locked down, otherwise false

    • getSchemaId

      public final SchemaId getSchemaId()
      Generate a unique SchemaId corresponding to the type and encoding structure of this schema item.

      The SchemaId does not depend on the storage ID.

      This instance must be locked down except for storage ID's. Repeated invocations of this method will be very fast, just returning the cached previous result.

      Returns:
      schema ID
      Throws:
      IllegalStateException - if this instance is not locked down
      See Also: