org.exist.xmldb
Class LocalIndexQueryService

java.lang.Object
  extended by org.exist.xmldb.LocalIndexQueryService
All Implemented Interfaces:
IndexQueryService, Configurable, Service

public class LocalIndexQueryService
extends Object
implements IndexQueryService


Constructor Summary
LocalIndexQueryService(Subject user, BrokerPool pool, LocalCollection 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. the collection from which this service has been retrieved.
 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(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

LocalIndexQueryService

public LocalIndexQueryService(Subject 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(String collectionPath)
                       throws XMLDBException
Deprecated. Use XmldbURI version instead

(non-Javadoc)

Specified by:
reindexCollection in interface IndexQueryService
Throws:
XMLDBException
See Also:
IndexQueryService.reindexCollection(java.lang.String)

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

configureCollection

public void configureCollection(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
Throws:
XMLDBException

getName

public String getName()
               throws XMLDBException
Specified by:
getName in interface Service
Throws:
XMLDBException

getVersion

public String getVersion()
                  throws XMLDBException
Specified by:
getVersion in interface Service
Throws:
XMLDBException

setCollection

public void setCollection(Collection col)
                   throws XMLDBException
Specified by:
setCollection in interface Service
Throws:
XMLDBException

getProperty

public String getProperty(String name)
                   throws XMLDBException
Specified by:
getProperty in interface Configurable
Throws:
XMLDBException

setProperty

public void setProperty(String name,
                        String value)
                 throws XMLDBException
Specified by:
setProperty in interface Configurable
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


Copyright (C) The eXist-db Project. All rights reserved.