com.jaeksoft.searchlib.request.SearchFieldRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of opensearchserver Show documentation
Show all versions of opensearchserver Show documentation
OpenSearchServer is a powerful, enterprise-class, search engine program. Using the web user interface,
the crawlers (web, file, database, ...) and the REST/RESTFul API you will be able to integrate quickly and
easily advanced full-text search capabilities in your application. OpenSearchServer runs on Windows and
Linux/Unix/BSD.
/**
* License Agreement for OpenSearchServer
*
* Copyright (C) 2008-2013 Emmanuel Keller / Jaeksoft
*
* http://www.open-search-server.com
*
* This file is part of OpenSearchServer.
*
* OpenSearchServer is free software: you can redistribute it and/or
* modify it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* OpenSearchServer is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with OpenSearchServer.
* If not, see searchFields;
public SearchFieldRequest() {
super(null, RequestTypeEnum.SearchFieldRequest);
}
public SearchFieldRequest(Config config) {
super(config, RequestTypeEnum.SearchFieldRequest);
}
@Override
protected void setDefaultValues() {
super.setDefaultValues();
searchFields = new ArrayList(0);
}
@Override
public void copyFrom(AbstractRequest request) {
super.copyFrom(request);
SearchFieldRequest searchFieldRequest = (SearchFieldRequest) request;
this.searchFields = new ArrayList(0);
if (searchFieldRequest.searchFields != null)
for (SearchField searchField : searchFieldRequest.searchFields)
this.searchFields.add(searchField.clone());
}
@Override
protected Query newSnippetQuery(String queryString) throws IOException,
ParseException, SyntaxError, SearchLibException {
BooleanQuery complexQuery = new BooleanQuery();
SnippetFieldList snippetFieldList = getSnippetFieldList();
Occur occur = defaultOperator == OperatorEnum.AND ? Occur.MUST
: Occur.SHOULD;
for (SearchField searchField : searchFields)
if (snippetFieldList.get(searchField.getField()) != null)
searchField.addQuery(analyzer, queryString, complexQuery,
phraseSlop, occur);
return complexQuery;
}
@Override
public Query newComplexQuery(String queryString) throws ParseException,
SyntaxError, SearchLibException, IOException {
Occur occur = defaultOperator == OperatorEnum.AND ? Occur.MUST
: Occur.SHOULD;
if (emptyReturnsAll && StringUtils.isEmpty(queryString))
return new MatchAllDocsQuery();
BooleanQuery complexQuery = new BooleanQuery();
for (SearchField searchField : searchFields)
searchField.addQuery(analyzer, queryString, complexQuery,
phraseSlop, occur);
return complexQuery;
}
@Override
public void fromXmlConfigNoLock(Config config, XPathParser xpp,
Node requestNode) throws XPathExpressionException, DOMException,
ParseException, InstantiationException, IllegalAccessException,
ClassNotFoundException {
super.fromXmlConfigNoLock(config, xpp, requestNode);
List fieldNodeList = DomUtils.getNodes(requestNode,
SEARCHFIELD_QUERY_NODE_NAME, SearchField.SEARCHFIELD_NODE_NAME);
if (fieldNodeList != null)
for (Node fieldNode : fieldNodeList)
searchFields.add(new SearchField(fieldNode));
}
@Override
public void writeSubXmlConfig(XmlWriter xmlWriter) throws SAXException {
xmlWriter.startElement(SEARCHFIELD_QUERY_NODE_NAME);
for (SearchField searchField : searchFields)
searchField.writeXmlConfig(xmlWriter);
xmlWriter.endElement();
}
@Override
public String getInfo() {
rwl.r.lock();
try {
return searchFields.toString();
} finally {
rwl.r.unlock();
}
}
public Collection getSearchFields() {
rwl.r.lock();
try {
return searchFields;
} finally {
rwl.r.unlock();
}
}
public void add(SearchField searchField) {
rwl.w.lock();
try {
searchFields.add(searchField);
resetNoLock();
} finally {
rwl.w.unlock();
}
}
/**
* Add a new search field to the request
*
* @param fieldName
* The name of the field
* @param phrase
* Activate the phrase search
* @param boost
* Set the boost for the term search
* @param phraseBoost
* Set the boost for the phrase search
*/
public void addSearchField(String fieldName, Mode mode, double termBoost,
double phraseBoost) {
add(new SearchField(fieldName, mode, termBoost, phraseBoost));
}
public void addSearchField(String fieldName, double termBoost) {
add(new SearchField(fieldName, Mode.PATTERN, termBoost, 1.0));
}
public void remove(SearchField searchField) {
rwl.w.lock();
try {
searchFields.remove(searchField);
resetNoLock();
} finally {
rwl.w.unlock();
}
}
/**
* Add a snippet field
*
* @param fieldName
* The name of the field
* @param fragmenter
* The fragmentation method
* @param maxSize
* The maximum size of the snippet in character
* @param separator
* The string sequence used to highlight keywords
* @param maxNumber
* The maximum number of snippet
* @throws SearchLibException
*/
public void addSnippetField(String fieldName, FragmenterEnum fragmenter,
int maxSize, String separator, int maxNumber)
throws SearchLibException {
SnippetField field = new SnippetField(fieldName);
field.setFragmenter(fragmenter.className);
field.setMaxSnippetSize(maxSize);
field.setSeparator(separator);
field.setMaxSnippetNumber(maxNumber);
this.getSnippetFieldList().put(field);
}
/**
* Add facet
*
* @param fieldName
* The name of the field
* @param minCount
* The minimum number of document
* @param multivalued
* The field can contains several values
* @param postCollapsing
* The number is calculated after collapsing
* @param ranges
* An optional list of ranges
*/
public void addFacet(String fieldName, int minCount, boolean multivalued,
boolean postCollapsing, List ranges) {
FacetField facetField = new FacetField(fieldName, minCount,
multivalued, postCollapsing, ranges);
getFacetFieldList().put(facetField);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy