org.apache.marmotta.ldcache.api

Interface LDCachingService

All Known Implementing Classes:

LDCache

public interface LDCachingService

This is the next-generation API for LDCache that will become the default in Marmotta 3.3 or 4.0. For now, LDCache implements both the old and the new style.

User: sschaffe

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LDCachingService.RefreshOpts

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Manually expire all cached resources.
boolean	contains(org.openrdf.model.URI resource) Return true in case the cache contains an entry for the resource given as argument.
void	expire(org.openrdf.model.URI resource) Manually expire the caching information for the given resource.
org.openrdf.model.Model	get(org.openrdf.model.URI resource, LDCachingService.RefreshOpts... options) Refresh and return the resource passed as argument.
void	refresh(org.openrdf.model.URI resource, LDCachingService.RefreshOpts... options) Refresh the resource passed as argument.
void	shutdown() Shutdown the caching service and free all occupied runtime resources.

Method Detail

refresh

void refresh(org.openrdf.model.URI resource,
           LDCachingService.RefreshOpts... options)

Refresh the resource passed as argument. If the resource is not yet cached or the cache entry is expired or refreshing is forced, the remote resource is retrieved using LDClient and the result stored in the cache. Otherwise the method does nothing.

Parameters:

resource - the resource to refresh

options - options for refreshing

get

org.openrdf.model.Model get(org.openrdf.model.URI resource,
                          LDCachingService.RefreshOpts... options)

Refresh and return the resource passed as argument. If the resource is not yet cached or the cache entry is expired or refreshing is forced, the remote resource is retrieved using LDClient and the result stored in the cache. Otherwise the method does nothing.

Parameters:

resource - the resource to retrieve

options - options for refreshing

Returns:

a Sesame Model holding the triples representing the resource

expire

void expire(org.openrdf.model.URI resource)

Manually expire the caching information for the given resource. The resource will be re-retrieved upon the next access.

Parameters:

resource - the resource to expire.

contains

boolean contains(org.openrdf.model.URI resource)

Return true in case the cache contains an entry for the resource given as argument.

Parameters:

resource - the resource to check

Returns:

true in case the resource is contained in the cache

clear

void clear()

Manually expire all cached resources.

shutdown

void shutdown()

Shutdown the caching service and free all occupied runtime resources.