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.
the wished language for the description (default = "en"
)
The description of this Term
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)
The descriptions of this Term
Retrieves the Enumeration Members of this Enumeration
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
The Enumeration Members of this Enumeration
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
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
The IRI of this Term
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.
the wished language for the name (default = "en"
)
The name of this Term
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).
The names (with language tag) of this Term
Retrieves the properties of this Class
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
The properties of this Class
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.
The source IRI given by dcterms:source
or schema:source
of this Term
Retrieves the subclasses of this Class
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
The subclasses of this Class
Retrieves the superclasses of this Class
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
The superclasses of this Class
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"
The term-type-IRI of this Term
Retrieves the label (string) for the type of this Term:
Class ->
"Class"
Property ->"Property"
Enumeration ->"Enumeration"
EnumerationMember ->"EnumerationMember"
DataType ->"DataType"
The term-type-label of this Term
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.
The original vocabulary source urls of this Term
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.
The vocabulary URL of this term (extension or namespace)
Retrieves the properties that have this Class as a range
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)
The properties that have this Class as a range
Returns the IRI of the Term superseding this Term (defined with schema:supersededBy
), if any. By default, the IRI is returned in compact form
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
The Term superseding this Term, if any
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)
The identification string of the Enumeration Member in question, can be an IRI (absolute or compact) or a label
If true, includes also Enumeration Members of sub-enumerations
if the given Enumeration Member is a valid instance of this Enumeration
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
The identification string of the property in question, can be an IRI (absolute or compact) or a label
If true, include properties inherited from superclasses
if this class is a valid domain for the given property
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)
The identification string of the property in question, can be an IRI (absolute or compact) or a label
If true, includes also subclasses of ranges
if this class is a valid range for the given property
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)
The identification string of the superclass in question, can be an IRI (absolute or compact) or a label
If true, includes also superclasses of superclasses
if the other class is a valid superclass of this class
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)
The identification string of the subclass in question, can be an IRI (absolute or compact) or a label
If true, includes also subclasses of subclasses
if the other class is a valid subclass of this class
Generates a JSON representation of this Enumeration (as JavaScript Object)
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.)
The JSON representation of this Enumeration as JavaScript Object
Generates a JSON representation of this Enumeration (as string)
Check .toJSON() for an example output
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.)
The JSON representation of this Enumeration as string
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.