org.exist.xmldb
Class RemoteIndexQueryService

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

All Implemented Interfaces:

IndexQueryService, Configurable, Service

public class RemoteIndexQueryService
extends Object
implements IndexQueryService

Constructor Summary

RemoteIndexQueryService(org.apache.xmlrpc.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() Returns the name associated with the Service instance.
String	getProperty(String name) Returns the value of the property identified by name.
String	getVersion() Gets the Version attribute of the Service object
void	reindexCollection() Reindex the current collection, i.e.
void	reindexCollection(String collectionPath) Reindex the collection specified by its path.
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(Collection col) Sets the Collection attribute of the Service object
void	setProperty(String name, String value) Sets the property name to have the value provided in value.

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteIndexQueryService

public RemoteIndexQueryService(org.apache.xmlrpc.XmlRpcClient client,
                               RemoteCollection 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

See Also:

IndexQueryService.reindexCollection()

reindexCollection

public void reindexCollection(String collectionPath)
                       throws XMLDBException

Description copied from interface: IndexQueryService

Reindex the collection specified by its path.

Specified by:

reindexCollection in interface IndexQueryService

Throws:

XMLDBException

reindexCollection

public void reindexCollection(XmldbURI collectionPath)
                       throws XMLDBException

Description copied from interface: IndexQueryService

Reindex the collection specified by its path.

Specified by:

reindexCollection 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

Throws:

XMLDBException

scanIndexTerms

public Occurrences[] scanIndexTerms(String start,
                                    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 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:

XMLDBException

scanIndexTerms

public Occurrences[] scanIndexTerms(String xpath,
                                    String start,
                                    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 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:

XMLDBException

getName

public String getName()
               throws XMLDBException

Description copied from interface: Service

Returns the name associated with the Service instance.

Specified by:

getName in interface Service

Returns:

the name of the object.

Throws:

XMLDBException - with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.

getVersion

public String getVersion()
                  throws XMLDBException

Description copied from interface: Service

Gets the Version attribute of the Service object

Specified by:

getVersion in interface Service

Returns:

The Version value

Throws:

XMLDBException - with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.

setCollection

public void setCollection(Collection col)
                   throws XMLDBException

Description copied from interface: Service

Sets the Collection attribute of the Service object

Specified by:

setCollection in interface Service

Parameters:

col - The new Collection value

Throws:

XMLDBException - with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.

getProperty

public String getProperty(String name)
                   throws XMLDBException

Description copied from interface: Configurable

Returns the value of the property identified by name.

Specified by:

getProperty in interface Configurable

Parameters:

name - the name of the property to retrieve.

Returns:

the property value or null if no property exists.

Throws:

XMLDBException - with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.

setProperty

public void setProperty(String name,
                        String value)
                 throws XMLDBException

Description copied from interface: Configurable

Sets the property name to have the value provided in value.

Specified by:

setProperty in interface Configurable

Parameters:

name - the name of the property to set.

value - the value to set for the property.

Throws:

XMLDBException - with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.

configureCollection

public void configureCollection(String configData)
                         throws XMLDBException

Specified by:

configureCollection in interface IndexQueryService

Throws:

XMLDBException