Shared/com.erfangholami.androidsolidservices.shared.model.typeindex/PublicTypeIndex

PublicTypeIndex

class PublicTypeIndex : SettingTypeIndex

A Solid public type index document (solid:TypeIndex + solid:ListedDocument).

Registrations in the public type index are world-readable — they advertise what types of data a pod contains so that other applications can discover and request access to them. Use this for resources you are willing to share or make known, such as a shared contacts address book.

The public type index URI is advertised in the owner's WebID profile via solid:publicTypeIndex. Use getPublicTypeIndex on WebId to retrieve it.

Spec: https://solid.github.io/webid-profile/ — Type Indexes

Constructors

PublicTypeIndex

constructor(identifier: String, contentType: String, quads: List<RdfQuad>?, headers: SolidHeaders?)

Functions

addInstance

fun addInstance(forClass: String, instanceUri: String)

Registers a solid:instance entry for forClass pointing to instanceUri.

addInstanceContainer

fun addInstanceContainer(forClass: String, containerUri: String)

Registers a solid:instanceContainer entry for forClass pointing to containerUri.

addQuad

fun addQuad(subject: String, predicate: String, obj: String, maxNumber: Int = 1)

Adds a triple whose object is an IRI (or blank node).

addQuadLiteral

fun addQuadLiteral(subject: String, predicate: String, value: String, datatype: String? = XSD.STRING, language: String? = null, maxNumber: Int = 1)

Adds a triple whose object is a literal.

clearProperties

fun clearProperties(predicate: String, subject: String = itselfSubject)

Removes every triple with the given predicate for subject.

open override fun close()

containsResource

fun containsResource(resourceUri: String): Boolean

Returns true if resourceUri is registered (as either instance or instanceContainer) for any class.

describeContents

open override fun describeContents(): Int

ensureType

fun ensureType(subject: String, typeIri: String)

Ensures subject carries an rdf:type triple with typeIri, preserving any other type triples already present.

findAllProperties

fun findAllProperties(predicate: String): List<String>

Returns the object values of every triple with the given predicate, across all subjects.

findAllPropertiesForSubject

fun findAllPropertiesForSubject(subject: String, predicate: String): List<String>

Returns the object values of every triple matching the given subject and predicate.

findProperty

fun findProperty(predicate: String): String?

Returns the object value of the first triple with the given predicate, or null if none.

findPropertyForSubject

fun findPropertyForSubject(subject: String, predicate: String): String?

Returns the object value of the first triple matching subject and predicate, or null.

getAllQuads

fun getAllQuads(): List<RdfQuad>

Returns a snapshot copy of all triples held by this resource.

getContentType

open override fun getContentType(): String

The media type of the resource representation (the value of its Content-Type).

getCreatedTime

fun getCreatedTime(): Long?

The creation time in epoch milliseconds, from this resource's own dcterms:created (then stat:ctime) triple, or null when neither is present.

getEntity

open override fun getEntity(): InputStream

Returns the resource representation as a byte stream.

getHeaders

open override fun getHeaders(): SolidHeaders

The HTTP headers associated with this resource (empty when constructed locally).

getIdentifier

open override fun getIdentifier(): String

The URI that identifies this resource on the pod.

getInstanceContainers

fun getInstanceContainers(forClass: String): List<String>

Returns all solid:instanceContainer URIs registered for the given forClass IRI.

getInstances

fun getInstances(forClass: String): List<String>

Returns all solid:instance URIs registered for the given forClass IRI.

getLastModified

fun getLastModified(): Long?

The last-modified time in epoch milliseconds. Prefers this resource's own dcterms:modified (then stat:mtime) triple and falls back to the Last-Modified header. null when none is present.

getMetadata

open override fun getMetadata(): SolidMetadata

getSize

fun getSize(): Long

The size of this resource in bytes (its Content-Length), or 0 when the server did not report one.

removeResource

fun removeResource(resourceUri: String)

Removes the registration entry that points to resourceUri (removes the entire registration node including forClass and type triples).

writeToParcel

open override fun writeToParcel(dest: Parcel, flags: Int)