MetadataSchema

MetadataSchema是CesiumJS中一种元数据方案的定义方式，用于描述如何使用元数据结构来组织数据并以一致的方式共享数据。

class MetadataSchema {
  constructor(options);
  clone(): MetadataSchema;
  equals(other: MetadataSchema): boolean;
  getProperty(name: string): MetadataProperty;
  getPropertiesBySemantic(semantic: string): MetadataProperty[];
  getSemantics(): string[];
  getAllProperties(): MetadataProperty[];
  toJson(): object;
  static fromJson(json: object): MetadataSchema;
}

构造函数

new MetadataSchema(options)

参数

• options：一个包含以下属性的对象。

  • id（可选）：一个字符串，该方案的唯一标识符，如果未指定，则 自动生成。

  • dataClass（必需）：一个字符串，数据类别的名称。例如，"aircraft"或"imagery"。

  • properties（可选）：元数据属性对象的数组。

示例

const aircraftSchema = new MetadataSchema({
  dataClass: 'aircraft',
  properties: [
    {
      name: 'F22',
      type: 'string',
      description: 'The F-22 Raptor is a single-seat, twin-engine, all-weather stealth tactical fighter aircraft.',
      examples: ['F22 Raptor', 'F-22', 'F22'],
      semantic: 'aircraft.name'
    },
    {
      name: 'Crew',
      type: 'number',
      description: 'The number of crew members on board the aircraft.',
      examples: [1, 2],
      semantic: 'aircraft.crew'
    }
  ]
});

方法

clone

clone(): MetadataSchema

返回一个新的MetadataSchema对象，其中包含与当前对象相同的属性。

equals

equals(other: MetadataSchema): boolean

比较两个MetadataSchema对象是否相等。相等表示：

• 它们具有相同的id
• 它们具有相同的dataClass
• 它们具有相同数量和类型的属性
• 每个属性都匹配另一个方案中具有相同名称、类型、描述、示例和语义的属性。

getProperty

getProperty(name: string): MetadataProperty

返回具有给定名称的属性对象。如果未找到，则返回undefined。

getPropertiesBySemantic

getPropertiesBySemantic(semantic: string): MetadataProperty[]

返回具有给定语义的属性对象数组。如果未找到，则返回一个空数组。

getSemantics

getSemantics(): string[]

返回包含此方案中所有属性的唯一语义的字符串数组。

getAllProperties

getAllProperties(): MetadataProperty[]

返回此方案的所有属性数组。

toJson

toJson(): object

将MetadataSchema对象序列化为JSON对象。

fromJSON

static fromJson(json: object): MetadataSchema

将JSON对象反序列化为MetadataSchema对象。

示例

const aircraftSchema = new MetadataSchema({
  dataClass: 'aircraft',
  properties: [
    {
      name: 'F22',
      type: 'string',
      description: 'The F-22 Raptor is a single-seat, twin-engine, all-weather stealth tactical fighter aircraft.',
      examples: ['F22 Raptor', 'F-22', 'F22'],
      semantic: 'aircraft.name'
    },
    {
      name: 'Crew',
      type: 'number',
      description: 'The number of crew members on board the aircraft.',
      examples: [1, 2],
      semantic: 'aircraft.crew'
    }
  ]
});

console.log(aircraftSchema.getPropertiesBySemantic('aircraft.crew')); // [{ name: 'Crew', type: 'number', ... }]
console.log(aircraftSchema.getProperty('F22')); // { name: 'F22', type: 'string', ... }
console.log(aircraftSchema.equals(aircraftSchema.clone())); // true