org.apache.sling.api.resource

Interface QueriableResourceProvider

All Superinterfaces:

ResourceProvider

@ConsumerType
public interface QueriableResourceProvider
extends ResourceProvider

A queriable resource provider is an extension of a resource provider. This extension is supported for services directly implementing the ResourceProvider interface and ResourceProviders returned through a ResourceProviderFactory.

Since:

2.2 (Sling API Bundle 2.2.0)

Field Summary

Fields

Modifier and Type	Field and Description
static String	LANGUAGES The name of the service registration property containing the supported languages of the resource provider (value is "provider.query.languages").

Fields inherited from interface org.apache.sling.api.resource.ResourceProvider

OWNS_ROOTS, RESOURCE_TYPE_SYNTHETIC, ROOTS, SERVICE_NAME, USE_RESOURCE_ACCESS_SECURITY

Method Summary

Modifier and Type	Method and Description
Iterator<Resource>	findResources(ResourceResolver resolver, String query, String language) Searches for resources using the given query formulated in the given language.
Iterator<ValueMap>	queryResources(ResourceResolver resolver, String query, String language) Queries the storage using the given query formulated in the given language.

Methods inherited from interface org.apache.sling.api.resource.ResourceProvider

getResource, getResource, listChildren

Field Detail

LANGUAGES

static final String LANGUAGES

The name of the service registration property containing the supported languages of the resource provider (value is "provider.query.languages"). If the resource provider is delivered by a ResourceProviderFactory this property should be declared on the factory.

See Also:

Constant Field Values

Method Detail

findResources

Iterator<Resource> findResources(ResourceResolver resolver,
                                 String query,
                                 String language)

Searches for resources using the given query formulated in the given language.

The semantic meaning of the query and language depend on the actual implementation and storage used for the resources. For JCR repository being used as storage, the query and language parameters are used to create a JCR Query through the QueryManager. The result returned is then based on the NodeIterator provided by the query result.

Parameters:

query - The query string to use to find the resources.

language - The language in which the query is formulated.

Returns:

An Iterator of Resource objects matching the query. If no resources match, null might be returned instead of an empty iterator.

Throws:

QuerySyntaxException - If the query is not syntactically correct according to the query language indicator or if the query language is not supported as specified in LANGUAGES.

SlingException - If an error occurs querying for the resources.

IllegalStateException - if this resource provider has already been closed.

queryResources

Iterator<ValueMap> queryResources(ResourceResolver resolver,
                                  String query,
                                  String language)

Queries the storage using the given query formulated in the given language.

The semantic meaning of the query and language depend on the actual implementation and storage used for the resources. For JCR repository being used as storage, the query and language parameters are used to create a JCR Query through the QueryManager. The result returned is then based on the RowIterator provided by the query result. The map returned for each row is indexed by the column name and the column value is the JCR Value object converted into the respective Java object, such as Boolean for a value of property type Boolean.

Parameters:

query - The query string to use to find the resources.

language - The language in which the query is formulated.

Returns:

An Iterator of Map instances providing access to the query result. If no resources match, null might be returned instead of an empty iterator.

Throws:

QuerySyntaxException - If the query is not syntactically correct according to the query language indicator or if the query language is not supported as specified in LANGUAGES.

SlingException - If an error occurs querying for the resources.

IllegalStateException - if this resource provider has already been closed.