cdmfoundation.meanings.formats.cdm.json Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of objectmodel Show documentation
CDM SDK to work with semantic metadata of the Data
There is a newer version: 100.0.7
{
  "$schema": "../schema.cdm.json",
  "jsonSchemaSemanticVersion": "1.5.0",
  "imports": [
    {
      "corpusPath": "primitives.cdm.json"
    }
  ],
  "definitions": [
    {
      "traitName": "means.formatting",
      "extendsTrait": "means"
    },
    {
      "traitName": "means.formatting.color",
      "extendsTrait": "means.formatting"
    },
    {
      "traitName": "means.formatting.font",
      "extendsTrait": "means.formatting"
    },
    {
      "traitName": "means.formatting.font.size",
      "extendsTrait": "means.formatting.font"
    },
    {
      "traitName": "means.formatting.font.effects",
      "extendsTrait": "means.formatting.font"
    },
    {
      "traitName": "means.formatting.heading",
      "extendsTrait": "means.formatting"
    },
    {
      "traitName": "means.formatting.order",
      "extendsTrait": "means.formatting"
    },
    {
      "traitName": "means.formatting.stringFormat",
      "extendsTrait": "means.formatting",
      "explanation": "indicates this value represents the format of a string"
    },
    {
      "dataTypeName": "stringFormat",
      "extendsDataType": "string",
      "explanation": "a string representing the format used to encode data in another string",
      "exhibitsTraits": [
        "means.formatting.stringFormat"
      ]
    },
    {
      "dataTypeName": "displayOrder",
      "extendsDataType": "integer",
      "exhibitsTraits": [
        "means.formatting.order"
      ]
    },
    {
      "dataTypeName": "json",
      "extendsDataType": "string",
      "explanation": "a JSON fragment contained within one string value",
      "exhibitsTraits": [
        "means.content.text.JSON"
      ]
    },
    {
      "dataTypeName": "xml",
      "extendsDataType": "string",
      "explanation": "an XML fragment contained within one string value",
      "exhibitsTraits": [
        "means.content.text.XML"
      ]
    },
    {
      "dataTypeName": "image",
      "extendsDataType": "binary",
      "exhibitsTraits": [
        "means.content.binary.image"
      ]
    },
    {
      "dataTypeName": "fileId",
      "extendsDataType": "entityId",
      "explanation": "a unique identifier for file instances"
    },
    {
      "traitName": "is.formatted",
      "explanation": "a root for traits that describe how data is formatted",
      "defaultVerb": "is"
    },
    {
      "traitName": "is.formatted.forCulture",
      "extendsTrait": "is.formatted",
      "explanation": "values are stored using the specified culture",
      "hasParameters": [
        {
          "name": "culture",
          "dataType": "cultureTag",
          "required": true,
          "explanation": "a IETF BCP 47 language tag"
        }
      ]
    },
    {
      "traitName": "is.formatted.text",
      "extendsTrait": "is.formatted",
      "explanation": "string data is formatted according to the format parameter",
      "hasParameters": [
        {
          "name": "format",
          "dataType": "stringFormat",
          "required": true,
          "explanation": "String indicating the format of the data"
        },
        {
          "name": "description",
          "dataType": "string",
          "required": false
        }
      ]
    },
    {
      "traitName": "is.formatted.dateTime",
      "extendsTrait": "is.formatted",
      "explanation": "dateTime data formatted as a string in ISO 8601 format",
      "hasParameters": [
        {
          "name": "format",
          "dataType": "stringFormat",
          "defaultValue": "YYYY-MM-DDThh:mmZ"
        }
      ]
    },
    {
      "traitName": "is.formatted.date",
      "extendsTrait": "is.formatted",
      "explanation": "date data formatted as a string in ISO 8601 format",
      "hasParameters": [
        {
          "name": "format",
          "dataType": "stringFormat",
          "defaultValue": "YYYY-MM-DD"
        }
      ]
    },
    {
      "traitName": "is.formatted.time",
      "extendsTrait": "is.formatted",
      "explanation": "time data formatted as a string in ISO 8601 format",
      "hasParameters": [
        {
          "name": "format",
          "dataType": "stringFormat",
          "defaultValue": "hh:mm:ss"
        }
      ]
    }
  ]
}