Module io.github.tonywasher.joceanus.metis
Package io.github.tonywasher.joceanus.metis.field

Interface MetisFieldItem.MetisFieldSetDef

All Known Implementing Classes:
MetisFieldSet, MetisFieldVersionedSet, PrometheusEncryptedFieldSet
Enclosing interface:
MetisFieldItem
public static interface MetisFieldItem.MetisFieldSetDef
FieldSet interface.

  • Method Details

    • getName

      String getName()
      Obtain the name of the fieldSet.
      Returns:
      the name of the fieldSet.

    • getNumVersioned

      Integer getNumVersioned()
      Obtain the number of versioned fields.
      Returns:
      the number of fields.

    • fieldIterator

      Iterator<MetisFieldItem.MetisFieldDef> fieldIterator()
      Obtain the iterator over the fields.
      Returns:
      the iterator

    • hasVersions

      boolean hasVersions()
      Does the item have versioned values?
      Returns:
      true/false

    • hasLinks

      default boolean hasLinks()
      Does the item have link values?
      Returns:
      true/false

    • hasPairedLinks

      default boolean hasPairedLinks()
      Does the item have pairedLink values?
      Returns:
      true/false

    • setLocked

      void setLocked()
      Lock the fieldSet.

    • getItemType

      MetisFieldItem.MetisFieldItemType getItemType()
      Obtain the itemType.
      Returns:
      the itemType

    • getField

      MetisFieldItem.MetisFieldDef getField(MetisDataItem.MetisDataFieldId pId)
      Obtain field from fieldId.
      Parameters:
      pId - the fieldId.
      Returns:
      the corresponding field
      Throws:
      IllegalArgumentException - if name is not present