org.exist.xmldb
Class LocalIndexQueryService

java.lang.Object
  org.exist.xmldb.LocalIndexQueryService

All Implemented Interfaces:

IndexQueryService

public class LocalIndexQueryService

extends java.lang.Object

implements IndexQueryService

Constructor Summary

LocalIndexQueryService(User user, BrokerPool pool, LocalCollection parent)

Method Summary

void	configureCollection(java.lang.String configData)
Occurrences[]	getIndexedElements(boolean inclusive) Returns frequency statistics on all elements and attributes contained in the structure index for the current collection.
java.lang.String	getName()
java.lang.String	getProperty(java.lang.String name)
java.lang.String	getVersion()
void	reindexCollection() Reindex the current collection, i.e.
void	reindexCollection(java.lang.String collectionPath) Reindex the collection specified by its path.
Occurrences[]	scanIndexTerms(java.lang.String start, java.lang.String end, boolean inclusive) Queries the fulltext index to retrieve information on indexed words contained in the index for the current collection.
Occurrences[]	scanIndexTerms(java.lang.String xpath, java.lang.String start, java.lang.String end) Queries the fulltext index to retrieve information on indexed words occurring within the set of nodes identified by a given XPath expression.
void	setCollection(Collection col)
void	setProperty(java.lang.String name, java.lang.String value)

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalIndexQueryService

public LocalIndexQueryService(User user,
                              BrokerPool pool,
                              LocalCollection parent)

Method Detail

reindexCollection

public void reindexCollection()
                       throws XMLDBException

Description copied from interface: IndexQueryService

Reindex the current collection, i.e. the collection from which this service has been retrieved.

Specified by:

reindexCollection in interface IndexQueryService

Throws:

XMLDBException

reindexCollection

public void reindexCollection(java.lang.String collectionPath)
                       throws XMLDBException

Description copied from interface: IndexQueryService

Reindex the collection specified by its path.

Specified by:

reindexCollection in interface IndexQueryService

Parameters:

collectionPath -

Throws:

XMLDBException

configureCollection

public void configureCollection(java.lang.String configData)
                         throws XMLDBException

Specified by:

configureCollection in interface IndexQueryService

Throws:

XMLDBException

getIndexedElements

public Occurrences[] getIndexedElements(boolean inclusive)
                                 throws XMLDBException

Description copied from interface: IndexQueryService

Returns frequency statistics on all elements and attributes contained in the structure index for the current collection.

Specified by:

getIndexedElements in interface IndexQueryService

Parameters:

inclusive -

Returns:

Throws:

XMLDBException

getName

public java.lang.String getName()
                         throws XMLDBException

Throws:

XMLDBException

getVersion

public java.lang.String getVersion()
                            throws XMLDBException

Throws:

XMLDBException

setCollection

public void setCollection(Collection col)
                   throws XMLDBException

Throws:

XMLDBException

getProperty

public java.lang.String getProperty(java.lang.String name)
                             throws XMLDBException

Throws:

XMLDBException

setProperty

public void setProperty(java.lang.String name,
                        java.lang.String value)
                 throws XMLDBException

Throws:

XMLDBException

scanIndexTerms

public Occurrences[] scanIndexTerms(java.lang.String start,
                                    java.lang.String end,
                                    boolean inclusive)
                             throws XMLDBException

Description copied from interface: IndexQueryService

Queries the fulltext index to retrieve information on indexed words contained in the index for the current collection. Returns a list of Occurrences for all words contained in the index. If is null, all words starting with the string sequence are returned. Otherwise, the method returns all words that come after start and before end in lexical order.

Specified by:

scanIndexTerms in interface IndexQueryService

Parameters:

start -

end -

inclusive -

Returns:

Throws:

XMLDBException

scanIndexTerms

public Occurrences[] scanIndexTerms(java.lang.String xpath,
                                    java.lang.String start,
                                    java.lang.String end)
                             throws XMLDBException

Description copied from interface: IndexQueryService

Queries the fulltext index to retrieve information on indexed words occurring within the set of nodes identified by a given XPath expression. Returns a list of Occurrences for all words contained in the index. If is null, all words starting with the string sequence are returned. Otherwise, the method returns all words that come after start and before end in lexical order.

Specified by:

scanIndexTerms in interface IndexQueryService

Parameters:

start -

end -

Returns:

Throws:

XMLDBException