Class RDFSerializer

Hierarchy

DataSerializer
- RDFSerializer

Constructors

constructor

new RDFSerializer(): RDFSerializer
Returns RDFSerializer
Inherited from DataSerializer.constructor

Properties

`Protected` `Static` `Readonly`deserializer

deserializer: Deserializer

`Protected` `Static`documentLoader

documentLoader: DocumentLoader

`Protected` `Static`engine

engine: QueryEngine

`Protected` `Static`eventEmitter

eventEmitter: EventEmitter

`Protected` `Static` `Readonly`knownRDFTypes

knownRDFTypes: Map<`http://${string}` | `https://${string}`, string[]> = ...

`Protected` `Static` `Readonly`knownTypes

knownTypes: Map<string, Serializable<any>>

`Protected` `Static`options

options: DataSerializerConfig = ...

`Protected` `Static` `Readonly`primitiveTypes

primitiveTypes: Map<string, Constructor<any>> = ...

`Protected` `Static` `Readonly`serializer

serializer: Serializer

Methods

`Static`clone

clone<T, D = T>(object: T, dataType?: Constructor<D>): D
Clone a serializable object
Type Parameters
- T
- D = T
Parameters
- object: T
  Serializable object
- OptionaldataType: Constructor<D>
  Data type to clone to
Returns D
Cloned object
Inherited from DataSerializer.clone
- Defined in node_modules/@openhps/core/dist/types/data/DataSerializer.d.ts:80

`Static`deserialize

deserialize<T>(serializedData: Literal | Thing, dataType?: Serializable<T>): T
Deserialize data
Type Parameters
- T
Parameters
- serializedData: Literal | Thing
  Data to deserialze
- OptionaldataType: Serializable<T>
  Optional data type to specify deserialization type
Returns T
Overrides DataSerializer.deserialize
- Defined in src/rdf/RDFSerializer.ts:751
deserialize<T>(serializedData: any[], dataType?: Serializable<T>): T | T[]
Type Parameters
- T
Parameters
- serializedData: any[]
- OptionaldataType: Serializable<T>
Returns T | T[]
Overrides DataSerializer.deserialize
- Defined in src/rdf/RDFSerializer.ts:752

`Static`deserializeFromJSONLD

deserializeFromJSONLD<T>(
subject: `http://${string}` | `https://${string}`,
data: any,
): Promise<T>
Type Parameters
- T
Parameters
- subject: `http://${string}` | `https://${string}`
- data: any
Returns Promise<T>
- Defined in src/rdf/RDFSerializer.ts:188

`Static`deserializeFromStore

deserializeFromStore<T>(
    subject:
        | NamedNode<string>
        | BlankNode
        | `http://${string}`
        | `https://${string}`,
    store: Store,
    dataType?: Serializable<any>,
): T
Deserialize data from a store
Type Parameters
- T
Parameters
- subject: NamedNode<string> | BlankNode | `http://${string}` | `https://${string}`
  Subject to deserialize
- store: Store
  Store to deserialize from
- OptionaldataType: Serializable<any>
  Optional data type to specify deserialization type
Returns T
- Defined in src/rdf/RDFSerializer.ts:317

`Static`deserializeFromString

deserializeFromString<T>(
    subject: `http://${string}` | `https://${string}`,
    input: string,
    contentType?: string,
): T
Type Parameters
- T
Parameters
- subject: `http://${string}` | `https://${string}`
- input: string
- contentType: string = 'text/turtle'
Returns T
- Defined in src/rdf/RDFSerializer.ts:256

`Static`deserializeFromSubject

deserializeFromSubject<T>(
subject: Subject & { url: `http://${string}` | `https://${string}` },
): T
Type Parameters
- T
Parameters
- subject: Subject & { url: `http://${string}` | `https://${string}` }
Returns T
- Defined in src/rdf/RDFSerializer.ts:691

`Static`deserializeFromSubjects

deserializeFromSubjects<T>(
subject: `http://${string}` | `https://${string}`,
subjects: Subject[],
): T
Type Parameters
- T
Parameters
- subject: `http://${string}` | `https://${string}`
- subjects: Subject[]
Returns T
- Defined in src/rdf/RDFSerializer.ts:695

`Static`findRootMetaInfo

findRootMetaInfo(proto: any): ObjectMetadata
Find the root TypedJSON metadata
Parameters
- proto: any
  Prototype of target
Returns ObjectMetadata
Root object metadata

Deprecated
use DataSerializerUtils.getRootMetadata
Inherited from DataSerializer.findRootMetaInfo
- Defined in node_modules/@openhps/core/dist/types/data/DataSerializer.d.ts:67

`Static`findTypeByName

findTypeByName(name: string): Serializable<any>
Parameters
- name: string
Returns Serializable<any>
Inherited from DataSerializer.findTypeByName
- Defined in node_modules/@openhps/core/dist/types/data/DataSerializer.d.ts:73

`Static`getDocumentLoader

getDocumentLoader(): DocumentLoader
Get the document loader

Returns DocumentLoader
Document loader
- Defined in src/rdf/RDFSerializer.ts:78

`Static`getMetadata

getMetadata(proto: any): ObjectMetadata
Get the TypedJSON metadata
Parameters
- proto: any
  Prototype of target
Returns ObjectMetadata
Root object metadata

Deprecated
use DataSerializerUtils.getMetadata

See
https://gist.github.com/krizka/c83fb1966dd57997a1fc02625719387d
Inherited from DataSerializer.getMetadata
- Defined in node_modules/@openhps/core/dist/types/data/DataSerializer.d.ts:52

`Static`getRootMetadata

getRootMetadata(proto: any): ObjectMetadata
Get the root TypedJSON metadata
Parameters
- proto: any
  Prototype of target
Returns ObjectMetadata
Root object metadata

Deprecated
use DataSerializerUtils.getRootMetadata

See
https://gist.github.com/krizka/c83fb1966dd57997a1fc02625719387d
Inherited from DataSerializer.getRootMetadata
- Defined in node_modules/@openhps/core/dist/types/data/DataSerializer.d.ts:60

`Static`getUriMetadata

getUriMetadata<T>(dataType: Serializable<T>): ObjectMemberMetadata
Type Parameters
- T
Parameters
- dataType: Serializable<T>
Returns ObjectMemberMetadata
- Defined in src/rdf/RDFSerializer.ts:798

`Static`initialize

initialize(module: string): Promise<void>
Initialize the RDF serializer
Parameters
- module: string
  Module to initialize
Returns Promise<void>
- Defined in src/rdf/RDFSerializer.ts:119

`Static`normalizeUri

normalizeUri<T>(
    dataType: Serializable<T>,
    identifier: any,
    baseUri: `http://${string}` | `https://${string}`,
): `http://${string}` | `https://${string}`
Type Parameters
- T
Parameters
- dataType: Serializable<T>
- identifier: any
- baseUri: `http://${string}` | `https://${string}`
Returns `http://${string}` | `https://${string}`
- Defined in src/rdf/RDFSerializer.ts:825

`Static`quadsToThing

quadsToThing(subject: NamedNode<string> | BlankNode, store: Store): Thing
Convert quads to thing
Parameters
- subject: NamedNode<string> | BlankNode
  Subject of quad
- store: Store
  Quad store
Returns Thing
Thing from quads
- Defined in src/rdf/RDFSerializer.ts:561

`Static`registerRDFType

registerRDFType<T>(
type: Serializable<T>,
options?: MappedRDFTypeConverters<T>,
): void
Type Parameters
- T
Parameters
- type: Serializable<T>
- Optionaloptions: MappedRDFTypeConverters<T>
Returns void
- Defined in src/rdf/RDFSerializer.ts:90

`Static`registerType

registerType<T>(
type: Serializable<T>,
converters?: MappedTypeConverters<T>,
): void
Manually register a new type
Type Parameters
- T
Parameters
- type: Serializable<T>
  Type to register
- Optionalconverters: MappedTypeConverters<T>
  Optional converters
Returns void
Inherited from DataSerializer.registerType
- Defined in node_modules/@openhps/core/dist/types/data/DataSerializer.d.ts:44

`Static`serialize

serialize<T>(data: T, config?: RDFSerializerConfig): Thing
Serialize data
Type Parameters
- T
Parameters
- data: T
  Data to serialize
- Optionalconfig: RDFSerializerConfig
  RDF serializer configuration
Returns Thing
Serialized data
Overrides DataSerializer.serialize
- Defined in src/rdf/RDFSerializer.ts:208

`Static`serializeToChangeLog

serializeToChangeLog<T>(data: T, config?: RDFSerializerConfig): RDFChangeLog
Serialize data to changelog
Type Parameters
- T
Parameters
- data: T
  Data to serialize
- Optionalconfig: RDFSerializerConfig
  RDF serializer configuration
Returns RDFChangeLog
Serialized data
- Defined in src/rdf/RDFSerializer.ts:224

`Static`serializeToJSONLD

serializeToJSONLD<T>(
data: T,
baseUri?: `http://${string}` | `https://${string}`,
): Promise<any[]>
Serialize data to JSON-LD
Type Parameters
- T
Parameters
- data: T
  Data to serialize to an URI
- OptionalbaseUri: `http://${string}` | `https://${string}`
  Base URI
Returns Promise<any[]>
- Defined in src/rdf/RDFSerializer.ts:176

`Static`serializeToQuads

serializeToQuads<T>(
data: T,
baseUri?: `http://${string}` | `https://${string}`,
): Quad[]
Type Parameters
- T
Parameters
- data: T
- OptionalbaseUri: `http://${string}` | `https://${string}`
Returns Quad[]
- Defined in src/rdf/RDFSerializer.ts:398

`Static`serializeToStore

serializeToStore<T>(
data: T,
baseUri?: `http://${string}` | `https://${string}`,
): Store<Quad, Quad, Quad, Quad> & RDFChangeLog
Serialize data to a store with changelog
Type Parameters
- T
Parameters
- data: T
- OptionalbaseUri: `http://${string}` | `https://${string}`
Returns Store<Quad, Quad, Quad, Quad> & RDFChangeLog
- Defined in src/rdf/RDFSerializer.ts:391

`Static`serializeToSubjects

serializeToSubjects<T>(
data: T,
baseUri?: `http://${string}` | `https://${string}`,
): Subject[]
Type Parameters
- T
Parameters
- data: T
- OptionalbaseUri: `http://${string}` | `https://${string}`
Returns Subject[]
- Defined in src/rdf/RDFSerializer.ts:333

`Static`serializeToUri

serializeToUri<T>(
data: T,
baseUri?: `http://${string}` | `https://${string}`,
): `http://${string}` | `https://${string}`
Serialize an object to an URI
Type Parameters
- T
Parameters
- data: T
  Data to serialize to an URI
- OptionalbaseUri: `http://${string}` | `https://${string}`
  Base URI
Returns `http://${string}` | `https://${string}`
Resource URI
- Defined in src/rdf/RDFSerializer.ts:158

`Static`setQueryEngine

setQueryEngine(engine: QueryEngine): void
Parameters
- engine: QueryEngine
Returns void
- Defined in src/rdf/RDFSerializer.ts:147

`Static`stringify

stringify(thing: any, options?: WriterOptions): Promise<string>
Stringify a thing to RDF graph construct
Parameters
- thing: any
  Thing to serialize
- Optionaloptions: WriterOptions = {}
  Writer options
Returns Promise<string>
Promise of a stringified graph
- Defined in src/rdf/RDFSerializer.ts:439

`Static`subjectsToQuads

subjectsToQuads(subjects: Subject[]): Quad[]
Convert subjects to quads
Parameters
- subjects: Subject[]
  List of subjects
Returns Quad[]
- Defined in src/rdf/RDFSerializer.ts:604

`Static`subjectsToThing

subjectsToThing(
subjects: Subject[],
subject: `http://${string}` | `https://${string}`,
): Thing
Convert subjects to thing
Parameters
- subjects: Subject[]
  List of subjects
- subject: `http://${string}` | `https://${string}`
  Main subject
Returns Thing
Thing
- Defined in src/rdf/RDFSerializer.ts:550

`Static`thingToQuads

thingToQuads(thing: Thing): Quad[]
Parameters
- thing: Thing
Returns Quad[]
- Defined in src/rdf/RDFSerializer.ts:407

`Static`thingToSubjects

thingToSubjects(
thing: Thing,
baseUri?: `http://${string}` | `https://${string}`,
): Subject[]
Convert thing to subjects
Parameters
- thing: Thing
  Thing to convert
- OptionalbaseUri: `http://${string}` | `https://${string}`
  Base URI
Returns Subject[]
List of subjects
- Defined in src/rdf/RDFSerializer.ts:687

`Static`unregisterType

unregisterType(type: Serializable<any>): void
Unregister a type
Parameters
- type: Serializable<any>
  Type to unregister
Returns void
Inherited from DataSerializer.unregisterType
- Defined in node_modules/@openhps/core/dist/types/data/DataSerializer.d.ts:72

Class RDFSerializer

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns RDFSerializer

Properties

Protected Static Readonlydeserializer

Protected StaticdocumentLoader

Protected Staticengine

Protected StaticeventEmitter

Protected Static ReadonlyknownRDFTypes

Protected Static ReadonlyknownTypes

Protected Staticoptions

Protected Static ReadonlyprimitiveTypes

Protected Static Readonlyserializer

Methods

Staticclone

Type Parameters

Parameters

Returns D

Staticdeserialize

Type Parameters

Parameters

Returns T

Type Parameters

Parameters

Returns T | T[]

StaticdeserializeFromJSONLD

Type Parameters

Parameters

Returns Promise<T>

StaticdeserializeFromStore

Type Parameters

Parameters

Returns T

StaticdeserializeFromString

Type Parameters

Parameters

Returns T

StaticdeserializeFromSubject

Type Parameters

Parameters

Returns T

StaticdeserializeFromSubjects

Type Parameters

Parameters

Returns T

StaticfindRootMetaInfo

Parameters

Returns ObjectMetadata

Deprecated

StaticfindTypeByName

Parameters

Returns Serializable<any>

StaticgetDocumentLoader

Returns DocumentLoader

StaticgetMetadata

Parameters

Returns ObjectMetadata

Deprecated

See

StaticgetRootMetadata

Parameters

Returns ObjectMetadata

Deprecated

See

StaticgetUriMetadata

Type Parameters

Parameters

Returns ObjectMemberMetadata

Staticinitialize

Parameters

Returns Promise<void>

StaticnormalizeUri

Type Parameters

Parameters

`Protected` `Static` `Readonly`deserializer

`Protected` `Static`documentLoader

`Protected` `Static`engine

`Protected` `Static`eventEmitter

`Protected` `Static` `Readonly`knownRDFTypes

`Protected` `Static` `Readonly`knownTypes

`Protected` `Static`options

`Protected` `Static` `Readonly`primitiveTypes

`Protected` `Static` `Readonly`serializer

`Static`clone

`Static`deserialize

`Static`deserializeFromJSONLD

`Static`deserializeFromStore

`Static`deserializeFromString

`Static`deserializeFromSubject

`Static`deserializeFromSubjects

`Static`findRootMetaInfo

`Static`findTypeByName

`Static`getDocumentLoader

`Static`getMetadata

`Static`getRootMetadata

`Static`getUriMetadata

`Static`initialize

`Static`normalizeUri

`Static`quadsToThing

`Static`registerRDFType

`Static`registerType

`Static`serialize

`Static`serializeToChangeLog

`Static`serializeToJSONLD

`Static`serializeToQuads

`Static`serializeToStore

`Static`serializeToSubjects

`Static`serializeToUri

`Static`setQueryEngine

`Static`stringify

`Static`subjectsToQuads

`Static`subjectsToThing

`Static`thingToQuads

`Static`thingToSubjects

`Static`unregisterType