public static class OpenSearchDocumentSourceDescriptor.AttributeBuilder extends MultipageSearchEngineDescriptor.AttributeBuilder
OpenSearchDocumentSource component. You can use this
builder as a type-safe alternative to populating the attribute map using attribute keys.| Modifier and Type | Field and Description |
|---|---|
Map<String,Object> |
map
The attribute map populated by this builder.
|
| Modifier | Constructor and Description |
|---|---|
protected |
AttributeBuilder(Map<String,Object> map)
Creates a builder backed by the provided map.
|
searchMode, searchModecompressed, documents, query, query, results, results, resultsTotal, start, startpublic OpenSearchDocumentSourceDescriptor.AttributeBuilder feedUrlTemplate(String value)
${variable}. The following
variables are supported:
searchTerms will be replaced by the querystartIndex index of the first result to be searched. Mutually
exclusive with startPagestartPage index of the first result
to be searched. Mutually exclusive with startIndex.count the number of search results per pageExample URL feed templates for public services:
http://www.nature.com/opensearch/request?interface=opensearch&operation=searchRetrieve&query=${searchTerms}&startRecord=${startIndex}&maximumRecords=${count}&httpAccept=application/rss%2Bxmlhttp://www.indeed.com/opensearch?q=${searchTerms}&start=${startIndex}&limit=${count}OpenSearchDocumentSource.feedUrlTemplatepublic OpenSearchDocumentSourceDescriptor.AttributeBuilder feedUrlTemplate(org.carrot2.util.attribute.IObjectFactory<? extends String> value)
${variable}. The following
variables are supported:
searchTerms will be replaced by the querystartIndex index of the first result to be searched. Mutually
exclusive with startPagestartPage index of the first result
to be searched. Mutually exclusive with startIndex.count the number of search results per pageExample URL feed templates for public services:
http://www.nature.com/opensearch/request?interface=opensearch&operation=searchRetrieve&query=${searchTerms}&startRecord=${startIndex}&maximumRecords=${count}&httpAccept=application/rss%2Bxmlhttp://www.indeed.com/opensearch?q=${searchTerms}&start=${startIndex}&limit=${count}OpenSearchDocumentSource.feedUrlTemplatepublic OpenSearchDocumentSourceDescriptor.AttributeBuilder resultsPerPage(int value)
OpenSearchDocumentSource.resultsPerPagepublic OpenSearchDocumentSourceDescriptor.AttributeBuilder resultsPerPage(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value)
OpenSearchDocumentSource.resultsPerPagepublic OpenSearchDocumentSourceDescriptor.AttributeBuilder maximumResults(int value)
OpenSearchDocumentSource.maximumResultspublic OpenSearchDocumentSourceDescriptor.AttributeBuilder maximumResults(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value)
OpenSearchDocumentSource.maximumResultspublic OpenSearchDocumentSourceDescriptor.AttributeBuilder feedUrlParams(Map<String,String> value)
OpenSearchDocumentSource.feedUrlTemplate on each request.OpenSearchDocumentSource.feedUrlParamspublic OpenSearchDocumentSourceDescriptor.AttributeBuilder feedUrlParams(org.carrot2.util.attribute.IObjectFactory<? extends Map<String,String>> value)
OpenSearchDocumentSource.feedUrlTemplate on each request.OpenSearchDocumentSource.feedUrlParamspublic OpenSearchDocumentSourceDescriptor.AttributeBuilder userAgent(String value)
null value is provided,
the following User-Agent will be sent: Rome Client (http://tinyurl.com/64t5n)
Ver: UNKNOWN.OpenSearchDocumentSource.userAgentpublic OpenSearchDocumentSourceDescriptor.AttributeBuilder userAgent(org.carrot2.util.attribute.IObjectFactory<? extends String> value)
null value is provided,
the following User-Agent will be sent: Rome Client (http://tinyurl.com/64t5n)
Ver: UNKNOWN.OpenSearchDocumentSource.userAgent