org.apache.clerezza.rdf.cris

Class ResourceFinder

java.lang.Object

org.apache.clerezza.rdf.cris.ResourceFinder

Direct Known Subclasses:

GraphIndexer, IndexService

public abstract class ResourceFinder
extends Object

A searchable index.

Author:

rbn, tio, daniel

Constructor Summary

Constructors

Constructor and Description
ResourceFinder()

Method Summary

Methods

Modifier and Type	Method and Description
List<NonLiteral>	findResources(List<? extends Condition> conditions) Find resources using conditions.
List<NonLiteral>	findResources(List<? extends Condition> conditions, FacetCollector... facetCollectors) Find resources using conditions and collect facets.
abstract List<NonLiteral>	findResources(List<? extends Condition> conditions, SortSpecification sortSpecification, FacetCollector... facetCollectors) Find resources using conditions and collect facets and a sort order.
List<NonLiteral>	findResources(UriRef property, String pattern) Find resource with given property whose value matches a pattern.
List<NonLiteral>	findResources(UriRef property, String pattern, boolean escapePattern) Find resource with given property whose value matches a pattern.
List<NonLiteral>	findResources(UriRef property, String pattern, boolean escapePattern, FacetCollector... facetCollectors) Find resource with given property whose value matches a pattern and collect facets.
List<NonLiteral>	findResources(UriRef property, String pattern, boolean escapePattern, SortSpecification sortSpecification, FacetCollector... facetCollectors) Find resource with given property whose value matches a pattern and sort order and collect facets.
List<NonLiteral>	findResources(VirtualProperty property, String pattern) Find resource with given VirtualProperty whose value matches a pattern.
List<NonLiteral>	findResources(VirtualProperty property, String pattern, boolean escapePattern) Find resource with given VirtualProperty whose value matches a pattern.
List<NonLiteral>	findResources(VirtualProperty property, String pattern, boolean escapePattern, FacetCollector... facetCollectors) Find resource with given VirtualProperty whose value matches a pattern and collect facets.
List<NonLiteral>	findResources(VirtualProperty property, String pattern, boolean escapePattern, SortSpecification sortSpecification, FacetCollector... facetCollectors) Find resource with given VirtualProperty whose value matches a pattern and sort specification and collect facets.
abstract void	optimizeIndex() optimize the index
abstract void	reCreateIndex() recreates the index

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResourceFinder

public ResourceFinder()

Method Detail

reCreateIndex

public abstract void reCreateIndex()

recreates the index

optimizeIndex

public abstract void optimizeIndex()

optimize the index

findResources

public List<NonLiteral> findResources(List<? extends Condition> conditions)
                               throws org.apache.lucene.queryparser.classic.ParseException

Find resources using conditions.

Parameters:

conditions - a list of conditions to construct a query from.

Returns:

a list of resources that match the query.

Throws:

org.apache.lucene.queryparser.classic.ParseException - when the resulting query is illegal.

findResources

public List<NonLiteral> findResources(List<? extends Condition> conditions,
                             FacetCollector... facetCollectors)
                               throws org.apache.lucene.queryparser.classic.ParseException

Find resources using conditions and collect facets.

Parameters:

conditions - a list of conditions to construct a query from.

facetCollectors - facet collectors to apply to the query result.

Returns:

a list of resources that match the query.

Throws:

org.apache.lucene.queryparser.classic.ParseException - when the resulting query is illegal.

findResources

public abstract List<NonLiteral> findResources(List<? extends Condition> conditions,
                             SortSpecification sortSpecification,
                             FacetCollector... facetCollectors)
                                        throws org.apache.lucene.queryparser.classic.ParseException

Find resources using conditions and collect facets and a sort order.

Parameters:

conditions - a list of conditions to construct a query from.

facetCollectors - facet collectors to apply to the query result.

sortSpecification - specifies the sort order.

Returns:

a list of resources that match the query.

Throws:

org.apache.lucene.queryparser.classic.ParseException - when the resulting query is illegal.

findResources

public List<NonLiteral> findResources(UriRef property,
                             String pattern)
                               throws org.apache.lucene.queryparser.classic.ParseException

Find resource with given property whose value matches a pattern.

Parameters:

property - The property to which to apply the pattern.

pattern - The pattern from which to construct a query.

Returns:

a list of resources that match the query.

Throws:

org.apache.lucene.queryparser.classic.ParseException - when the resulting query is illegal.

findResources

public List<NonLiteral> findResources(UriRef property,
                             String pattern,
                             boolean escapePattern)
                               throws org.apache.lucene.queryparser.classic.ParseException

Find resource with given property whose value matches a pattern.

Parameters:

property - The property to which to apply the pattern.

pattern - The pattern from which to construct a query.

escapePattern - whether to escape reserved characters in the pattern

Returns:

list of resources that match the query.

Throws:

org.apache.lucene.queryparser.classic.ParseException - when the resulting query is illegal.

findResources

public List<NonLiteral> findResources(UriRef property,
                             String pattern,
                             boolean escapePattern,
                             FacetCollector... facetCollectors)
                               throws org.apache.lucene.queryparser.classic.ParseException

Find resource with given property whose value matches a pattern and collect facets.

Parameters:

property - The property to which to apply the pattern.

pattern - The pattern from which to construct a query.

escapePattern - whether to escape reserved characters in the pattern

facetCollectors - facet collectors to apply to the query result.

Returns:

a list of resources that match the query.

Throws:

org.apache.lucene.queryparser.classic.ParseException - when the resulting query is illegal.

findResources

public List<NonLiteral> findResources(UriRef property,
                             String pattern,
                             boolean escapePattern,
                             SortSpecification sortSpecification,
                             FacetCollector... facetCollectors)
                               throws org.apache.lucene.queryparser.classic.ParseException

Find resource with given property whose value matches a pattern and sort order and collect facets.

Parameters:

property - The property to which to apply the pattern.

pattern - The pattern from which to construct a query.

escapePattern - whether to escape reserved characters in the pattern

sortSpecification - specifies the sort order.

facetCollectors - facet collectors to apply to the query result.

Returns:

a list of resources that match the query.

Throws:

org.apache.lucene.queryparser.classic.ParseException - when the resulting query is illegal.

findResources

public List<NonLiteral> findResources(VirtualProperty property,
                             String pattern)
                               throws org.apache.lucene.queryparser.classic.ParseException

Find resource with given VirtualProperty whose value matches a pattern.

Parameters:

property - The property to which to apply the pattern.

pattern - The pattern from which to construct a query.

Returns:

a list of resources that match the query.

Throws:

org.apache.lucene.queryparser.classic.ParseException - when the resulting query is illegal.

findResources

public List<NonLiteral> findResources(VirtualProperty property,
                             String pattern,
                             boolean escapePattern)
                               throws org.apache.lucene.queryparser.classic.ParseException

Find resource with given VirtualProperty whose value matches a pattern.

Parameters:

property - The property to which to apply the pattern.

pattern - The pattern from which to construct a query.

escapePattern - whether to escape reserved characters in the pattern

Returns:

a list of resources that match the query.

Throws:

org.apache.lucene.queryparser.classic.ParseException - when the resulting query is illegal.

findResources

public List<NonLiteral> findResources(VirtualProperty property,
                             String pattern,
                             boolean escapePattern,
                             FacetCollector... facetCollectors)
                               throws org.apache.lucene.queryparser.classic.ParseException

Find resource with given VirtualProperty whose value matches a pattern and collect facets.

Parameters:

property - The property to which to apply the pattern.

pattern - The pattern from which to construct a query.

escapePattern - whether to escape reserved characters in the pattern

facetCollectors - facet collectors to apply to the query result.

Returns:

a list of resources that match the query.

Throws:

org.apache.lucene.queryparser.classic.ParseException - when the resulting query is illegal.

findResources

public List<NonLiteral> findResources(VirtualProperty property,
                             String pattern,
                             boolean escapePattern,
                             SortSpecification sortSpecification,
                             FacetCollector... facetCollectors)
                               throws org.apache.lucene.queryparser.classic.ParseException

Find resource with given VirtualProperty whose value matches a pattern and sort specification and collect facets.

Parameters:

property - The property to which to apply the pattern.

pattern - The pattern from which to construct a query.

escapePattern - whether to escape reserved characters in the pattern

sortSpecification - specifies the sort order.

facetCollectors - facet collectors to apply to the query result.

Returns:

a list of resources that match the query.

Throws:

org.apache.lucene.queryparser.classic.ParseException - when the resulting query is illegal.