org.eclipse.smila.search.api.internal

Class SearchServiceImpl

java.lang.Object

org.eclipse.smila.search.api.internal.SearchServiceImpl

All Implemented Interfaces:

SearchService

public class SearchServiceImpl
extends java.lang.Object
implements SearchService

SearchService implementation to be used as a Declarative Service. The connection to a WorkflowProcessor is also setup using a DS service reference.

Author:

jschumacher

Field Summary

Fields inherited from interface org.eclipse.smila.search.api.SearchService

NAMESPACE_SEARCH, TAG_DETAILS, TAG_ERROR, TAG_MESSAGE, TAG_SCRIPT_NAME, TAG_SEARCHRESULT, TAG_WORKFLOWNAME

Constructor Summary

Constructors

Constructor and Description
SearchServiceImpl() create instance.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	activate(ComponentContext context)
protected void	deactivate(ComponentContext context) OSGi Declarative Services service deactivation method.
Record	search(java.lang.String workflowName, Record query) Execute a query using the named workflow and create a SearchResult from the workflow result.
org.w3c.dom.Document	searchAsXml(java.lang.String workflowName, Record query) Execute a query using the named workflow and return the search result as an XML document.
java.lang.String	searchAsXmlString(java.lang.String workflowName, Record query) Execute a query using the named workflow and return the search result as an XML string.
java.lang.String	searchAsXmlStringWithScript(java.lang.String scriptAndFunction, Record query) Execute a query using the named script and return the search result as an XML string.
org.w3c.dom.Document	searchAsXmlWithScript(java.lang.String scriptAndFunction, Record query) Execute a query using the named script and return the search result as an XML document.
Record	searchWithScript(java.lang.String scriptAndFunction, Record record) Execute a query using the named script and create a SearchResult from the script result.
void	setBlackboardFactory(BlackboardFactory factory) set blackboard factory reference (used by DS).
void	setProcessor(WorkflowProcessor processor) set workflow processor reference (used by DS).
void	setScriptingEngine(ScriptingEngine scriptingEngine) set OSGI service.
void	unsetBlackboardFactory(BlackboardFactory factory) remove blackboard factory reference (used by DS).
void	unsetProcessor(WorkflowProcessor processor) remove workflow processor reference (used by DS).
void	unsetScriptingEngine(ScriptingEngine scriptingEngine) unset OSGI service.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchServiceImpl

public SearchServiceImpl()

create instance.

Method Detail

search

public Record search(java.lang.String workflowName,
            Record query)
              throws ProcessingException

Execute a query using the named workflow and create a SearchResult from the workflow result.

Specified by:

search in interface SearchService

Parameters:

workflowName - name of workflow to process the search.

query - query object describing the search.

Returns:

search result record

Throws:

ProcessingException - error while processing the request or preparing the input message or search result.

searchAsXml

public org.w3c.dom.Document searchAsXml(java.lang.String workflowName,
                               Record query)
                                 throws javax.xml.parsers.ParserConfigurationException

Execute a query using the named workflow and return the search result as an XML document.

Specified by:

searchAsXml in interface SearchService

Parameters:

workflowName - name of workflow to process the search.

query - query object describing the search.

Returns:

search result as DOM document, or description of ProcessingException

Throws:

javax.xml.parsers.ParserConfigurationException - error creating the XML result.

See Also:

org.eclipse.smila.search.api.SearchService#xmlSearch(java.lang.String, org.eclipse.smila.datamodel.record.Record)

searchAsXmlString

public java.lang.String searchAsXmlString(java.lang.String workflowName,
                                 Record query)
                                   throws javax.xml.parsers.ParserConfigurationException

Execute a query using the named workflow and return the search result as an XML string.

Specified by:

searchAsXmlString in interface SearchService

Parameters:

workflowName - name of workflow to process the search.

query - query object describing the search.

Returns:

search result as XML string, or description of ProcessingException

Throws:

javax.xml.parsers.ParserConfigurationException - error creating the XML result.

See Also:

org.eclipse.smila.search.api.SearchService#searchAsXmlString(java.lang.String, org.eclipse.smila.datamodel.record.Record)

searchWithScript

public Record searchWithScript(java.lang.String scriptAndFunction,
                      Record record)
                        throws ProcessingException

Execute a query using the named script and create a SearchResult from the script result.

Specified by:

searchWithScript in interface SearchService

Parameters:

scriptAndFunction - name of the script function to process the search (e.g. search.process)

record - query object describing the search.

Returns:

search result record

Throws:

ProcessingException - error while processing the request or preparing the input message or search result.

See Also:

SearchService.searchWithScript(String scriptAndFunction, Record record)

searchAsXmlWithScript

public org.w3c.dom.Document searchAsXmlWithScript(java.lang.String scriptAndFunction,
                                         Record query)
                                           throws javax.xml.parsers.ParserConfigurationException

Execute a query using the named script and return the search result as an XML document.

Specified by:

searchAsXmlWithScript in interface SearchService

Parameters:

scriptAndFunction - name of the script function to process the search (e.g. search.process)

query - query object describing the search.

Returns:

search result as DOM document, or description of ProcessingException

Throws:

javax.xml.parsers.ParserConfigurationException - error creating the XML result.

See Also:

org.eclipse.smila.search.api.SearchService#searchAsXmlWithScript(final String scriptAndFunction, Record query)

searchAsXmlStringWithScript

public java.lang.String searchAsXmlStringWithScript(java.lang.String scriptAndFunction,
                                           Record query)
                                             throws javax.xml.parsers.ParserConfigurationException

Execute a query using the named script and return the search result as an XML string.

Specified by:

searchAsXmlStringWithScript in interface SearchService

Parameters:

scriptAndFunction - name of the script function to process the search (e.g. search.process)

query - query object describing the search.

Returns:

search result as XML string, or description of ProcessingException

Throws:

javax.xml.parsers.ParserConfigurationException - error creating the XML result.

See Also:

SearchService.searchAsXmlStringWithScript(String scriptAndFunction, Record query)

activate

protected void activate(ComponentContext context)

deactivate

protected void deactivate(ComponentContext context)

OSGi Declarative Services service deactivation method.

Parameters:

context - OSGi service component context.

setProcessor

public void setProcessor(WorkflowProcessor processor)

set workflow processor reference (used by DS).

Parameters:

processor - workflow processor

unsetProcessor

public void unsetProcessor(WorkflowProcessor processor)

remove workflow processor reference (used by DS).

Parameters:

processor - workflow processor

setBlackboardFactory

public void setBlackboardFactory(BlackboardFactory factory)

set blackboard factory reference (used by DS).

Parameters:

factory - blackboard factory

unsetBlackboardFactory

public void unsetBlackboardFactory(BlackboardFactory factory)

remove blackboard factory reference (used by DS).

Parameters:

factory - blackboard factory

setScriptingEngine

public void setScriptingEngine(ScriptingEngine scriptingEngine)

set OSGI service.

unsetScriptingEngine

public void unsetScriptingEngine(ScriptingEngine scriptingEngine)

unset OSGI service.