Difference between revisions of "XML Indexer"
From Gcube Wiki
(→Implementation Overview) |
(→Implementation Overview) |
||
| Line 9: | Line 9: | ||
** '''<tt>AddElements(Documents[]) --> void</tt>'''<br>This operation take a list of Documents and adds them to the current collection in exist1.1 DB. A Document is a pair of id and a String representation of the XMLDocument. This operation can be used to update elements already stored given the same id of an existing document.<br> | ** '''<tt>AddElements(Documents[]) --> void</tt>'''<br>This operation take a list of Documents and adds them to the current collection in exist1.1 DB. A Document is a pair of id and a String representation of the XMLDocument. This operation can be used to update elements already stored given the same id of an existing document.<br> | ||
** '''<tt>AddElementsRS(String) --> void</tt>'''<br>This operation take a string representing a reference to a RSLocator <tt>(see ResultSetService)</tt>. The AddElementRS create a RSReader and stores the element readed in exist1.1 DB.<br> | ** '''<tt>AddElementsRS(String) --> void</tt>'''<br>This operation take a string representing a reference to a RSLocator <tt>(see ResultSetService)</tt>. The AddElementRS create a RSReader and stores the element readed in exist1.1 DB.<br> | ||
| − | ** '''<tt>ExecuteXPath(string) --> string[]</tt>'''<br>This operation take a string representing the XPath. It executes the | + | ** '''<tt>ExecuteXPath(string) --> string[]</tt>'''<br>This operation take a string representing the XPath. It executes the given XPath on the current collection.<br> |
| − | ** '''<tt>ExecuteXPath(string) --> string</tt>'''<br>This operation take a string representing the XPath. It executes the XPath given on the current collection and return a string representing a reference to RSLocator <tt>(see ResultSetService)</tt>. | + | ** '''<tt>ExecuteXPath(string) --> string</tt>'''<br>This operation take a string representing the XPath. It executes the given XPath on the current collection and return a string representing a reference to RSLocator <tt>(see ResultSetService)</tt>. |
| + | ** '''<tt>ExecuteXQuery(string) --> string[]</tt>'''<br>This operation take a string representing the XQuery. It executes the given XQuery on the current collection and return an array of string.<br> | ||
| + | ** '''<tt>ExecuteXPathRS(string) --> string</tt>'''<br>This operation take a string representing the XQuery. It executes the given XQuery on the current collection and return a string representing a reference to RSLocator <tt>(see ResultSetService)</tt>.<br> | ||
=== Dependencies === | === Dependencies === | ||
=== Usage Examples === | === Usage Examples === | ||
Revision as of 10:13, 20 April 2007
Introduction
The XMLIndexer factory Service allow to create a GenericXMLIndexerService and a MetadataXMLIndexerService. The GenericXMLIndexerService is not implemented yet. A MetadataXMLIndexer operate over a collection of homogeneus XML documents bound to a specific MetadataCollection, this indexer can be populated, updated, recreated and queried.
Implementation Overview
XMLIndexer consist of two parts:
- MetadataXMLIndexer
MetadataXMLIndexer provides the functionalities to retrieve, update, store MetadataElements into Metadata Collections.
The Service expose the following operations:
- AddElements(Documents[]) --> void
This operation take a list of Documents and adds them to the current collection in exist1.1 DB. A Document is a pair of id and a String representation of the XMLDocument. This operation can be used to update elements already stored given the same id of an existing document. - AddElementsRS(String) --> void
This operation take a string representing a reference to a RSLocator (see ResultSetService). The AddElementRS create a RSReader and stores the element readed in exist1.1 DB.
- ExecuteXPath(string) --> string[]
This operation take a string representing the XPath. It executes the given XPath on the current collection. - ExecuteXPath(string) --> string
This operation take a string representing the XPath. It executes the given XPath on the current collection and return a string representing a reference to RSLocator (see ResultSetService). - ExecuteXQuery(string) --> string[]
This operation take a string representing the XQuery. It executes the given XQuery on the current collection and return an array of string. - ExecuteXPathRS(string) --> string
This operation take a string representing the XQuery. It executes the given XQuery on the current collection and return a string representing a reference to RSLocator (see ResultSetService).
- AddElements(Documents[]) --> void
