Class: LabelIndex

Represents a label index document as described in https://github.com/pod-os/PodOS/blob/main/docs/features/full-text-search.md

Extends

RdfDocument

Constructors

Constructor

new LabelIndex(uri, store, editable?): LabelIndex

Defined in: search/LabelIndex.ts:11

Parameters

uri

string

store

Store

editable?

boolean = false

Returns

LabelIndex

Overrides

RdfDocument.constructor

Properties

editable

readonly editable: boolean

Defined in: thing/Thing.ts:82

Whether the Thing can be edited according to its access control settings

Inherited from

RdfDocument.editable

store

readonly store: Store

Defined in: thing/Thing.ts:78

Inherited from

RdfDocument.store

uri

readonly uri: string

Defined in: thing/Thing.ts:77

Inherited from

RdfDocument.uri

Methods

anyValue()

anyValue(...predicateUris): undefined

Defined in: thing/Thing.ts:219

Returns any value linked from this thing via one of the given predicates

Parameters

predicateUris

...string[]

Returns

undefined

Inherited from

RdfDocument.anyValue

assume()

assume\<T>(SpecificThing): T

Defined in: thing/Thing.ts:406

Call this method to switch to a more specific subclass of Thing.

Type Parameters

T

T

Parameters

SpecificThing

(uri, store, editable) => T

a subclass of Thing to assume

Returns

T

Inherited from

RdfDocument.assume

attachments()

attachments(): Attachment[]

Defined in: thing/Thing.ts:387

Returns all attachments linked to this thing

Returns

Attachment[]

Inherited from

RdfDocument.attachments

container()

container(): object

Defined in: thing/Thing.ts:416

Returns the container that contains this thing's document The container URI is derived from the thing's URI.

Returns

object

uri

uri: string

Inherited from

RdfDocument.container

contains()

contains(uri): boolean

Defined in: search/LabelIndex.ts:34

Parameters

uri

string

Returns

boolean

description()

description(): undefined

Defined in: thing/Thing.ts:286

Returns a literal value that describes this thing. Tries to match common RDF terms used for descriptions, like dct:description, schema:description or rdfs:comment

Returns

undefined

Inherited from

RdfDocument.description

getIndexedItems()

getIndexedItems(): object[]

Defined in: search/LabelIndex.ts:18

Returns the URIs and labels for all the things listed in the document.

Returns

object[]

label()

label(): string

Defined in: thing/Thing.ts:96

Returns a human-readable label for this thing. Tries to match common RDF terms used for labels, such as rdfs:label, schema:name and others.

If no such term is present, it will derive a label from the URI.

Returns

string

Inherited from

RdfDocument.label

literals()

literals(): Literal[]

Defined in: thing/Thing.ts:116

Returns all the literal values that are linked to this thing

Returns

Literal[]

Inherited from

RdfDocument.literals

observeAnyValue()

observeAnyValue(...predicateUris): Observable\<string | undefined>

Defined in: thing/Thing.ts:235

Observe changes in a value linked from this thing via one of the given predicates

Note that return value may differ from that from anyValue when more than one value is present.

Parameters

predicateUris

...string[]

Returns

Observable\<string | undefined>

Inherited from

RdfDocument.observeAnyValue

observeDescription()

observeDescription(): Observable\<string | undefined>

Defined in: thing/Thing.ts:293

Observe changes in literal values that describe this thing. See description

Returns

Observable\<string | undefined>

Inherited from

RdfDocument.observeDescription

observeLabel()

observeLabel(): Observable\<string>

Defined in: thing/Thing.ts:107

Observe changes in human-readable label for this thing. See label.

Returns

Observable\<string>

Inherited from

RdfDocument.observeLabel

observeRelations()

observeRelations(predicate?): Observable\<Relation[]>

Defined in: thing/Thing.ts:153

Observe changes in links from this thing to other resources

Parameters

predicate?

string

Returns

Observable\<Relation[]>

Inherited from

RdfDocument.observeRelations

observeReverseRelations()

observeReverseRelations(predicate?): Observable\<Relation[]>

Defined in: thing/Thing.ts:195

Observe changes in links from other resources to this thing

Parameters

predicate?

string

Returns

Observable\<Relation[]>

Inherited from

RdfDocument.observeReverseRelations

observeTypes()

observeTypes(): Observable\<RdfType[]>

Defined in: thing/Thing.ts:368

Observe changes to the list of RDF types for this thing

Returns

Observable\<RdfType[]>

Inherited from

RdfDocument.observeTypes

picture()

picture(): { url: string; } | null

Defined in: thing/Thing.ts:304

Returns the url of a picture or logo associated with this thing Tries to match common RDF terms used for pictures like schema:image, vcard:photo or foaf:img