Class Enumeration

An Enumeration represents an enumeration term, which is a special kind of Class. For SDO-Adapter, a Class is understood as Enumeration when it is a subclass of the schema.org Enumeration Class. Usually, Enumerations (e.g. schema:DayOfWeek) have predefined instances (e.g. schema:Monday) that are also part of the Vocabulary. Instead of creating new instances for this Class/Enumeration, it is usual to just link to a predefined instance (In SDO-Adapter these predefined instances are called Enumeration Members). But, since an Enumeration is also a Class, every enumeration can also be understood as a Class for which a new instance can be created, therefore the API also provides all Class methods for Enumerations. An Enumeration is created with SDOAdapter.getEnumeration() and offers the methods described below.

// following Enumeration instance is used in the code examples below
const dayEnum = mySdoAdapter.getEnumeration("schema:DayOfWeek");
// it is also possible to create an Enumeration instance with an absolute IRI or a label
const dayEnum2 = mySdoAdapter.getEnumeration("https://schema.org/DayOfWeek");
const dayEnum3 = mySdoAdapter.getEnumeration("DayOfWeek");

Hierarchy (View Summary)

Class
- Enumeration

Properties

`Protected` `Readonly`graph

graph: Graph

The underlying data graph to enable the methods of this Term

`Protected` `Readonly`IRI

IRI: string

The compact IRI of this Term

Methods

getDescription

getDescription(language?: string): null | string
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.
Parameters
- language: string = "en"
  the wished language for the description (default = "en")
Returns null | string
The description of this Term
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."
```
Inherited from Class.getDescription

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)

Returns null | Record<string, string>

The descriptions of this Term

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），俗称老虎、大虫，被人称为百獸之王，是現存体型最大的两种猫科动物之一（另一种是狮)"
}

getEnumerationMembers

getEnumerationMembers(paramObj?: ParamObjIRIListInference): string[]
Retrieves the Enumeration Members of this Enumeration
Parameters
- OptionalparamObj: 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 enumeration members inherited recursively from sub-enumerations
Returns string[]
The Enumeration Members of this Enumeration
Example
```
dayEnum.getEnumerationMembers();
// returns all Enumeration Members of the Enumeration "schema:DayOfWeek"
[
   "schema:Monday",
   "schema:Thursday",
   "schema:Sunday",
   ...
]
```

getIRI

getIRI(outputIRIType?: OutputIRIType): string
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
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
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"
```
Inherited from Class.getIRI

getName

getName(language?: string): null | string
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.
Parameters
- language: string = "en"
  the wished language for the name (default = "en")
Returns null | string
The name of this Term
Example
```
const hotelClass = mySdoAdapter.getClass("schema:Hotel");
hotelClass.getName();
// returns the (english) name of the class schema:Hotel
"Hotel"
```
Inherited from Class.getName

getNames

getNames(): null | Record<string, string>
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).

Returns null | Record<string, string>
The names (with language tag) of this Term
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": "虎"
}
```
Inherited from Class.getNames

getProperties

getProperties(paramObj?: ParamObjIRIListInference): string[]

Retrieves the properties of this Class

Parameters

OptionalparamObj: 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 inherited from superclasses

Returns string[]

The properties of this Class

Example

personClass.getProperties();
// returns all properties of the class "schema:Person" (including inherited properties from its superclasses)
[
   "schema:name",
   "schema:description",
   "schema:knows",
   "schema:worksFor",
   ...
]

personClass.getProperties({ implicit: false });
// returns only the explicit properties of the class "schema:Person"
[
   "schema:address",
   "schema:weight",
   "schema:worksFor",
   ...
]

getSource

getSource(): null | string | string[]
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.

Returns null | string | string[]
The source IRI given by dcterms:source or schema:source of this Term
Example
```
const phoneticText = mySdoAdapter.getProperty("schema:phoneticText");
phoneticText.getVocabulary();
// returns source of the phoneticText property
"https://github.com/schemaorg/schemaorg/issues/2108"
```
Inherited from Class.getSource

getSubClasses

getSubClasses(paramObj?: ParamObjIRIListInference): string[]
Retrieves the subclasses of this Class
Parameters
- OptionalparamObj: 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 subclasses inherited recursively from subclasses
Returns string[]
The subclasses of this Class
Example
```
personClass.getSubClasses();
// returns all subclasses of the class "schema:Person"
[
   "schema:Patient"
]
```
Inherited from Class.getSubClasses

getSuperClasses

getSuperClasses(paramObj?: ParamObjIRIListInference): string[]
Retrieves the superclasses of this Class
Parameters
- OptionalparamObj: 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 superclasses inherited recursively from superclasses
Returns string[]
The superclasses of this Class
Example
```
personClass.getSuperClasses();
// returns all superclasses of the class "schema:Person" (including inherited superclasses from its superclasses)
[
   "schema:Thing"
]
```
Inherited from Class.getSuperClasses

getTermTypeIRI

getTermTypeIRI(): TermTypeIRIValue
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"

Returns TermTypeIRIValue
The term-type-IRI of this Term
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"
```
Inherited from Class.getTermTypeIRI

getTermTypeLabel

getTermTypeLabel(): TermTypeLabelValue
Retrieves the label (string) for the type of this Term:

Class -> "Class"
Property -> "Property"
Enumeration -> "Enumeration"
EnumerationMember -> "EnumerationMember"
DataType -> "DataType"

Returns TermTypeLabelValue
The term-type-label of this Term
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"
```
Inherited from Class.getTermTypeLabel

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.

Returns string

The vocabulary URL of this term (extension or namespace)

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"

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.

Returns null | string[]

The original vocabulary source urls of this Term

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"]

isRangeOf

isRangeOf(paramObj?: ParamObjIRIListInference): string[]
Retrieves the properties that have this Class as a range
Parameters
- OptionalparamObj: 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 superclass of this class is a range)
Returns string[]
The properties that have this Class as a range
Example
```
personClass.isRangeOf();
// returns all properties for which the class "schema:Person" is a valid range
[
   "schema:legislationPassedBy",
   "schema:sender",
   "schema:character",
   "schema:actors",
   ...
]
```
Inherited from Class.isRangeOf

isSupersededBy

isSupersededBy(outputIRIType?: OutputIRIType): null | string
Returns the IRI of the Term superseding this Term (defined with schema:supersededBy), if any. By default, the IRI is returned in compact form
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
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"
```
Inherited from Class.isSupersededBy

isValidDomainEnumerationOf

isValidDomainEnumerationOf(
enumerationMemberId: string,
implicit?: boolean,
): boolean
Returns true, if the given Enumeration Member is a valid instance of this Enumeration. The implicit parameter (default: true) allows to cover recursive relationships (e.g. the Enumeration Members of sub-enumerations are also taken into account)
Parameters
- enumerationMemberId: string
  The identification string of the Enumeration Member in question, can be an IRI (absolute or compact) or a label
- implicit: boolean = true
  If true, includes also Enumeration Members of sub-enumerations
Returns boolean
if the given Enumeration Member is a valid instance of this Enumeration
Example
```
statusEnumeration.isValidDomainEnumerationOf("schema:EventPostponed"); // true
statusEnumeration.isValidDomainEnumerationOf("schema:EventPostponed", true); // true
statusEnumeration.isValidDomainEnumerationOf("schema:EventPostponed", false); // false, (is a member of a sub-enumeration)
eventStatusTypeEnumeration.isValidDomainEnumerationOf("schema:EventPostponed", false); // true
```

isValidDomainOf

isValidDomainOf(propertyId: string, implicit?: boolean): boolean
Returns true, if the given property can use this class as a valid domain. The implicit parameter (default: true) allows to include properties inherited from superclasses
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, include properties inherited from superclasses
Returns boolean
if this class is a valid domain for the given property
Example
```
mediaObjectClass.isValidDomainOf("schema:dateline"); // true
mediaObjectClass.isValidDomainOf("schema:name"); // true
mediaObjectClass.isValidDomainOf("schema:name", true); // true
mediaObjectClass.isValidDomainOf("schema:name", false); // false, since only direct domains are considered
```
Inherited from Class.isValidDomainOf

isValidRangeOf

isValidRangeOf(propertyId: string, implicit?: boolean): boolean
Returns true, if the given property can use this class as a valid range. The implicit parameter (default: true) allows to cover recursive relationships (e.g. subclasses of valid ranges are also taken into account)
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, includes also subclasses of ranges
Returns boolean
if this class is a valid range for the given property
Example
```
mediaObjectClass.isValidRangeOf("schema:caption"); // true
mediaObjectClass.isValidRangeOf("schema:license"); // true
mediaObjectClass.isValidRangeOf("schema:license", true); // true
mediaObjectClass.isValidRangeOf("schema:license", false); // false, since only direct ranges are considered
```
Inherited from Class.isValidRangeOf

isValidSubClassOf

isValidSubClassOf(superClassId: string, implicit?: boolean): boolean
Returns true, if the given class is a valid superclass of this class. The implicit parameter (default: true) allows to cover recursive relationships (e.g. the superclass of a superclass is also taken into account)
Parameters
- superClassId: string
  The identification string of the superclass in question, can be an IRI (absolute or compact) or a label
- implicit: boolean = true
  If true, includes also superclasses of superclasses
Returns boolean
if the other class is a valid superclass of this class
Example
```
hotelClass.isValidSubClassOf("schema:LodgingBusiness"); // true
hotelClass.isValidSubClassOf("schema:Thing"); // true
hotelClass.isValidSubClassOf("schema:Thing", true); // true
hotelClass.isValidSubClassOf("schema:Thing", false); // false, since only direct superclasses are considered
```
Inherited from Class.isValidSubClassOf

isValidSuperClassOf

isValidSuperClassOf(subClassId: string, implicit?: boolean): boolean
Returns true, if the given class is a valid subclass of this class. The implicit parameter (default: true) allows to cover recursive relationships (e.g. the subclass of a subclass is also taken into account)
Parameters
- subClassId: string
  The identification string of the subclass in question, can be an IRI (absolute or compact) or a label
- implicit: boolean = true
  If true, includes also subclasses of subclasses
Returns boolean
if the other class is a valid subclass of this class
Example
```
thingClass.isValidSuperClassOf("schema:Place"); // true
thingClass.isValidSuperClassOf("schema:Hotel"); // true
thingClass.isValidSuperClassOf("schema:Hotel", true); // true
thingClass.isValidSuperClassOf("schema:Hotel", false); // false, since only direct subclasses are considered
```
Inherited from Class.isValidSuperClassOf

toJSON

toJSON(paramObj?: ParamObjIRIListInference): ToJsonEnumeration

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

Parameters

OptionalparamObj: 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. enumeration members, properties, etc.)

Returns ToJsonEnumeration

The JSON representation of this Enumeration as JavaScript Object

Example

dayEnum.toJSON();
// returns a JSON representing the Enumeration "schema:DayOfWeek"
{
 id: 'schema:DayOfWeek',
 IRI: 'https://schema.org/DayOfWeek',
 typeLabel: 'Enumeration',
 typeIRI: 'schema:Enumeration',
 vocabURLs: ["https://raw.githubusercontent.com/semantifyit/schemaorg/main/data/releases/12.0/schemaorg-all-https.jsonld"],
 vocabulary: 'https://schema.org',
 source: 'http://www.w3.org/wiki/WebSchemas/SchemaDotOrgSources#source_GoodRelationsClass',
 supersededBy: null,
 name: 'DayOfWeek',
 description: 'The day of the week, e.g. used to specify to which day the opening hours of an OpeningHoursSpecification refer.\n\nOriginally, URLs from [GoodRelations](http://purl.org/goodrelations/v1) were used (for [[Monday]], [[Tuesday]], [[Wednesday]], [[Thursday]], [[Friday]], [[Saturday]], [[Sunday]] plus a special entry for [[PublicHolidays]]); these have now been integrated directly into schema.org.\n',
 superClasses: [ 'schema:Enumeration', 'schema:Intangible', 'schema:Thing' ],
 subClasses: [],
 properties: [
   'schema:supersededBy',
   'schema:sameAs',
   'schema:description',
   ...
 ],
 rangeOf: [
   'schema:dayOfWeek',
   'schema:byDay',
   'schema:supersededBy',
   ...
 ],
 enumerationMembers: [
   'schema:PublicHolidays',
   'schema:Sunday',
   'schema:Monday',
   'schema:Thursday',
   ...
 ]
}

toString

toString(paramObj?: ParamObjIRIListInference): string
Generates a JSON representation of this Enumeration (as string)

Check .toJSON() for an example output
Parameters
- OptionalparamObj: 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. enumeration members, properties, etc.)
Returns string
The JSON representation of this Enumeration as string
Example
```
dayEnum.toString();
```
Overrides Class.toString

Class Enumeration

Hierarchy (View Summary)

Index

Properties

Methods

Properties

Protected Readonlygraph

Protected ReadonlyIRI

Methods

getDescription

Parameters

Returns null | string

Example

getDescriptions

Returns null | Record<string, string>

Example

getEnumerationMembers

Parameters

Returns string[]

Example

getIRI

Parameters

Returns string

Example

getName

Parameters

Returns null | string

Example

getNames

Returns null | Record<string, string>

Example

getProperties

Parameters

Returns string[]

Example

getSource

Returns null | string | string[]

Example

getSubClasses

Parameters

Returns string[]

Example

getSuperClasses

Parameters

Returns string[]

Example

getTermTypeIRI

Returns TermTypeIRIValue

Example

getTermTypeLabel

Returns TermTypeLabelValue

Example

getVocabulary

Returns string

Example

getVocabURLs

Returns null | string[]

Example

isRangeOf

Parameters

Returns string[]

Example

isSupersededBy

Parameters

Returns null | string

Example

isValidDomainEnumerationOf

Parameters

Returns boolean

Example

isValidDomainOf

Parameters

Returns boolean

Example

isValidRangeOf

Parameters

Returns boolean

Example

isValidSubClassOf

Parameters

`Protected` `Readonly`graph

`Protected` `Readonly`IRI