|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface QueriableResourceProvider
A queriable resource provider is an extension of a resource provider.
This extension is supported for services directly implementing the
ResourceProvider
interface and ResourceProvider
s
returned through a ResourceProviderFactory
.
Field Summary | |
---|---|
static java.lang.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 |
Method Summary | |
---|---|
java.util.Iterator<Resource> |
findResources(ResourceResolver resolver,
java.lang.String query,
java.lang.String language)
Searches for resources using the given query formulated in the given language. |
java.util.Iterator<ValueMap> |
queryResources(ResourceResolver resolver,
java.lang.String query,
java.lang.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 |
---|
static final java.lang.String LANGUAGES
ResourceProviderFactory
this property should be declared on the factory.
Method Detail |
---|
java.util.Iterator<Resource> findResources(ResourceResolver resolver, java.lang.String query, java.lang.String 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.
query
- The query string to use to find the resources.language
- The language in which the query is formulated.
Iterator
of Resource
objects matching the
query. If no resources match, null
might be
returned instead of an empty iterator.
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.
java.lang.IllegalStateException
- if this resource provider has already been
closed.java.util.Iterator<ValueMap> queryResources(ResourceResolver resolver, java.lang.String query, java.lang.String 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.
query
- The query string to use to find the resources.language
- The language in which the query is formulated.
Iterator
of Map
instances providing
access to the query result. If no resources match, null
might be returned instead of an empty iterator.
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.
java.lang.IllegalStateException
- if this resource provider has already been
closed.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |