RCSB-MOJAVE-META

The repository contains JSON schema specification files and RCSB extensions.

The repository contains Java types and constants for the JSON schema meta-schema itself. The JSON Schema core specification defines terminology and describes validation keywords used to write JSON Schema instances. We also define custom vocabulary that extend core keywords by adding new properties to the JSON Schema draft. Custom properties are appended under rcsb_ namespace to indicate provenance.

Custom JSON Schema Meta-Schema Extensions

The extensions serve diverse purposes:

• metadata for additional descriptions:
  • rcsb_description
  • rcsb_enum_annotated
  • rcsb_units
  • rcsb_precision_digits
• metadata to represent dynamic values associated with fields:
  • rcsb_current_maximum_value
  • rcsb_current_minimum_value
• metadata used for text-indexing:
  • rcsb_search_context
  • rcsb_full_text_priority
  • rcsb_nested_indexing
  • rcsb_nested_indexing_context

Tying Meta-Schema to Types

Code is generated in the generate-sources phase during the project build. Generation works by calling the following classes from the pom.xml:

• org.rcsb.mojave.tools.core.GenerateSchemaConstants - generates Java constants that correspond directly to definitions in the JSON schema meta-schema.
• org.rcsb.mojave.tools.core.GenerateSchemaEnums- generates Java enums that correspond to keywords described as enums in the JSON schema meta-schema.

Using Generated Types

Using generated constants and enums allows working with JSON schemas and RCSB extensions type-safely (e.g. writing type-aware parsers, that read and understand schema semantics). Type-safety means when the schema changes, the generated code will change as well. Removing or renaming the definitions will lead to compilation errors, which can be detected early.

To use generated types in your Java project you need to import org.rcsb.mojave.meta.MetaSchemaConstants and org.rcsb.mojave.meta.enums.*.

Versioning

Version numbers should follow Semantic Versioning Specification (SemVer). Release version takes the x.y.z form, where x is the major version, y is the minor version, and z is the patch version (e.g. 0.1.0).