org.exist.xmldb
Class RemoteIndexQueryService

java.lang.Object
  org.exist.xmldb.RemoteIndexQueryService

All Implemented Interfaces:

IndexQueryService, org.xmldb.api.base.Configurable, org.xmldb.api.base.Service

public class RemoteIndexQueryService
extends Object
implements IndexQueryService

Constructor Summary

RemoteIndexQueryService(XmlRpcClient client, RemoteCollection parent)

Method Summary

void	configureCollection(String configData)
Occurrences[]	getIndexedElements(boolean inclusive) Returns frequency statistics on all elements and attributes contained in the structure index for the current collection.
String	getName()
String	getProperty(String name)
String	getVersion()
void	reindexCollection() Reindex the current collection, i.e.
void	reindexCollection(String collectionPath) Deprecated. Use XmldbURI version instead
void	reindexCollection(XmldbURI collectionPath) Reindex the collection specified by its path.
Occurrences[]	scanIndexTerms(String start, String end, boolean inclusive) Queries the fulltext index to retrieve information on indexed words contained in the index for the current collection.
Occurrences[]	scanIndexTerms(String xpath, String start, 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(org.xmldb.api.base.Collection col)
void	setProperty(String name, String value)

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteIndexQueryService

public RemoteIndexQueryService(XmlRpcClient client,
                               RemoteCollection parent)

Method Detail

reindexCollection

public void reindexCollection()
                       throws org.xmldb.api.base.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:

org.xmldb.api.base.XMLDBException

See Also:

IndexQueryService.reindexCollection()

reindexCollection

public void reindexCollection(String collectionPath)
                       throws org.xmldb.api.base.XMLDBException

Deprecated. Use XmldbURI version instead

(non-Javadoc)

Specified by:

reindexCollection in interface IndexQueryService

Throws:

org.xmldb.api.base.XMLDBException

See Also:

IndexQueryService.reindexCollection(java.lang.String)

reindexCollection

public void reindexCollection(XmldbURI collectionPath)
                       throws org.xmldb.api.base.XMLDBException

Description copied from interface: IndexQueryService

Reindex the collection specified by its path.

Specified by:

reindexCollection in interface IndexQueryService

Throws:

org.xmldb.api.base.XMLDBException

getIndexedElements

public Occurrences[] getIndexedElements(boolean inclusive)
                                 throws org.xmldb.api.base.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

Throws:

org.xmldb.api.base.XMLDBException

scanIndexTerms

public Occurrences[] scanIndexTerms(String start,
                                    String end,
                                    boolean inclusive)
                             throws org.xmldb.api.base.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 param end is null, all words starting with the string sequence param start are returned. Otherwise, the method returns all words that come after start and before end in lexical order.

Specified by:

scanIndexTerms in interface IndexQueryService

Throws:

org.xmldb.api.base.XMLDBException

scanIndexTerms

public Occurrences[] scanIndexTerms(String xpath,
                                    String start,
                                    String end)
                             throws org.xmldb.api.base.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 param end is null, all words starting with the string sequence param start are returned. Otherwise, the method returns all words that come after start and before end in lexical order.

Specified by:

scanIndexTerms in interface IndexQueryService

Throws:

org.xmldb.api.base.XMLDBException

getName

public String getName()
               throws org.xmldb.api.base.XMLDBException

Specified by:

getName in interface org.xmldb.api.base.Service

Throws:

org.xmldb.api.base.XMLDBException

getVersion

public String getVersion()
                  throws org.xmldb.api.base.XMLDBException

Specified by:

getVersion in interface org.xmldb.api.base.Service

Throws:

org.xmldb.api.base.XMLDBException

setCollection

public void setCollection(org.xmldb.api.base.Collection col)
                   throws org.xmldb.api.base.XMLDBException

Specified by:

setCollection in interface org.xmldb.api.base.Service

Throws:

org.xmldb.api.base.XMLDBException

getProperty

public String getProperty(String name)
                   throws org.xmldb.api.base.XMLDBException

Specified by:

getProperty in interface org.xmldb.api.base.Configurable

Throws:

org.xmldb.api.base.XMLDBException

setProperty

public void setProperty(String name,
                        String value)
                 throws org.xmldb.api.base.XMLDBException

Specified by:

setProperty in interface org.xmldb.api.base.Configurable

Throws:

org.xmldb.api.base.XMLDBException

configureCollection

public void configureCollection(String configData)
                         throws org.xmldb.api.base.XMLDBException

Specified by:

configureCollection in interface IndexQueryService

Throws:

org.xmldb.api.base.XMLDBException