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 = false

Defined in: search/LabelIndex.ts:14

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

Inherited from

RdfDocument.editable

store

readonly store: Store

Defined in: search/LabelIndex.ts:13

Inherited from

RdfDocument.store

uri

readonly uri: string

Defined in: search/LabelIndex.ts:12

Inherited from

RdfDocument.uri

Methods

anyValue()

anyValue(...predicateUris): undefined

Defined in: thing/Thing.ts:183

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:319

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:300

Returns all attachments linked to this thing

Returns

Attachment[]

Inherited from

RdfDocument.attachments

container()

container(): object

Defined in: thing/Thing.ts:329

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:38

Parameters

uri

string

Returns

boolean

description()

description(): undefined

Defined in: thing/Thing.ts:196

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:22

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

Returns

object[]

label()

label(): string

Defined in: thing/Thing.ts:57

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:80

Returns all the literal values that are linked to this thing

Returns

Literal[]

Inherited from

RdfDocument.literals

observeRelations()

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

Defined in: thing/Thing.ts:117

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:159

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:281

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:217

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