DataType | Schema.org Adapter

A DataType represents a data-type term. These are a special kind of classes that represents literal values in schema.org. A DataType is identified by its IRI (e.g. schema:Number), where, by convention, the class name itself starts with an uppercase letter. A DataType instance is created with SDOAdapter.getDataType() and offers the methods described below.

// following DataType instance is used in the code examples below
const textDt = mySdoAdapter.getDataType("schema:Text");
// it is also possible to create a DataType instance with an absolute IRI or a label
const textDt2 = mySdoAdapter.getDataType("https://schema.org/Text");
const textDt3 = mySdoAdapter.getDataType("Text");

Hierarchy

Term
- DataType

Properties

Protected Readonly IRI

IRI: string

Protected Readonly graph

graph: Graph

Methods

getDescription

getDescription(language?: string): null | string

Inherited from Term.getDescription
Returns the description (rdfs:comment) of this Term. It is possible to pass a language tag as parameter to get the description in that language, as long as the vocabulary provides that language. The english ("en") language is understood as default.
example
```
const cwClass = mySdoAdapter.getClass("schema:CreativeWork");
cwClass.getDescription();
// returns the (english) description of the class schema:CreativeWork
"The most generic kind of creative work, including books, movies, photographs, software programs, etc."
```
Parameters
- language: string = "en"
  
  the wished language for the description (default = "en")
Returns null | string
The description of this Term

getDescriptions

getDescriptions(): null | Record<string, string>

Returns all descriptions (rdfs:comment) of this Term as an Object. Each description (value) has a language tag (key) associated with it. Language tags are unique for each term (e.g. there is at most one description for any given language)

example

const tigerClass = mySdoAdapter.getClass("ex:Tiger");
tigerClass.getDescriptions();
// returns the descriptions of this class in all available languages:
{
  "en": "The tiger (Panthera tigris) is the largest species among the Felidae and classified in the genus Panthera.",
  "zh": "虎（学名：Panthera tigris），俗称老虎、大虫，被人称为百獸之王，是現存体型最大的两种猫科动物之一（另一种是狮)"
}

Returns null | Record<string, string>

The descriptions of this Term

getIRI

getIRI(outputIRIType?: OutputIRIType): string

Inherited from Term.getIRI
Retrieves the IRI of this Term in compact (e.g. schema:Friday) or in absolute form (e.g. https://schema.org/Friday). By default, the absolute form is returned
example
```
personClass.getIRI();
// returns the absolute IRI of the "schema:Person" Class
"https://schema.org/Person"

nameProperty.getIRI("Compact");
// returns the compact IRI of the "schema:name" Property
"schema:name"
```
Parameters
- outputIRIType: OutputIRIType = "Absolute"
  
  states the format of the returned IRI, either "Compact" for the compact form, e.g. schema:Friday, or "Absolute" for the absolute form, e.g. https://schema.org/Friday
Returns string
The IRI of this Term

getName

getName(language?: string): null | string

Inherited from Term.getName
Returns the name (rdfs:label) of this Term. It is possible to pass a language tag as parameter to get the name in that language, as long as the vocabulary provides that language. The english ("en") language is understood as default.
example
```
const hotelClass = mySdoAdapter.getClass("schema:Hotel");
hotelClass.getName();
// returns the (english) name of the class schema:Hotel
"Hotel"
```
Parameters
- language: string = "en"
  
  the wished language for the name (default = "en")
Returns null | string
The name of this Term

getNames

getNames(): null | Record<string, string>

Inherited from Term.getNames
Returns all names (rdfs:label) of this Term as an Object. Each name (value) has a language tag (key) associated with it. Language tags are unique for each term (e.g. there is at most one name for any given language).
example
```
const tigerClass = mySdoAdapter.getClass("ex:Tiger");
tigerClass.getNames();
// returns the name of this class in all available languages:
{
  "en": "Tiger",
  "de": "Tiger",
  "es": "Tigre",
  "zh": "虎"
}
```
Returns null | Record<string, string>
The names (with language tag) of this Term

getSource

getSource(): null | string | string[]

Inherited from Term.getSource
This method was introduced mainly to return of source(s) for a term, as defined in the vocabulary itself with dcterms:source or schema:source. The later has been used to link to related github issues for the schema.org vocabulary.
example
```
const phoneticText = mySdoAdapter.getProperty("schema:phoneticText");
phoneticText.getVocabulary();
// returns source of the phoneticText property
"https://github.com/schemaorg/schemaorg/issues/2108"
```
Returns null | string | string[]
The source IRI given by dcterms:source or schema:source of this Term

getSubDataTypes

getSubDataTypes(paramObj?: ParamObjIRIListInference): string[]

Retrieves the sub-DataTypes of this DataType
example
```
const numberDt = mySdoAdapter.getDataType("schema:Number");
numberDt.getSubDataTypes();
// returns all sub-DataTypes of the DataType "schema:Number"
[
   'schema:Integer',
   'schema:Float'
]
```
Parameters
- Optional paramObj: ParamObjIRIListInference
  
  an optional parameter object that filters and formats the result, and defines the inference behaviour: The "implicit"-parameter defaults to true and returns also implicit sub-DataTypes inherited recursively from sub-DataTypes
Returns string[]
The sub-DataTypes of this DataType

getSuperDataTypes

getSuperDataTypes(paramObj?: ParamObjIRIListInference): string[]

Retrieves the super-DataTypes of this DataType
example
```
const floatDt = mySdoAdapter.getDataType("schema:Float");
floatDt.getSuperDataTypes();
// returns all super-DataTypes of the DataType "schema:Float"
[
   "schema:Number"
]
```
Parameters
- Optional paramObj: ParamObjIRIListInference
  
  an optional parameter object that filters and formats the result, and defines the inference behaviour: The "implicit"-parameter defaults to true and returns also implicit super-DataTypes inherited recursively from super-DataTypes
Returns string[]
The super-DataTypes of this DataType

getTermTypeIRI

getTermTypeIRI(): TermTypeIRIValue

Inherited from Term.getTermTypeIRI
Retrieves the compact IRI for the type of this Term:

Class -> "rdfs:Class"
Property -> "rdf:Property"
Enumeration -> "schema:Enumeration"
EnumerationMember -> "soa:EnumerationMember"
DataType -> "schema:DataType"
example
```
personClass.getTermTypeIRI();
// returns the term type IRI of the "schema:Person" Class in compact form
"rdfs:Class"

nameProperty.getTermTypeIRI();
// returns the term type IRI of the "schema:name" Property in compact form
"rdf:Property"
```
Returns TermTypeIRIValue
The term-type-IRI of this Term

getTermTypeLabel

getTermTypeLabel(): TermTypeLabelValue

Inherited from Term.getTermTypeLabel
Retrieves the label (string) for the type of this Term:

Class -> "Class"
Property -> "Property"
Enumeration -> "Enumeration"
EnumerationMember -> "EnumerationMember"
DataType -> "DataType"
example
```
personClass.getTermTypeLabel();
// returns the term type label of the "schema:Person" Class
"Class"

nameProperty.getTermTypeLabel();
// returns the term type label of the "schema:name" Property
"Property"
```
Returns TermTypeLabelValue
The term-type-label of this Term

getVocabURLs

getVocabURLs(): null | string[]

Returns the URL of all vocabularies in which this term has been defined. Works only if the corresponding vocabulary was added through a URL, and not as a JSON-LD object.

example

// the parameter `schemaVersion: "12.0"` tells the SDO-Adapter instance to initialize with the schema.org vocabulary version 12.0
const mySdoAdapter = await SOA.create({schemaVersion: "12.0"});

const personClass = mySdoAdapter.getClass("schema:Person");
personClass.getVocabURLs();
// returns the source vocabulary url for this class - notice that this url points to version 12.0 of schema.org
["https://raw.githubusercontent.com/semantifyit/schemaorg/main/data/releases/12.0/schemaorg-all-https.jsonld"]

Returns null | string[]

The original vocabulary source urls of this Term

getVocabulary

getVocabulary(): string

This method was introduced mainly to return the vocabulary extension URL of schema.org to which the term belongs. The extension URL is defined in the vocabulary through the schema:isPartOf property. If no such property is given, then the namespace URL for this term is returned.

example

const personClass = mySdoAdapter.getClass("schema:Person");
personClass.getVocabulary();
// returns the vocabulary url for the person class, which is the core vocabulary of schema.org
"https://schema.org"

const patientClass = mySdoAdapter.getClass("schema:Patient");
patientClass.getVocabulary();
// returns the vocabulary url for the patient class, which is the health extension of schema.org
"https://health-lifesci.schema.org"

Returns string

The vocabulary URL of this term (extension or namespace)

isRangeOf

isRangeOf(paramObj?: ParamObjIRIListInference): string[]

Retrieves the properties that have this DataType as a range
example
```
textDt.isRangeOf();
// returns all properties for which the datatype "schema:Text" is a valid range
[
   "schema:cookingMethod",
   "schema:broadcastFrequency",
   "schema:mechanismOfAction",
   ...
]
```
Parameters
- Optional paramObj: ParamObjIRIListInference
  
  an optional parameter object that filters and formats the result, and defines the inference behaviour: The "implicit"-parameter defaults to true and returns also implicit properties (where a super-datatype of this class is a range)
Returns string[]
The properties that have this DataType as a range

isSupersededBy

isSupersededBy(outputIRIType?: OutputIRIType): null | string

Inherited from Term.isSupersededBy
Returns the IRI of the Term superseding this Term (defined with schema:supersededBy), if any. By default, the IRI is returned in compact form
example
```
const requirementsProperty = mySdoAdapter.getProperty("schema:requirements");
requirementsProperty.isSupersededBy();
// returns IRI for the term that supersedes the property schema:requirements in compact form
"schema:softwareRequirements"

requirementsProperty.isSupersededBy("Absolute");
// returns IRI for the term that supersedes the property schema:requirements in absolute form
"https://schema.org/softwareRequirements"
```
Parameters
- outputIRIType: OutputIRIType = "Compact"
  
  states the format of the returned IRI, either "Compact" for the compact form, e.g. schema:softwareRequirements, or "Absolute" for the absolute form, e.g. https://schema.org/softwareRequirements
Returns null | string
The Term superseding this Term, if any

isValidRangeOf

isValidRangeOf(propertyId: string, implicit?: boolean): boolean

Returns true, if this DataType is a valid range of the given Property. The implicit parameter (default: true) allows to cover recursive relationships (e.g. domain properties of super-datatypes are also taken into account)
example
```
text.isValidRangeOf("schema:name"); // true
url.isValidRangeOf("schema:name", true); // true
url.isValidRangeOf("schema:name", false); // false, is range of a super-datatype
```
Parameters
- propertyId: string
  
  The identification string of the Property in question, can be an IRI (absolute or compact) or a label
- implicit: boolean = true
  
  If true, consider also implicit domain properties (where a super-datatype of this class is a range)
Returns boolean
if this DataType is a valid range of the given Property

isValidSubDataTypeOf

isValidSubDataTypeOf(superDataTypeId: string, implicit?: boolean): boolean

Returns true, if this DataType is a valid sub-datatype of the given super-datatype. The implicit parameter (default: true) allows to cover recursive relationships (e.g. super-datatypes of super-datatypes are also taken into account)
example
```
url.isValidSubDataTypeOf("schema:Text"); // true
float.isValidSubDataTypeOf("schema:Number", true); // true
float.isValidSubDataTypeOf("schema:Number", false); // true
```
Parameters
- superDataTypeId: string
  
  The identification string of the super-datatype in question, can be an IRI (absolute or compact) or a label
- implicit: boolean = true
  
  If true, consider also recursive super-datatypes
Returns boolean
if this DataType is a valid sub-datatype of the given super-datatype

isValidSuperDataTypeOf

isValidSuperDataTypeOf(subDataTypeId: string, implicit?: boolean): boolean

Returns true, if this DataType is a valid super-datatype of the given sub-datatype. The implicit parameter (default: true) allows to cover recursive relationships (e.g. sub-datatypes of sub-datatypes are also taken into account)
example
```
text.isValidSuperDataTypeOf("schema:URL"); // true
number.isValidSuperDataTypeOf("schema:Float", true); // true
number.isValidSuperDataTypeOf("schema:Float", false); // true
```
Parameters
- subDataTypeId: string
  
  The identification string of the sub-datatype in question, can be an IRI (absolute or compact) or a label
- implicit: boolean = true
  
  If true, consider also recursive sub-datatypes
Returns boolean
if this DataType is a valid super-datatype of the given sub-datatype

toJSON

toJSON(paramObj?: ParamObjIRIListInference): ToJsonDataType

Generates a JSON representation of this DataType (as JavaScript Object)

example

textDt.toJSON();
// returns a JSON representing the data-type "schema:Text"
{
  id: 'schema:Text',
  IRI: 'https://schema.org/Text',
  typeLabel: 'DataType',
  typeIRI: 'schema:DataType',
  vocabURLs: [
    'https://raw.githubusercontent.com/semantifyit/schemaorg/main/data/releases/12.0/schemaorg-all-https.jsonld'
  ],
  vocabulary: 'https://schema.org',
  source: null,
  supersededBy: null,
  name: 'Text',
  description: 'Data type: Text.',
  superDataTypes: [],
  subDataTypes: [
    'schema:PronounceableText',
    'schema:URL',
    'schema:CssSelectorType',
    'schema:XPathType'
  ],
    rangeOf: [
    'schema:cookingMethod',
    'schema:broadcastFrequency',
    'schema:mechanismOfAction',
    ...
  ]
}

Parameters

Optional paramObj: ParamObjIRIListInference

an optional parameter object that filters and formats the result, and defines the inference behaviour: The "implicit"-parameter defaults to true and returns also implicit data (e.g. sub-DataTypes, super-DataTypes, etc.)

Returns ToJsonDataType

The JSON representation of this DataType as JavaScript Object

toString

toString(paramObj?: ParamObjIRIListInference): string

Overrides Term.toString
Generates a JSON representation of this DataType (as string)

Check .toJSON() for an example output
example
```
textDt.toString();
```
Parameters
- Optional paramObj: ParamObjIRIListInference
  
  an optional parameter object that filters and formats the result, and defines the inference behaviour: The "implicit"-parameter defaults to true and returns also implicit data (e.g. sub-DataTypes, super-DataTypes, etc.)
Returns string
The JSON representation of this DataType as string

Hierarchy

Index

Properties

Methods

Properties

Protected Readonly IRI

Protected Readonly graph

Methods

getDescription

Parameters

language: string = "en"

Returns null | string

getDescriptions

Returns null | Record<string, string>

getIRI

Parameters

outputIRIType: OutputIRIType = "Absolute"

Returns string

getName

Parameters

language: string = "en"

Returns null | string

getNames

Returns null | Record<string, string>

getSource

Returns null | string | string[]

getSubDataTypes

Parameters

Optional paramObj: ParamObjIRIListInference

Returns string[]

getSuperDataTypes

Parameters

Optional paramObj: ParamObjIRIListInference

Returns string[]

getTermTypeIRI

Returns TermTypeIRIValue

getTermTypeLabel

Returns TermTypeLabelValue

getVocabURLs

Returns null | string[]

getVocabulary

Returns string

isRangeOf

Parameters

Optional paramObj: ParamObjIRIListInference

Returns string[]

isSupersededBy

Parameters

outputIRIType: OutputIRIType = "Compact"

Returns null | string

isValidRangeOf

Parameters

propertyId: string

implicit: boolean = true

Returns boolean

isValidSubDataTypeOf

Parameters

superDataTypeId: string

implicit: boolean = true

Returns boolean

isValidSuperDataTypeOf

Parameters

subDataTypeId: string

implicit: boolean = true

Returns boolean

toJSON

Parameters

Optional paramObj: ParamObjIRIListInference

Returns ToJsonDataType

toString

Parameters

Optional paramObj: ParamObjIRIListInference

Returns string