{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "entity.json#",
  "type": "object",
  "title": "entity",
  "translation": {
    "ISO 19115-2": ["FC_FeatureCatalogue > featureType > FC_FeatureType"]
  },
  "example": "../examples/entity.json",
  "required": ["codeName", "definition"],
  "additionalProperties": true,
  "properties": {
    "entityId": {
      "type": "string",
      "description": "A user provided unique ID for this entity.  ",
      "translation": {
        "ISO 19115-2": ["FC_FeatureCatalogue > featureType > FC_FeatureType#id=''"]
      }
    },
    "commonName": {
      "type": "string",
      "description": "The name commonly used to identify this entity",
      "translation": {
        "ISO 19115-2": ["FC_FeatureCatalogue > featureType > FC_FeatureType > typeName > localName"]
      }
    },
    "codeName": {
      "type": "string",
      "description": "The code name used to identify this entity in a database schema or application software. For spreasheets this would likely be the sheet name. ",
      "translation": {
        "ISO 19115-2": ["FC_FeatureCatalogue > featureType > FC_FeatureType > code > CharacterString"]
      }
    },
    "alias": {
      "type": "array",
      "description": "An array of quoted strings providing alternate names used to identify this entity",
      "translation": {
        "ISO 19115-2": ["FC_FeatureCatalogue > featureType > FC_FeatureType > aliases > localName"]
      },
      "items": {
        "type": "string"
      }
    },
    "definition": {
      "type": "string",
      "description": "A brief definition for the entity",
      "translation": {
        "ISO 19115-2": ["FC_FeatureCatalogue > featureType > FC_FeatureType > definition"]
      }
    },
    "entityReference": {
      "type": "array",
      "description": "Reference to a standard or external schema which describes the entity.",
      "translation": {
        "FGDC CSDGM": ["eainfo > overview > eadetcit"],
        "ISO 19115-2": ["FC_FeatureCatalogue > featureType > FC_FeatureType"]
      },
      "items": {
        "$ref": "./citation.json#"
      }
    },
    "primaryKeyAttributeCodeName": {
      "type": "array",
      "description": "An array of quoted attribute code names that together compose the primary key set for the entity",
      "translation": {
        "ISO 19115-2": ["Note: the primary key is written as a text description into FC_FeatureCatalogue > featureType > FC_FeatureType > constrainedBy > FC_Constraint > description"]
      },
      "items": {
        "type": "string"
      }
    },
    "index": {
      "type": "array",
      "description": "An array of objects describing alternate indexes for the entity",
      "translation": {
        "ISO 19115-2": ["FC_FeatureCatalogue > Note: the index is written as a text description into featureType > FC_FeatureType > constrainedBy > FC_Constraint > description"]
      },
      "items": {
        "$ref": "#/definitions/index"
      }
    },
    "attribute": {
      "type": "array",
      "description": "An array of objects defining the attributes for the entity",
      "translation": {
        "ISO 19115-2": ["FC_FeatureCatalogue > featureType > FC_FeatureType > carrierOfCharacteristics > FC_FeatureAttribute"]
      },
      "items": {
        "$ref": "./entityAttribute.json#"
      }
    },
    "foreignKey": {
      "type": "array",
      "description": "An array of objects describing attributes whose values are restricted to values found in the domain of an attribute belonging to another table or dataset",
      "translation": {
        "ISO 19115-2": ["Note: the foreign key is written as a text description into FC_FeatureCatalogue > featureType > FC_FeatureType > constrainedBy > FC_Constraint"]
      },
      "items": {
        "$ref": "#/definitions/foreignKey"
      }
    },
    "fieldSeparatorCharacter":{
        "type" : "string",
        "description" : "The character which indicates the end of the data field contents.",
        "translation": {
          "FGDC CSDGM": ["distinfo > stdorder > digform > digtinfo > asciistr > dfwidthd"]
        },
        "minLength" : 1
    },
    "numberOfHeaderLines":{
        "type" : "integer",
        "description" : "The number of lines at the beginning of the file before the data content actually begins.",
        "translation": {
          "FGDC CSDGM": ["distinfo > stdorder > digform > digtinfo > asciistr > numheadl"]
        }
    },
    "quoteCharacter":{
        "type" : "string",
        "description" : "Character used to quote fields in the data representation so that the field delimiter can be used as part of the field value. This character is typically a single quote mark or double quote mark.",
        "translation": {
          "FGDC CSDGM": ["distinfo > stdorder > digform > digtinfo > asciistr > quotech"]
        },
        "minLength" : 1
    }
  },
  "definitions": {
    "index": {
      "type": "object",
      "example": "../examples/entityIndex.json",
      "required": ["codeName", "allowDuplicates", "attributeCodeName"],
      "additionalProperties": true,
      "properties": {
        "codeName": {
          "type": "string",
          "description": "The code name used to define the alternate index on the entity",
          "translation": {
            "ISO 19115-2": ["FC_FeatureCatalogue > featureType > FC_FeatureType > constrainedBy > FC_Constraint > description > CharacterString"]
          }
        },
        "allowDuplicates": {
          "type": "boolean",
          "description": "Indicates whether the index allows duplicates or values are required to be unique.  true = allow duplicates; false = values must be unique.",
          "translation": {
            "ISO 19115-2": ["FC_FeatureCatalogue > featureType > FC_FeatureType > constrainedBy > FC_Constraint > description > CharacterString"]
          },
          "default": false
        },
        "attributeCodeName": {
          "type": "array",
          "description": "An array of quoted attribute code names that together compose an alternate key set for the entity",
          "translation": {
            "ISO 19115-2": ["FC_FeatureCatalogue > featureType > FC_FeatureType > constrainedBy > FC_Constraint > description > CharacterString"]
          },
          "items": {
            "type": "string"
          }
        }
      }
    },
    "foreignKey": {
      "type": "object",
      "example": "../examples/entityForeignKey.json",
      "required": ["localAttributeCodeName", "referencedEntityCodeName", "referencedAttributeCodeName"],
      "additionalProperties": true,
      "properties": {
        "localAttributeCodeName": {
          "type": "array",
          "description": "An array of local (referencing or child) attribute code names for this foreign key",
          "translation": {
            "ISO 19115-2": ["FC_FeatureCatalogue > featureType > FC_FeatureType > constrainedBy > FC_Constraint > description > CharacterString"]
          },
          "items": {
            "type": "string"
          }
        },
        "referencedEntityCodeName": {
          "type": "string",
          "description": "The entityID for the referenced (or parent) entity for this foreign key",
          "translation": {
            "ISO 19115-2": ["FC_FeatureCatalogue > featureType > FC_FeatureType > constrainedBy > FC_Constraint > description > CharacterString"]
          }
        },
        "referencedAttributeCodeName": {
          "type": "array",
          "description": "An array of referenced (or parent) attribute code names for this foreign key.  If the foreign key is compound key (more than one attribute compose the key) the order of the referenced attributes must allign precicely with the order and number of local attributes.",
          "translation": {
            "ISO 19115-2": ["FC_FeatureCatalogue > featureType > FC_FeatureType > constrainedBy > FC_Constraint > description > CharacterString"]
          },
          "items": {
            "type": "string"
          }
        }
      }
    }
  }
}