Package io.github.ajevans.dbcode.data.structures

Interface IMetadata

All Known Implementing Classes:
Metadata
public interface IMetadata
Minimal interface for metadata objects.

Minimal to give as much scope for implementations to represent different metadata standards as possible.

Implementors should consider that terms may be inserted into storage so may like to avoid categories that are also storage technology keywords, e.g. if using with databases, avoid metadata "schema" which will clash with SQL "SCHEMA".

Author:
Andy Evans
Version: 1.0 01 Mar 2021

  • Method Summary

    Modifier and Type Method Description
    ArrayList[] getAll()
    Should get the metadata as an array of ArrayLists.
    String getStandard()
    Gets metadata standard or equivalent description.
    void setStandard​(String standard)
    Should set metadata standard or equivalent description.

  • Method Details

    • setStandard

      void setStandard​(String standard)
      Should set metadata standard or equivalent description.
      Parameters:
      standard - Metadata standard or other description.

    • getStandard

      String getStandard()
      Gets metadata standard or equivalent description.
      Returns:
      String Metadata standard or other description.

    • getAll

      ArrayList[] getAll()
      Should get the metadata as an array of ArrayLists.
      • array[0] = The category names as Strings.
      • array[1] = The data types of the categories as Class
      • array[2] = The category values as objects.
      Having this mechanism for getting the values at the interface level allows interoperability (for getting values) while allowing implementations to dictate the metadata categories (and note there is no setAll so category names are immutable).
      Returns:
      ArrayList[] Array of metadata.