Skip navigation links

oracle.search.query.webservice.wssclient
Interface OracleSearchPort

public interface OracleSearchPort

A client interface to the Query API Web Service operations. See OracleQueryService for an example of obtaining an OracleSearchPort from an OracleQueryService.

This service supports identity propagation with Oracle WSM policy oracle/wss10_saml_token_service_policy. The client must have oracle/wss10_saml_token_client_policy attached to send out the identity of the user making request.

The following example creates a query web source client:

     // Get OracleQueryService from the Web service URL
     java.net.URL webServiceURL = new URL("http://localhost:8001/search/api/wss/query/OracleSearch");
     javax.xml.namespace.QName qname = new QName("http://search.oracle.com/Query", "OracleQueryService");
     OracleQueryService queryService = new OracleQueryService(webServiceURL, qname);

     // configure OWSM policy if not attached externally
     weblogic.wsee.jws.jaxws.owsm.SecurityPolicyFeature[] securityFeature = new SecurityPolicyFeature[] {
     new SecurityPolicyFeature("policy:oracle/wss10_saml_token_client_policy") };

     // obtain OracleSearchPort from OracleQueryService
     OracleSearchPort searchPort = queryService.getQuery(securityFeature);

    // Perform a basic search
    OracleSearchResult result =
          searchPort.doOracleSimpleSearch("oracle",        // query string
                                    new Integer(1),  // start index
                                    new Integer(10), // doc requested
                                    Boolean.FALSE,   // duplicate removed
                                    Boolean.FALSE,   // duplicate marked
                                    Boolean.TRUE);   // return estimated hit count

    // Get estimated hit count
    int estimatedHitCount = result.getEstimatedHitCount().intValue();

    // Process result
    ResultElement[] resElements = result.getResultElements();
    for(int i = 0; i ≶ resElements.length; i++)
    {
      System.out.println("Title : " + resElements[i].getTitle());
      System.out.println("Snippet : " + resElements[i].getSnippet());
      System.out.println("URL : " + resElements[i].getUrl()());
    }
 

See Also:

OracleQueryService

Method Summary

OracleSearchResult	doOracleAdvancedSearch(String query, Integer startIndex, Integer docsRequested, Boolean dupRemoved, Boolean dupMarked, List groups, String queryLang, String docLang, Boolean returnCount, String filterConnector, List filters, List fetchAttributes, String searchControls) Invokes Oracle SES advanced search and returns search results.
OracleSearchResult	doOracleBrowseSearch(String query, String nodeID, String fedID, Integer startIndex, Integer docsRequested, Boolean dupRemoved, Boolean dupMarked, String queryLang, String docLang, Boolean returnCount, List fetchAttributes) Invokes Oracle SES search, restricts the search to a particular infosource node and returns the search results.
OracleFacetResultContainer	doOracleFacetSearch(String query, Integer topN, Integer startIndex, Integer docsRequested, Boolean dupRemoved, Boolean dupMarked, List groups, String queryLang, String docLang, Boolean returnCount, String filterConnector, List filters, List fetchAttributeNames, GroupAttribute groupAttr, List sortAttrList, List clusterList, List facetPaths, Boolean returnFacetDocCount, Integer minFacetDocCount, Integer maxFacetChildren, String sortBy, String searchControls) Invokes Oracle SES facet search and returns search results and facet info.
OracleResultContainer	doOracleFetchSearch(String query, List targetDocIdList, Integer startIndex, Integer docsRequested, String queryLang, List fetchAttributeNames, GroupAttribute groupAttr, List sortAttrList, List clusterList) Invokes Oracle SES fetch search and returns fetch results.
OracleResultContainer	doOracleOrganizedSearch(String query, Integer topN, Integer startIndex, Integer docsRequested, Boolean dupRemoved, Boolean dupMarked, List groups, String queryLang, String docLang, Boolean returnCount, String filterConnector, List filters, List fetchAttributeNames, String searchControls, GroupAttribute groupAttr, List sortAttrList, List clusterList) Invokes Oracle SES organized search and returns search results.
OracleSearchResult	doOracleSearch(String query, Integer startIndex, Integer docsRequested, Boolean dupRemoved, Boolean dupMarked, List groups, String queryLang, String docLang, Boolean returnCount, String filterConnector, List filters, List fetchAttributes) Invokes Oracle SES search and returns search results.
OracleSearchResult	doOracleSimpleSearch(String query, Integer startIndex, Integer docsRequested, Boolean dupRemoved, Boolean dupMarked, Boolean returnCount) Invokes Oracle SES basic search returns search results.
List	getAllAttributes(String locale) Returns all the search attributes available in Oracle SES.
List	getAttributeLOV(Attribute att, String lang) Returns a list of value (LOV) for a given search attribute.
List	getAttributes(String locale, List groups, String groupConnector) Returns the list of search attributes that are applied to given source groups.
byte[]	getCachedPage(String query, Integer docID, String fedID) Returns cached HTML version of a document.
List	getDataGroups(String locale) Returns a list of all the source groups defined in Oracle SES.
List	getFacetNodes(List facetPaths, Boolean returnFacetDocCount, Integer minFacetDocCount, Integer maxFacetChildren, String sortBy, String locale, String searchControls) Get facet nodes.
List	getHitCounts(List queryList, List groups, String queryLang, String docLang, String filterConnector, List filters, Boolean exactCount, String searchControls) Return hit counts for a batch of SES queries.
List	getInfoSourceAncestorNodes(String nodeID, String locale) Returns a list of all the infosource nodes (ancestor nodes) in the full path from the root node to a given infosource node.
Node	getInfoSourceNode(String nodeID, String fedID, String locale) Returns an infosource node for a given node ID.
List	getInfoSourceNodes(String parentNodeID, String fedID, String locale) Returns all the children nodes of an infosource node.
List	getInLinks(Integer docID, Integer maxNum, String fedID) Returns a list of incoming links for a given document.
List	getLanguages(String locale) Returns all the languages supported by Oracle SES.
List	getOutLinks(Integer docID, Integer maxNum, String fedID) Returns a list of outgoing links for a given document.
List	getSuggestedContent(String query, String returnType) Invokes Oracle SES Suggested Content search only to get the suggested content for the query
String	logUserClick(Integer queryID, Integer urlID, Integer infoSourceID, Integer position, String fedID) Logs user's clicks on the search hits.
oracle.search.query.webservice.wssclient.StatsContainer	removeResults(List ids, String idType, String locale, String ctlParams) Deletes the specified document from the index
Status	setSessionContext(List sessionContext) Sets the session context to be used for query-time filtering.
Status	submitUrl(String url) Submits a URL for Oracle SES to crawl and index.

Method Detail

doOracleSearch

OracleSearchResult doOracleSearch(String query,
                                  Integer startIndex,
                                  Integer docsRequested,
                                  Boolean dupRemoved,
                                  Boolean dupMarked,
                                  List groups,
                                  String queryLang,
                                  String docLang,
                                  Boolean returnCount,
                                  String filterConnector,
                                  List filters,
                                  List fetchAttributes)
                                  throws oracle.search.query.webservice.wssclient.Exception_Exception

Invokes Oracle SES search and returns search results.

Parameters:

query - query string. The search string follows Oracle SES query syntax.

startIndex - index of the first document in the hit list to be returned. The default is 1 if not set explicitly.

docsRequested - maximum number of documents in the hit list to be returned. The default is 10 if not set explicitly.

dupRemoved - Boolean flag to enable or disable duplicate removal. If turned on, duplicate documents in the hit list will be removed. The default is false if not set explicitly. Note: The dupMarked switch has no effect when dupRemoved is turned on.

dupMarked - Boolean flag to enable or disable duplicate detection. The default is false if not set explicitly. Note: The dupMarked switch has no effect when dupRemoved is turned on.

groups - a list of data source groups that the search will be restricted to. The default is all groups if not set explicitly.

queryLang - language of the query. This is equivalent to Locale. The default is English ("en") if not set explicitly. queryLang is used in relevancy boosting.

docLang - language of the documents to restrict the search. If the value is not set explicitly, then search is performed against documents of all the languages.

returnCount - Boolean flag to fetch the total hit count with the result. The default is false if not set explicitly.

filterConnector - connector between all the filters. "and" indicates the documents in the hit list must satisfy all the filters. "or" indicates the documents in the hit list must satisfy at least one of the filters. The default is "and" if not set explicitly.

filters - a list of Filters. Each filter is a restriction on the search result. Filters are connected by the filterConnector. The default is null (no filter applies to the search result) if not set explicitly.

fetchAttributes - a list of Integers representing the IDs of custom or non-default attributes to be fetched with the search result.

Returns:

search results (OracleSearchResult)

Throws:

Exception - if any error occurs

oracle.search.query.webservice.wssclient.Exception_Exception

doOracleSimpleSearch

OracleSearchResult doOracleSimpleSearch(String query,
                                        Integer startIndex,
                                        Integer docsRequested,
                                        Boolean dupRemoved,
                                        Boolean dupMarked,
                                        Boolean returnCount)
                                        throws oracle.search.query.webservice.wssclient.Exception_Exception

Invokes Oracle SES basic search returns search results.

Parameters:

query - query string. The search string follows Oracle SES query syntax.

startIndex - index of the first document in the hit list to be returned. The default is 1 if not set explicitly.

docsRequested - maximum number of documents in the hit list to be returned. The default is 10 if not set explicitly.

dupRemoved - Boolean flag to enable or disable duplicate removal. If turned on, duplicate documents in the hit list will be removed. The default is false if not set explicitly. Note: The dupMarked switch will have no effext when dupRemoved is turned on.

dupMarked - Boolean flag to enable or disable duplicate detection. The default is false if not set explicitly. Note: The dupMarked switch has no effect when dupRemoved is turned on.

returnCount - Boolean flag indicating whether to fetch the total hit count with the result. The default is false if not set explicitly.

Returns:

search results (OracleSearchResult)

Throws:

Exception - if any error occurs

oracle.search.query.webservice.wssclient.Exception_Exception

doOracleAdvancedSearch

OracleSearchResult doOracleAdvancedSearch(String query,
                                          Integer startIndex,
                                          Integer docsRequested,
                                          Boolean dupRemoved,
                                          Boolean dupMarked,
                                          List groups,
                                          String queryLang,
                                          String docLang,
                                          Boolean returnCount,
                                          String filterConnector,
                                          List filters,
                                          List fetchAttributes,
                                          String searchControls)
                                          throws oracle.search.query.webservice.wssclient.Exception_Exception

Invokes Oracle SES advanced search and returns search results.

Parameters:

query - query string. The search string follows Oracle SES query syntax.

startIndex - index of the first document in the hit list to be returned. The default is 1 if not set explicitly.

docsRequested - maximum number of documents in the hit list to be returned. The default is 10 if not set explicitly.

dupRemoved - Boolean flag to enable or disable duplicate removal. If turned on, duplicate documents in the hit list will be removed. The default is false if not set explicitly. Note: The dupMarked switch has no effect when dupRemoved is turned on.

dupMarked - Boolean flag to enable or disable duplicate detection. The default is false if not set explicitly. Note: The dupMarked switch will have no effect when dupRemoved is turned on.

groups - a list of data source groups that the search will be restricted to. The default is all groups if not set explicitly.

queryLang - language of the query. This is equivalent to Locale. The default is English ("en") if not set explicitly. queryLang is used in relevancy boosting.

docLang - language of the documents to restrict the search. If the value is not set explicitly, then search is performed against documents of all the languages.

returnCount - Boolean flag to fetch the total hit count with the result. The default is false if not set explicitly.

filterConnector - connector between all the filters. "and" indicates the documents in the hit list must satisfy all the filters. "or" indicates the documents in the hit list must satisfy at least one of the filters. The default is "and" if not set explicitly.

filters - a list of Filters. Each filter is a restriction on the search result. Filters are connected by the filterConnector. The default is null (no filter applies to the search result) if not set explicitly.

fetchAttributes - a list of Integers representing the IDs of custom or non-default attributes to be fetched with the search result.

searchControls - XML string to specify advanced filter conditions and ranking parameters.

Returns:

search results (OracleSearchResult)

Throws:

Exception - if any error occurs

oracle.search.query.webservice.wssclient.Exception_Exception

doOracleOrganizedSearch

OracleResultContainer doOracleOrganizedSearch(String query,
                                              Integer topN,
                                              Integer startIndex,
                                              Integer docsRequested,
                                              Boolean dupRemoved,
                                              Boolean dupMarked,
                                              List groups,
                                              String queryLang,
                                              String docLang,
                                              Boolean returnCount,
                                              String filterConnector,
                                              List filters,
                                              List fetchAttributeNames,
                                              String searchControls,
                                              GroupAttribute groupAttr,
                                              List sortAttrList,
                                              List clusterList)
                                              throws oracle.search.query.webservice.wssclient.Exception_Exception

Invokes Oracle SES organized search and returns search results.

Parameters:

query - query string. The search string follows Oracle SES query syntax.

topN - top N search result for grouping, sorting, clustering.

startIndex - index of the first document in the hit list to be returned. The default is 1 if not set explicitly.

docsRequested - maximum number of documents in the hit list to be returned. The default is 10 if not set explicitly.

dupRemoved - Boolean flag to enable or disable duplicate removal. If turned on, duplicate documents in the hit list will be removed. The default is false if not set explicitly. Note: The dupMarked switch has no effect when dupRemoved is turned on.

dupMarked - Boolean flag to enable or disable duplicate detection. The default is false if not set explicitly. Note: The dupMarked switch has no effect when dupRemoved is turned on.

groups - a list of data source groups that the search will be restricted to. The default is all groups if not set explicitly.

queryLang - language of the query. This is equivalent to Locale. The default is English ("en") if not set explicitly. queryLang is used in relevancy boosting.

docLang - language of the documents to restrict the search. If the value is not set explicitly, then search is performed against documents of all the languages.

returnCount - Boolean flag to fetch the total hit count with the result. The default is false if not set explicitly.

filterConnector - connector between all the filters. "and" indicates the documents in the hit list must satisfy all the filters. "or" indicates the documents in the hit list must satisfy at least one of the filters. The default is "and" if not set explicitly.

filters - a list of Filters. Each filter is a restriction on on the search result. Filters are connected by the filterConnector. The default is null(no filter applies to the search result) if not set explicitly.

fetchAttributeNames - a list of names of custom or non-default attributes to be fetched with the search result.

searchControls - XML string to specify advanced filter conditions and ranking parameters.

groupAttr - attribute used for grouping.

sortAttrList - a list of sorting attribute setting.

clusterList - a list of cluster configurations.

Returns:

search results (OracleResultContainer)

Throws:

Exception - if any error occurs

oracle.search.query.webservice.wssclient.Exception_Exception

doOracleFetchSearch

OracleResultContainer doOracleFetchSearch(String query,
                                          List targetDocIdList,
                                          Integer startIndex,
                                          Integer docsRequested,
                                          String queryLang,
                                          List fetchAttributeNames,
                                          GroupAttribute groupAttr,
                                          List sortAttrList,
                                          List clusterList)
                                          throws oracle.search.query.webservice.wssclient.Exception_Exception

Invokes Oracle SES fetch search and returns fetch results.

Parameters:

query - query string. The search string should follow Oracle SES query syntax.

targetDocIdList - target doc id list, most likely comes from a cluster node

startIndex - index of the first document in the hit list to be returned. The default is 1 if not set explicitly.

docsRequested - maximum number of documents in the hit list to be returned. The default is 10 if not set explicitly.

queryLang - language of the query. This is equivalent to Locale. The default is English ("en") if not set explicitly. queryLang is used in relevancy boosting.

fetchAttributeNames - array of names of custom or non-default attributes to be fetched with the search result.

groupAttr - attribute used for grouping.

sortAttrList - a list of sorting attribute setting.

clusterList - a list of cluster configurations.

Returns:

search results (OracleResultContainer)

Throws:

Exception - if any error occurs

oracle.search.query.webservice.wssclient.Exception_Exception

getInLinks

List getInLinks(Integer docID,
                Integer maxNum,
                String fedID)
                throws oracle.search.query.webservice.wssclient.Exception_Exception

Returns a list of incoming links for a given document.

Parameters:

docID - ID of the document for which incoming links are returned.

maxNum - maximum number of incoming links to be returned. The default is 25 if not set explicitly.

fedID - ID of the federated instance to which the document belongs.

Returns:

a list of incoming links

Throws:

Exception - if any error occurs

oracle.search.query.webservice.wssclient.Exception_Exception

getOutLinks

List getOutLinks(Integer docID,
                 Integer maxNum,
                 String fedID)
                 throws oracle.search.query.webservice.wssclient.Exception_Exception

Returns a list of outgoing links for a given document.

Parameters:

docID - ID of the document for which outgoing links are returned

maxNum - maximum number of outgoing links to be fetched. The default is 25 if not set explicitly.

fedID - ID of the federated instance to which the document belongs.

Returns:

a list of outgoing links

Throws:

Exception - if any error occurs

oracle.search.query.webservice.wssclient.Exception_Exception

getCachedPage

byte[] getCachedPage(String query,
                     Integer docID,
                     String fedID)
                     throws oracle.search.query.webservice.wssclient.Exception_Exception

Returns cached HTML version of a document. The actual query string is highlighted in the output.

Note: Only first 200KB of the cached version of the document is returned.

Parameters:

query - query string used for search

docID - ID of the document for which the cached content is to be fetched

fedID - ID of the federated instance to which the document belongs

Returns:

byte array of the cached HTML version of the document

Throws:

Exception - if any error occurs

oracle.search.query.webservice.wssclient.Exception_Exception

submitUrl

Status submitUrl(String url)
                 throws oracle.search.query.webservice.wssclient.Exception_Exception

Submits a URL for Oracle SES to crawl and index.

Parameters:

Url - URL to be submitted to Oracle SES to crawl and index. It must be a valid URL and it cannot be null.

Returns:

Status of the request. Status code can be either "successful" or "failed". If the status code is "successful", then the status message is null; otherwise it consists of an error message.

Throws:

Exception - if any error occurs

oracle.search.query.webservice.wssclient.Exception_Exception

getAttributes

List getAttributes(String locale,
                   List groups,
                   String groupConnector)
                   throws oracle.search.query.webservice.wssclient.Exception_Exception

Returns the list of search attributes that are applied to given source groups.

Parameters:

locale - a two-letter representation of the locale. The default is English ("en") if not set explicitly.

groups - a list of data source groups for which the search attributes are requested.

groupConnector - the connector between all groups. "and" indicates that the search attributes to be returned are intersection of attributes from each group. "or" indicates the search attributes to be returned are a union of attributes from each group. The default is "or" of not set explicitly.

Returns:

array of Attribute

Throws:

Exception - if any error occurs

oracle.search.query.webservice.wssclient.Exception_Exception

getAllAttributes

List getAllAttributes(String locale)
                      throws oracle.search.query.webservice.wssclient.Exception_Exception

Returns all the search attributes available in Oracle SES.

Parameters:

locale - a two-letter representation of the locale. The default is English ("en") if not set explicitly.

Returns:

a list of Attributes

Throws:

Exception - if any error occurs

oracle.search.query.webservice.wssclient.Exception_Exception

getAttributeLOV

List getAttributeLOV(Attribute att,
                     String lang)
                     throws oracle.search.query.webservice.wssclient.Exception_Exception

Returns a list of value (LOV) for a given search attribute.

Parameters:

attribute - search attribute for which the LOV is requested

locale - a two-letter representation of the locale. The default is English("en") if not set explicitly.

Returns:

a list of AttributeLOV

Throws:

Exception - if any error occurs

oracle.search.query.webservice.wssclient.Exception_Exception

getDataGroups

List getDataGroups(String locale)
                   throws oracle.search.query.webservice.wssclient.Exception_Exception

Returns a list of all the source groups defined in Oracle SES. It can be used by an application to show all the source groups in the search page, such that end users can restrict their search within one or more source groups.

Parameters:

locale - a two-letter representation of the locale. The default is English ("en") if not set explicitly.

Returns:

a list of data source groups defined in Oracle SES

Throws:

Exception - if any error occurs

oracle.search.query.webservice.wssclient.Exception_Exception

getInfoSourceNodes

List getInfoSourceNodes(String parentNodeID,
                        String fedID,
                        String locale)
                        throws oracle.search.query.webservice.wssclient.Exception_Exception

Returns all the children nodes of an infosource node.

Parameters:

parentNodeID - ID of the (parent) infosource node for which all the children nodes are returned

fedID - ID of the federated instance the parent node belongs to. The default is "-1" for the local Oracle SES instance if not specified explicitly.

locale - a two-letter representation of the locale. The default is English ("en") if not set explicitly.

Returns:

a list of info source nodes

Throws:

Exception - if any error occurs

oracle.search.query.webservice.wssclient.Exception_Exception

getInfoSourceAncestorNodes

List getInfoSourceAncestorNodes(String nodeID,
                                String locale)
                                throws oracle.search.query.webservice.wssclient.Exception_Exception

Returns a list of all the infosource nodes (ancestor nodes) in the full path from the root node to a given infosource node.

Parameters:

nodeID - ID of the infosource node for which all ancestor nodes are returned.

locale - a two letter representation of the locale. The default is English ("en") if not set explicitly.

Returns:

a list of ancestor nodes

Throws:

Exception - if any error occurs

oracle.search.query.webservice.wssclient.Exception_Exception

getInfoSourceNode

Node getInfoSourceNode(String nodeID,
                       String fedID,
                       String locale)
                       throws oracle.search.query.webservice.wssclient.Exception_Exception

Returns an infosource node for a given node ID.

Parameters:

nodeID - ID of the infosource node to be fetched

fedID - ID of the federated instance to which the infosource node belongs. The default is "-1" for local SES instance if not set explicitly.

locale - a two-letter representation of the locale. The default is English ("en") if not set explicitly.

Returns:

an inforsource node

Throws:

Exception - if any error occurs

oracle.search.query.webservice.wssclient.Exception_Exception

doOracleBrowseSearch

OracleSearchResult doOracleBrowseSearch(String query,
                                        String nodeID,
                                        String fedID,
                                        Integer startIndex,
                                        Integer docsRequested,
                                        Boolean dupRemoved,
                                        Boolean dupMarked,
                                        String queryLang,
                                        String docLang,
                                        Boolean returnCount,
                                        List fetchAttributes)
                                        throws oracle.search.query.webservice.wssclient.Exception_Exception

Invokes Oracle SES search, restricts the search to a particular infosource node and returns the search results.

Parameters:

query - query string. The search string follows Oracle SES query syntax.

nodeID - ID of the inforsource node to restrict the search to.

fedID - ID of the federated Oracle SES instance the infosource node belongs to.

startIndex - index of the first document in the hit list to be returned. The default is 1 if not set explicitly.

docsRequested - maximum number of documents in hit list to be returned. The default is 10 if not set explicitly.

dupRemoved - Boolean flag to enable or disable duplicate removal. If turned on, duplicate documents in the hit list will be removed. The default is false if not set explicitly. Note: The dupMarked switch has no effect when dupRemoved is turned on.

dupMarked - Boolean flag to enable or disable duplicate detection. The default is false if not set explicitly. Note: The dupMarked switch has no effect when dupRemoved is turned on.

queryLang - language of the query. This is equivalent to Locale. The default is English ("en") if not set explicitly. queryLang is used in relevancy boosting.

docLang - language of the documents to restrict the search. If the value is not set explicitly, then search is performed against documents of all the languages.

returnCount - Boolean flag indicating whether to fetch the total hit count with the result. The default is false if not set explicitly.

fetchAttributes - a list of Integers representing the IDs of custom or non-default attributes to be fetched with the search result.

Returns:

search results (OracleSearchResult)

Throws:

Exception - if any error occurs

oracle.search.query.webservice.wssclient.Exception_Exception

getLanguages

List getLanguages(String locale)
                  throws oracle.search.query.webservice.wssclient.Exception_Exception

Returns all the languages supported by Oracle SES.

Parameters:

locale - a two-letter representation of the locale. The default is English ("en") if not set explicitly.

Returns:

a list of Languages

Throws:

Exception - if any error occurs

oracle.search.query.webservice.wssclient.Exception_Exception

setSessionContext

Status setSessionContext(List sessionContext)
                         throws oracle.search.query.webservice.wssclient.Exception_Exception

Sets the session context to be used for query-time filtering.

Parameters:

sessionContext - array of SessionContextElement

Returns:

Status of the request. Status code can be either "successful" or "failed". If the status code is "successful", then the status message is null; otherwise it consists of an error message.

Throws:

Exception - if any error occurs

oracle.search.query.webservice.wssclient.Exception_Exception

logUserClick

String logUserClick(Integer queryID,
                    Integer urlID,
                    Integer infoSourceID,
                    Integer position,
                    String fedID)
                    throws oracle.search.query.webservice.wssclient.Exception_Exception

Logs user's clicks on the search hits.

Parameters:

queryID - ID of the submitted query.

urlID - ID of the document that user clicked.

infoSourceID - ID of the infosource. "-1" is used if not set explicitly.

position - position (rank) of the document in the hit list

fedID - ID of the federated Oracle SES instance to which the documents belongs.

Returns:

URL of the document that the user clicked on.

Throws:

Exception - if any error occurs

oracle.search.query.webservice.wssclient.Exception_Exception

getSuggestedContent

List getSuggestedContent(String query,
                         String returnType)
                         throws oracle.search.query.webservice.wssclient.Exception_Exception

Invokes Oracle SES Suggested Content search only to get the suggested content for the query

Parameters:

query - query string. The search string should follow Oracle SES query syntax.

returnType - either "html" or "xml".

Returns:

SCElement list. Each of them is one provider result.

Throws:

Exception

oracle.search.query.webservice.wssclient.Exception_Exception

getHitCounts

List getHitCounts(List queryList,
                  List groups,
                  String queryLang,
                  String docLang,
                  String filterConnector,
                  List filters,
                  Boolean exactCount,
                  String searchControls)
                  throws oracle.search.query.webservice.wssclient.Exception_Exception

Return hit counts for a batch of SES queries. Note: there is no guarantee that the hit counts returned from this method always match doOracleSearch, because extra processing occurs in doOracleSearch that may introduce additional documents. For example, anchor text is considered when searching web documents, but is not part of the documents themselves. Therefore, doOracleSearch may return documents having matching anchor text, but getHitCounts does not. This method always includes duplicate documents in the hit counts.

Parameters:

queryList - query strings. The search strings follow Oracle SES query syntax.

groups - a list of data source groups that the search will be restricted to. The default is all groups if not set explicitly.

queryLang - language of the queries. This is equivalent to Locale. The default is English ("en") if not set explicitly. queryLang is used in relevancy boosting.

docLang - language of the documents to restrict the search. If the value is not set explicitly, then search is performed against documents of all the languages.

filterConnector - connector between all the filters. "and" indicates the documents in the hit list must satisfy all the filters. "or" indicates the documents in the hit-list must satisfy at least one of the filters. The default is "and" if not set explicitly.

filters - a list of Filters. Each filter is a restriction on the search result. Filters are connected by the filterConnector. The default is null (no filter applies to the search result) if not set explicitly.

exactCounts - whether to return exact counts. If false, estimated hit counts are returned. The default is false if not set explicitly.

searchControls - XML string to specify additional behavior.

Returns:

an Integer list containing a hit count for each query

Throws:

Exception - if any error occurs

oracle.search.query.webservice.wssclient.Exception_Exception

removeResults

oracle.search.query.webservice.wssclient.StatsContainer removeResults(List ids,
                                                                      String idType,
                                                                      String locale,
                                                                      String ctlParams)
                                                                      throws oracle.search.query.webservice.wssclient.Exception_Exception

Deletes the specified document from the index

Parameters:

ids - a list of Ids, which can be document ids or URLs

idType - the type of the IDs ("docid" or "url")

locale - the locale of the request

ctlParams - an XML string for specifying additional information

Returns:

StatsContainer

Throws:

Exception - if any error occurs

oracle.search.query.webservice.wssclient.Exception_Exception

getFacetNodes

List getFacetNodes(List facetPaths,
                   Boolean returnFacetDocCount,
                   Integer minFacetDocCount,
                   Integer maxFacetChildren,
                   String sortBy,
                   String locale,
                   String searchControls)
                   throws oracle.search.query.webservice.wssclient.Exception_Exception

Get facet nodes.

Parameters:

facetPaths - a list of facet paths for which children facets are to be returned. Null if to retrieve the list of the root facets.

returnFacetDocCount - Boolean flag to fetch document counts for each of the facets in facet trees returned. Default is TRUE

minFacetDocCount - Minimum number of document count for a facet node to be returned for each facet. Default is 0.

maxFacetChildren - Maximum number of children to be returned for each facet. Default is 5. 0 - no child is returned. 1 - return all the children.

sortBy - constant indicating the sort order for facet children. Possible values are: "COUNT_ASC", "COUNT_DES", "ALPHA_ASC", "ALPHA_DES". Default is "COUNT_DES"

locale - a two letter representation of the locale. The default is English("en") if not set explicitly. Locale will be used to get displayNames for the facets.

searchControls - XML string to specify advanced parameters.

Returns:

a list of facet nodes with positive document count. Node with 0 count is not returned.

Throws:

Exception - if any error occurs.

oracle.search.query.webservice.wssclient.Exception_Exception

doOracleFacetSearch

OracleFacetResultContainer doOracleFacetSearch(String query,
                                               Integer topN,
                                               Integer startIndex,
                                               Integer docsRequested,
                                               Boolean dupRemoved,
                                               Boolean dupMarked,
                                               List groups,
                                               String queryLang,
                                               String docLang,
                                               Boolean returnCount,
                                               String filterConnector,
                                               List filters,
                                               List fetchAttributeNames,
                                               GroupAttribute groupAttr,
                                               List sortAttrList,
                                               List clusterList,
                                               List facetPaths,
                                               Boolean returnFacetDocCount,
                                               Integer minFacetDocCount,
                                               Integer maxFacetChildren,
                                               String sortBy,
                                               String searchControls)
                                               throws oracle.search.query.webservice.wssclient.Exception_Exception

Invokes Oracle SES facet search and returns search results and facet info.

Parameters:

query - query string. The search string should follow Oracle SES query syntax.

topN - top N search result for grouping/sorting/clustering

startIndex - index of the first document in the hit-list to be returned. The default is 1 if not set explicitly.

docsRequested - maximum number of documents in the hit-list to be returned. The default is 10 if not set explicitly.

dupRemoved - Boolean flag to enable or disable duplicate removal. If turned on, duplicate documents in the hit-list will be removed. The default is false if not set explicitly. Note: The dupMarked switch will have no effect when dupRemoved is turned on.

dupMarked - Boolean flag to enable or disable duplicate detection. The default is false if not set explicitly. Note: The dupMarked switch will have no effect when dupRemoved is turned on.

groups - a list of data source groups that the search will be restricted to. The default is all groups if not set explicitly.

queryLang - language of the query. This is equivalent to Locale. The default is English("en") if not set explicitly. queryLang is used in relevancy boosting.

docLang - language of the documents to restrict the search. If the value is not set explicitly, then search is performed against documents of all the languages.

returnCount - Boolean flag to fetch the total hit count with the result. The default is false if not set explicitly.

filterConnector - connector between all the filters. "and" indicates the documents in the hit-list must satisfy all the filters. "or" indicates the documents in the hit-list must satisfy at least one of the filters. The default is "and" if not set explicitly.

filters - a list of Filters. Each filter is a restriction on on the search result. Filters are connected by the filterConnector. The default is null(no filter applies to the search result) if not set explicitly.

fetchAttributeNames - a list of names of custom or non-default attributes to be fetched with the search result

groupAttr - attribute used for grouping

sortAttrList - a list of sorting attribute setting

clusterList - a list of cluster configurations

facetPaths - a list of facet paths

returnFacetDocCount - whether to return facet count

minFacetDocCount - minimum doc count a facet node must have to be returned

maxFacetChildren - maximum number of children for a facet node

sortBy - how children are sorted

searchControls - xml string to specify advanced filter conditions and ranking parameters

Returns:

search and facet results (OracleFacetResultContainer)

Throws:

Exception - if any error occurs

oracle.search.query.webservice.wssclient.Exception_Exception

Skip navigation links