ESciDoc Services Search&Export

ID (Label)
SE

Complete Name
Search&Export Service

Status
Implemented

Description
This service enables operations by which resources can be searched and exported in a desired output format. The services uses two different code modules:
 * The search module is responsible for the search logic
 * The search_presentation represents the web interface

The Search&Export service interface implements several operations:

Operations Overview
Input Parameters Description These are the parameters which can be set in the client request towards the servlet.

Output Data Description These are the possible return values from the servlet.

Snippet example This is an xml example of the snippet output format. This output format is used as a technical interface of the Search&Export service. In this example the search result consists of one item with one component attached.      hdl:someHandle/test/escidoc:5001:2      (2008). 					 tomsbuch.     <escidocMetadataRecords:md-record name="escidoc"> <escidocMetadataProfile:publication type="book"> <publication:creator role="editor"> <escidoc:person> <escidoc:complete-name /> <escidoc:family-name>tom</escidoc:family-name> <escidoc:given-name>endres</escidoc:given-name> <escidoc:organization> <escidoc:organization-name>orgi</escidoc:organization-name> <escidoc:address /> <escidoc:identifier>escidoc:persistent22</escidoc:identifier> </escidoc:organization> </escidoc:person> </publication:creator> <dc:title>tomsbuch</dc:title> <dcterms:created xsi:type="dcterms:W3CDTF" /> <dcterms:modified xsi:type="dcterms:W3CDTF" /> <dcterms:dateSubmitted xsi:type="dcterms:W3CDTF" /> <dcterms:dateAccepted xsi:type="dcterms:W3CDTF" /> <publication:published-online xsi:type="dcterms:W3CDTF" /> <dcterms:issued xsi:type="dcterms:W3CDTF">2008</dcterms:issued> <publication:total-number-of-pages /> <dc:subject /> <dcterms:tableOfContents /> </escidocMetadataProfile:publication> </escidocMetadataRecords:md-record> </escidocMetadataRecords:md-records> <escidocComponents:components> <escidocComponents:component objid="escidoc:5002"> <escidocComponents:properties> <prop:creation-date>2008-12-16T16:45:35.106Z</prop:creation-date> <prop:description>ein netter volltext</prop:description> <prop:valid-status>valid</prop:valid-status> <prop:visibility>public</prop:visibility> <prop:content-category>any-fulltext</prop:content-category> <prop:file-name>test.txt</prop:file-name> <prop:mime-type>text/html</prop:mime-type> </escidocComponents:properties> <escidocComponents:content storage="internal-managed" xlink:href="http://framework:8080/ir/item/escidoc:5001/components/component/escidoc:5002/content" /> <escidocMetadataRecords:md-records> <escidocMetadataRecords:md-record name="escidoc"> <file:file> <dc:title>test.txt</dc:title> <dc:description>ein netter volltext</dc:description> <dc:format xsi:type="dcterms:IMT">text/html</dc:format> <dcterms:extent>53</dcterms:extent> </file:file> </escidocMetadataRecords:md-record> </escidocMetadataRecords:md-records> </escidocComponents:component> </escidocComponents:components> </escidocItem:item> </escidocItemList:item-list>

Sample Servlet call Here you can see a sample call to the Search&Export service. As you can see all the parameters are part of the GET query. http://localhost:8080/search/SearchAndExport?cqlQuery=escidoc.metadata="test"&exportFormat=APA&outputFormat=snippet&language=all&sortKeys=sort.escidoc.publication.title&sortOrder=descending&startRecord=2&maximumRecords=5