org.outerj.daisy.repository.query
Interface QueryManager


public interface QueryManager

The QueryManager allows to perform queries on the repository.


Method Summary
 PredicateExpression parsePredicateExpression(java.lang.String expression)
          Parses a predicate expression (= the where-part of a Daisy query, an expression which evaluates to either true or false) for future evaluation on a document.
 org.outerx.daisy.x10.DistinctSearchResultDocument performDistinctQuery(java.lang.String query, SortOrder sortOrder, java.util.Locale locale)
           
 org.outerx.daisy.x10.DistinctSearchResultDocument performDistinctQuery(java.lang.String query, java.lang.String extraCond, SortOrder sortOrder, java.util.Locale locale)
           
 org.outerx.daisy.x10.FacetedQueryResultDocument performFacetedQuery(java.lang.String query, FacetConf[] facetConfs, int chunkOffset, int chunkLength, java.util.Locale locale)
          Performs a query and includes for each selected value the set of distinct values, if the isFacet property of the corresponding entry in the given facetConfs array is true.
 org.outerx.daisy.x10.SearchResultDocument performQuery(java.lang.String query, java.util.Locale locale)
          Executes a query and returns the results as XML.
 org.outerx.daisy.x10.SearchResultDocument performQuery(java.lang.String query, java.util.Locale locale, EvaluationContext evaluationContext)
           
 org.outerx.daisy.x10.SearchResultDocument performQuery(java.lang.String query, java.lang.String extraCond, java.util.Locale locale)
          Same as performQueryReturnKeys(java.lang.String, java.lang.String, java.util.Locale) but returns the results as XML.
 org.outerx.daisy.x10.SearchResultDocument performQuery(java.lang.String query, java.lang.String extraCond, java.util.Locale locale, EvaluationContext evaluationContext)
           
 org.outerx.daisy.x10.SearchResultDocument performQuery(java.lang.String query, java.lang.String extraCond, java.util.Map queryOptions, java.util.Locale locale)
           
 org.outerx.daisy.x10.SearchResultDocument performQuery(java.lang.String query, java.lang.String extraCond, java.util.Map queryOptions, java.util.Locale locale, EvaluationContext evaluationContext)
           
 VariantKey[] performQueryReturnKeys(java.lang.String query, java.util.Locale locale)
          Executes a query and returns the keys of the matching document variants.
 VariantKey[] performQueryReturnKeys(java.lang.String query, java.util.Locale locale, EvaluationContext evaluationContext)
           
 VariantKey[] performQueryReturnKeys(java.lang.String query, java.lang.String extraCond, java.util.Locale locale)
          Executes a query and returns the keys of the matching document variants.
 VariantKey[] performQueryReturnKeys(java.lang.String query, java.lang.String extraCond, java.util.Locale locale, EvaluationContext evaluationContext)
           
 VariantKey[] performQueryReturnKeys(java.lang.String query, java.lang.String extraCond, java.util.Map queryOptions, java.util.Locale locale)
           
 VariantKey[] performQueryReturnKeys(java.lang.String query, java.lang.String extraCond, java.util.Map queryOptions, java.util.Locale locale, EvaluationContext evaluationContext)
           
 

Method Detail

performQuery

org.outerx.daisy.x10.SearchResultDocument performQuery(java.lang.String query,
                                                       java.util.Locale locale)
                                                       throws RepositoryException
Executes a query and returns the results as XML.

Parameters:
query - a query written in the Daisy Query Language
locale - influences the sort behaviour and formatting of non-string fields
Throws:
RepositoryException

performQuery

org.outerx.daisy.x10.SearchResultDocument performQuery(java.lang.String query,
                                                       java.util.Locale locale,
                                                       EvaluationContext evaluationContext)
                                                       throws RepositoryException
Throws:
RepositoryException

performQueryReturnKeys

VariantKey[] performQueryReturnKeys(java.lang.String query,
                                    java.util.Locale locale)
                                    throws RepositoryException
Executes a query and returns the keys of the matching document variants.

In this case, the select part of the query is ignored, but should still be specified to have a valid query. Use eg "select id where ...".

Parameters:
query - a query written in the Daisy Query Language
locale - influences the sort behaviour
Throws:
RepositoryException

performQueryReturnKeys

VariantKey[] performQueryReturnKeys(java.lang.String query,
                                    java.util.Locale locale,
                                    EvaluationContext evaluationContext)
                                    throws RepositoryException
Throws:
RepositoryException

performQueryReturnKeys

VariantKey[] performQueryReturnKeys(java.lang.String query,
                                    java.lang.String extraCond,
                                    java.util.Locale locale)
                                    throws RepositoryException
Executes a query and returns the keys of the matching document variants.

In this case, the select part of the query is ignored, but should still be specified to have a valid query. Use eg "select id where ...".

Parameters:
query - a query written in the Daisy Query Language
extraCond - extra conditions that will be and-ed to the conditions of the query. This allows to force certain conditions, eg only returning documents part of a certain collection.
locale - influences the sort behaviour
Throws:
RepositoryException

performQueryReturnKeys

VariantKey[] performQueryReturnKeys(java.lang.String query,
                                    java.lang.String extraCond,
                                    java.util.Map queryOptions,
                                    java.util.Locale locale)
                                    throws RepositoryException
Throws:
RepositoryException

performQueryReturnKeys

VariantKey[] performQueryReturnKeys(java.lang.String query,
                                    java.lang.String extraCond,
                                    java.util.Locale locale,
                                    EvaluationContext evaluationContext)
                                    throws RepositoryException
Throws:
RepositoryException

performQueryReturnKeys

VariantKey[] performQueryReturnKeys(java.lang.String query,
                                    java.lang.String extraCond,
                                    java.util.Map queryOptions,
                                    java.util.Locale locale,
                                    EvaluationContext evaluationContext)
                                    throws RepositoryException
Throws:
RepositoryException

performQuery

org.outerx.daisy.x10.SearchResultDocument performQuery(java.lang.String query,
                                                       java.lang.String extraCond,
                                                       java.util.Locale locale)
                                                       throws RepositoryException
Same as performQueryReturnKeys(java.lang.String, java.lang.String, java.util.Locale) but returns the results as XML.

Throws:
RepositoryException

performQuery

org.outerx.daisy.x10.SearchResultDocument performQuery(java.lang.String query,
                                                       java.lang.String extraCond,
                                                       java.util.Map queryOptions,
                                                       java.util.Locale locale)
                                                       throws RepositoryException
Throws:
RepositoryException

performQuery

org.outerx.daisy.x10.SearchResultDocument performQuery(java.lang.String query,
                                                       java.lang.String extraCond,
                                                       java.util.Locale locale,
                                                       EvaluationContext evaluationContext)
                                                       throws RepositoryException
Throws:
RepositoryException

performQuery

org.outerx.daisy.x10.SearchResultDocument performQuery(java.lang.String query,
                                                       java.lang.String extraCond,
                                                       java.util.Map queryOptions,
                                                       java.util.Locale locale,
                                                       EvaluationContext evaluationContext)
                                                       throws RepositoryException
Parameters:
queryOptions - a map specifying forced values for query options (the options which one can otherwise specify in the query itself, such as 'search_last_version'. Keys and values in this map should be String objects.
Throws:
RepositoryException

performFacetedQuery

org.outerx.daisy.x10.FacetedQueryResultDocument performFacetedQuery(java.lang.String query,
                                                                    FacetConf[] facetConfs,
                                                                    int chunkOffset,
                                                                    int chunkLength,
                                                                    java.util.Locale locale)
                                                                    throws RepositoryException
Performs a query and includes for each selected value the set of distinct values, if the isFacet property of the corresponding entry in the given facetConfs array is true.

If the length of the facetConf array does not correspond to the number of selected values, this will not give an error.

Throws:
RepositoryException

performDistinctQuery

org.outerx.daisy.x10.DistinctSearchResultDocument performDistinctQuery(java.lang.String query,
                                                                       SortOrder sortOrder,
                                                                       java.util.Locale locale)
                                                                       throws RepositoryException
Throws:
RepositoryException

performDistinctQuery

org.outerx.daisy.x10.DistinctSearchResultDocument performDistinctQuery(java.lang.String query,
                                                                       java.lang.String extraCond,
                                                                       SortOrder sortOrder,
                                                                       java.util.Locale locale)
                                                                       throws RepositoryException
Throws:
RepositoryException

parsePredicateExpression

PredicateExpression parsePredicateExpression(java.lang.String expression)
                                             throws QueryException
Parses a predicate expression (= the where-part of a Daisy query, an expression which evaluates to either true or false) for future evaluation on a document.

Throws:
QueryException


Copyright © -2012 . All Rights Reserved.