Package org.trellisldp.spi

Interface ResourceService

public interface ResourceService

The ResourceService provides methods for creating, retrieving and manipulating repository resources.

Method Summary

Modifier and Type	Method	Description
java.util.stream.Stream<org.apache.commons.rdf.api.IRI>	compact(org.apache.commons.rdf.api.IRI identifier, java.time.Instant from, java.time.Instant until)	Compact (i.e.
default java.util.stream.Stream<? extends org.apache.commons.rdf.api.Quad>	export(java.lang.String partition, java.util.Collection<org.apache.commons.rdf.api.IRI> graphNames)	Export the complete repository as a stream of Quads
java.util.Optional<org.trellisldp.api.Resource>	get(org.apache.commons.rdf.api.IRI identifier)	Get a resource from the given location
java.util.Optional<org.trellisldp.api.Resource>	get(org.apache.commons.rdf.api.IRI identifier, java.time.Instant time)	Get a resource from the given location and time
default java.util.Optional<org.apache.commons.rdf.api.IRI>	getContainer(org.apache.commons.rdf.api.IRI identifier)	Get the identifier for the structurally-logical container for the resource
java.util.function.Supplier<java.lang.String>	getIdentifierSupplier()	An identifier supplier
java.util.stream.Stream<? extends org.apache.commons.rdf.api.Triple>	list(java.lang.String partition)	Get a list of resources in the partition
java.util.stream.Stream<org.apache.commons.rdf.api.IRI>	purge(org.apache.commons.rdf.api.IRI identifier)	Purge a resource from the repository
java.lang.Boolean	put(org.apache.commons.rdf.api.IRI identifier, org.apache.commons.rdf.api.Dataset dataset)	Put a resource into the repository
default org.apache.commons.rdf.api.RDFTerm	skolemize(org.apache.commons.rdf.api.RDFTerm term)	Skolemize a blank node
default org.apache.commons.rdf.api.RDFTerm	unskolemize(org.apache.commons.rdf.api.RDFTerm term)	Un-skolemize a blank node

Method Detail

get

java.util.Optional<org.trellisldp.api.Resource> get(org.apache.commons.rdf.api.IRI identifier)

Get a resource from the given location

Parameters:

identifier - the resource identifier

Returns:

the resource

get

java.util.Optional<org.trellisldp.api.Resource> get(org.apache.commons.rdf.api.IRI identifier,
                                                    java.time.Instant time)

Get a resource from the given location and time

Parameters:

identifier - the resource identifier

time - the time

Returns:

the resource

put

java.lang.Boolean put(org.apache.commons.rdf.api.IRI identifier,
                      org.apache.commons.rdf.api.Dataset dataset)

Put a resource into the repository

Parameters:

identifier - the identifier for the new resource

dataset - the dataset

Returns:

whether the resource was added

getContainer

default java.util.Optional<org.apache.commons.rdf.api.IRI> getContainer(org.apache.commons.rdf.api.IRI identifier)

Get the identifier for the structurally-logical container for the resource

Parameters:

identifier - the identifier

Returns:

an identifier for the structurally-logical container Note: The returned identifier is not guaranteed to exist

compact

java.util.stream.Stream<org.apache.commons.rdf.api.IRI> compact(org.apache.commons.rdf.api.IRI identifier,
                                                                java.time.Instant from,
                                                                java.time.Instant until)

Compact (i.e. remove the history) of a resource

Parameters:

identifier - the identifier

from - a time after which a resource is to be compacted

until - a time before which a resource is to be compacted

Returns:

a stream of binary IRIs that can be safely purged

purge

java.util.stream.Stream<org.apache.commons.rdf.api.IRI> purge(org.apache.commons.rdf.api.IRI identifier)

Purge a resource from the repository

Parameters:

identifier - the identifier

Returns:

a stream of binary IRIs that can be safely purged

list

java.util.stream.Stream<? extends org.apache.commons.rdf.api.Triple> list(java.lang.String partition)

Get a list of resources in the partition

Parameters:

partition - the partition

Returns:

a stream of RDF Triples, containing the resource and its LDP type

skolemize

default org.apache.commons.rdf.api.RDFTerm skolemize(org.apache.commons.rdf.api.RDFTerm term)

Skolemize a blank node

Parameters:

term - the RDF term

Returns:

a skolemized node, if a blank node; otherwise the original term

unskolemize

default org.apache.commons.rdf.api.RDFTerm unskolemize(org.apache.commons.rdf.api.RDFTerm term)

Un-skolemize a blank node

Parameters:

term - the RDF term

Returns:

a blank node, if a previously-skolemized node; otherwise the original term

export

default java.util.stream.Stream<? extends org.apache.commons.rdf.api.Quad> export(java.lang.String partition,
                                                                                  java.util.Collection<org.apache.commons.rdf.api.IRI> graphNames)

Export the complete repository as a stream of Quads

Parameters:

partition - the partition to export

graphNames - the graph names to export

Returns:

a stream of quads, where each named graph refers to the resource identifier

getIdentifierSupplier

java.util.function.Supplier<java.lang.String> getIdentifierSupplier()

An identifier supplier

Returns:

a supplier of identifiers for new resources