org.exist.xmldb
Class LocalIndexQueryService

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

public class LocalIndexQueryService
extends java.lang.Object
implements IndexQueryService

Author:
wolf To change this generated comment go to Window>Preferences>Java>Code Generation>Code and Comments

Constructor Summary
LocalIndexQueryService(User user, BrokerPool pool, LocalCollection parent)
           
 
Method Summary
 Occurrences[] getIndexedElements(boolean inclusive)
           
 java.lang.String getName()
          Returns the name associated with the Service instance.
 java.lang.String getProperty(java.lang.String name)
          Returns the value of the property identified by name.
 java.lang.String getVersion()
          Gets the Version attribute of the Service object
 Occurrences[] scanIndexTerms(java.lang.String start, java.lang.String end, boolean inclusive)
           
 void setCollection(Collection col)
          Sets the Collection attribute of the Service object
 void setProperty(java.lang.String name, java.lang.String value)
          Sets the property name to have the value provided in 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

getIndexedElements

public Occurrences[] getIndexedElements(boolean inclusive)
                                 throws XMLDBException
Specified by:
getIndexedElements in interface IndexQueryService
Throws:
XMLDBException

getName

public java.lang.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 java.lang.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 java.lang.String getProperty(java.lang.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(java.lang.String name,
                        java.lang.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.

scanIndexTerms

public Occurrences[] scanIndexTerms(java.lang.String start,
                                    java.lang.String end,
                                    boolean inclusive)
                             throws XMLDBException
Specified by:
scanIndexTerms in interface IndexQueryService
Throws:
XMLDBException


Copyright (C) Wolfgang Meier. All rights reserved.