|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.exist.xmldb.LocalIndexQueryService
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()
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 |
void |
reindexCollection()
Reindex the current collection, i.e. |
void |
reindexCollection(java.lang.String collectionPath)
Reindex the collection specified by its path. |
void |
reindexCollection(XmldbURI 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)
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 |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public LocalIndexQueryService(User user, BrokerPool pool, LocalCollection parent)
Method Detail |
public void reindexCollection() throws XMLDBException
IndexQueryService
reindexCollection
in interface IndexQueryService
XMLDBException
public void reindexCollection(java.lang.String collectionPath) throws XMLDBException
IndexQueryService
reindexCollection
in interface IndexQueryService
collectionPath
-
XMLDBException
public void reindexCollection(XmldbURI collectionPath) throws XMLDBException
IndexQueryService
reindexCollection
in interface IndexQueryService
collectionPath
-
XMLDBException
public void configureCollection(java.lang.String configData) throws XMLDBException
configureCollection
in interface IndexQueryService
XMLDBException
public Occurrences[] getIndexedElements(boolean inclusive) throws XMLDBException
IndexQueryService
getIndexedElements
in interface IndexQueryService
inclusive
-
XMLDBException
public java.lang.String getName() throws XMLDBException
Service
getName
in interface Service
XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.public java.lang.String getVersion() throws XMLDBException
Service
getVersion
in interface Service
XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.public void setCollection(Collection col) throws XMLDBException
Service
setCollection
in interface Service
col
- The new Collection value
XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.public java.lang.String getProperty(java.lang.String name) throws XMLDBException
Configurable
name
.
getProperty
in interface Configurable
name
- the name of the property to retrieve.
XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.public void setProperty(java.lang.String name, java.lang.String value) throws XMLDBException
Configurable
name
to have the value provided in
value
.
setProperty
in interface Configurable
name
- the name of the property to set.value
- the value to set for the property.
XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.public Occurrences[] scanIndexTerms(java.lang.String start, java.lang.String end, boolean inclusive) throws XMLDBException
IndexQueryService
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.
scanIndexTerms
in interface IndexQueryService
start
- end
- inclusive
-
XMLDBException
public Occurrences[] scanIndexTerms(java.lang.String xpath, java.lang.String start, java.lang.String end) throws XMLDBException
IndexQueryService
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.
scanIndexTerms
in interface IndexQueryService
xpath
- start
- end
-
XMLDBException
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |