The SolrDisMaxQuery class

Introduction

Class synopsis

SolrDisMaxQuery
class SolrDisMaxQuery extends SolrQuery implements Serializable {
/* Inherited properties */
const int SolrQuery::ORDER_ASC = 0;
const int SolrQuery::ORDER_DESC = 1;
const int SolrQuery::FACET_SORT_INDEX = 0;
const int SolrQuery::FACET_SORT_COUNT = 1;
const int SolrQuery::TERMS_SORT_INDEX = 0;
const int SolrQuery::TERMS_SORT_COUNT = 1;
/* Methods */
public __construct(string $q = ?)
public SolrDisMaxQuery addBigramPhraseField(string $field, string $boost, string $slop = ?)
public SolrDisMaxQuery addBoostQuery(string $field, string $value, string $boost = ?)
public SolrDisMaxQuery addPhraseField(string $field, string $boost, string $slop = ?)
public SolrDisMaxQuery addQueryField(string $field, string $boost = ?)
public SolrDisMaxQuery addTrigramPhraseField(string $field, string $boost, string $slop = ?)
public SolrDisMaxQuery addUserField(string $field)
public SolrDisMaxQuery removeBigramPhraseField(string $field)
public SolrDisMaxQuery removeBoostQuery(string $field)
public SolrDisMaxQuery removePhraseField(string $field)
public SolrDisMaxQuery removeQueryField(string $field)
public SolrDisMaxQuery removeTrigramPhraseField(string $field)
public SolrDisMaxQuery removeUserField(string $field)
public SolrDisMaxQuery setBigramPhraseFields(string $fields)
public SolrDisMaxQuery setBigramPhraseSlop(string $slop)
public SolrDisMaxQuery setBoostFunction(string $function)
public SolrDisMaxQuery setBoostQuery(string $q)
public SolrDisMaxQuery setMinimumMatch(string $value)
public SolrDisMaxQuery setPhraseFields(string $fields)
public SolrDisMaxQuery setPhraseSlop(string $slop)
public SolrDisMaxQuery setQueryAlt(string $q)
public SolrDisMaxQuery setQueryPhraseSlop(string $slop)
public SolrDisMaxQuery setTieBreaker(string $tieBreaker)
public SolrDisMaxQuery setTrigramPhraseFields(string $fields)
public SolrDisMaxQuery setTrigramPhraseSlop(string $slop)
public SolrDisMaxQuery setUserFields(string $fields)
public SolrDisMaxQuery useDisMaxQueryParser()
public SolrDisMaxQuery useEDisMaxQueryParser()
/* Inherited methods */
public SolrQuery SolrQuery::addExpandFilterQuery(string $fq)
public SolrQuery SolrQuery::addExpandSortField(string $field, string $order = ?)
public SolrQuery SolrQuery::addFacetDateField(string $dateField)
public SolrQuery SolrQuery::addFacetDateOther(string $value, string $field_override = ?)
public SolrQuery SolrQuery::addFacetField(string $field)
public SolrQuery SolrQuery::addFacetQuery(string $facetQuery)
public SolrQuery SolrQuery::addField(string $field)
public SolrQuery SolrQuery::addFilterQuery(string $fq)
public SolrQuery SolrQuery::addGroupField(string $value)
public SolrQuery SolrQuery::addGroupFunction(string $value)
public SolrQuery SolrQuery::addGroupQuery(string $value)
public SolrQuery SolrQuery::addGroupSortField(string $field, int $order = ?)
public SolrQuery SolrQuery::addHighlightField(string $field)
public SolrQuery SolrQuery::addMltField(string $field)
public SolrQuery SolrQuery::addMltQueryField(string $field, float $boost)
public SolrQuery SolrQuery::addSortField(string $field, int $order = SolrQuery::ORDER_DESC)
public SolrQuery SolrQuery::addStatsFacet(string $field)
public SolrQuery SolrQuery::addStatsField(string $field)
public SolrQuery SolrQuery::collapse(SolrCollapseFunction $collapseFunction)
public bool SolrQuery::getExpand()
public array SolrQuery::getExpandFilterQueries()
public array SolrQuery::getExpandQuery()
public int SolrQuery::getExpandRows()
public array SolrQuery::getExpandSortFields()
public bool SolrQuery::getFacet()
public string SolrQuery::getFacetDateEnd(string $field_override = ?)
public array SolrQuery::getFacetDateFields()
public string SolrQuery::getFacetDateGap(string $field_override = ?)
public string SolrQuery::getFacetDateHardEnd(string $field_override = ?)
public array SolrQuery::getFacetDateOther(string $field_override = ?)
public string SolrQuery::getFacetDateStart(string $field_override = ?)
public array SolrQuery::getFacetFields()
public int SolrQuery::getFacetLimit(string $field_override = ?)
public string SolrQuery::getFacetMethod(string $field_override = ?)
public int SolrQuery::getFacetMinCount(string $field_override = ?)
public bool SolrQuery::getFacetMissing(string $field_override = ?)
public int SolrQuery::getFacetOffset(string $field_override = ?)
public string SolrQuery::getFacetPrefix(string $field_override = ?)
public array SolrQuery::getFacetQueries()
public int SolrQuery::getFacetSort(string $field_override = ?)
public array SolrQuery::getFields()
public array SolrQuery::getFilterQueries()
public bool SolrQuery::getGroup()
public int SolrQuery::getGroupCachePercent()
public bool SolrQuery::getGroupFacet()
public array SolrQuery::getGroupFields()
public string SolrQuery::getGroupFormat()
public array SolrQuery::getGroupFunctions()
public int SolrQuery::getGroupLimit()
public bool SolrQuery::getGroupMain()
public bool SolrQuery::getGroupNGroups()
public int SolrQuery::getGroupOffset()
public array SolrQuery::getGroupQueries()
public array SolrQuery::getGroupSortFields()
public bool SolrQuery::getGroupTruncate()
public bool SolrQuery::getHighlight()
public string SolrQuery::getHighlightAlternateField(string $field_override = ?)
public array SolrQuery::getHighlightFields()
public string SolrQuery::getHighlightFormatter(string $field_override = ?)
public string SolrQuery::getHighlightFragmenter(string $field_override = ?)
public int SolrQuery::getHighlightFragsize(string $field_override = ?)
public bool SolrQuery::getHighlightHighlightMultiTerm()
public int SolrQuery::getHighlightMaxAlternateFieldLength(string $field_override = ?)
public int SolrQuery::getHighlightMaxAnalyzedChars()
public bool SolrQuery::getHighlightMergeContiguous(string $field_override = ?)
public string SolrQuery::getHighlightQuery()
public int SolrQuery::getHighlightRegexMaxAnalyzedChars()
public string SolrQuery::getHighlightRegexPattern()
public float SolrQuery::getHighlightRegexSlop()
public bool SolrQuery::getHighlightRequireFieldMatch()
public string SolrQuery::getHighlightSimplePost(string $field_override = ?)
public string SolrQuery::getHighlightSimplePre(string $field_override = ?)
public int SolrQuery::getHighlightSnippets(string $field_override = ?)
public bool SolrQuery::getHighlightUsePhraseHighlighter()
public bool SolrQuery::getMlt()
public bool SolrQuery::getMltBoost()
public int SolrQuery::getMltCount()
public array SolrQuery::getMltFields()
public int SolrQuery::getMltMaxNumQueryTerms()
public int SolrQuery::getMltMaxNumTokens()
public int SolrQuery::getMltMaxWordLength()
public int SolrQuery::getMltMinDocFrequency()
public int SolrQuery::getMltMinTermFrequency()
public int SolrQuery::getMltMinWordLength()
public array SolrQuery::getMltQueryFields()
public string SolrQuery::getQuery()
public int SolrQuery::getRows()
public array SolrQuery::getSortFields()
public int SolrQuery::getStart()
public bool SolrQuery::getStats()
public array SolrQuery::getStatsFacets()
public array SolrQuery::getStatsFields()
public bool SolrQuery::getTerms()
public string SolrQuery::getTermsField()
public bool SolrQuery::getTermsIncludeLowerBound()
public bool SolrQuery::getTermsIncludeUpperBound()
public int SolrQuery::getTermsLimit()
public string SolrQuery::getTermsLowerBound()
public int SolrQuery::getTermsMaxCount()
public int SolrQuery::getTermsMinCount()
public string SolrQuery::getTermsPrefix()
public bool SolrQuery::getTermsReturnRaw()
public int SolrQuery::getTermsSort()
public string SolrQuery::getTermsUpperBound()
public int SolrQuery::getTimeAllowed()
public SolrQuery SolrQuery::removeExpandFilterQuery(string $fq)
public SolrQuery SolrQuery::removeExpandSortField(string $field)
public SolrQuery SolrQuery::removeFacetDateField(string $field)
public SolrQuery SolrQuery::removeFacetDateOther(string $value, string $field_override = ?)
public SolrQuery SolrQuery::removeFacetField(string $field)
public SolrQuery SolrQuery::removeFacetQuery(string $value)
public SolrQuery SolrQuery::removeField(string $field)
public SolrQuery SolrQuery::removeFilterQuery(string $fq)
public SolrQuery SolrQuery::removeHighlightField(string $field)
public SolrQuery SolrQuery::removeMltField(string $field)
public SolrQuery SolrQuery::removeMltQueryField(string $queryField)
public SolrQuery SolrQuery::removeSortField(string $field)
public SolrQuery SolrQuery::removeStatsFacet(string $value)
public SolrQuery SolrQuery::removeStatsField(string $field)
public SolrQuery SolrQuery::setEchoHandler(bool $flag)
public SolrQuery SolrQuery::setEchoParams(string $type)
public SolrQuery SolrQuery::setExpand(bool $value)
public SolrQuery SolrQuery::setExpandQuery(string $q)
public SolrQuery SolrQuery::setExpandRows(int $value)
public SolrQuery SolrQuery::setExplainOther(string $query)
public SolrQuery SolrQuery::setFacet(bool $flag)
public SolrQuery SolrQuery::setFacetDateEnd(string $value, string $field_override = ?)
public SolrQuery SolrQuery::setFacetDateGap(string $value, string $field_override = ?)
public SolrQuery SolrQuery::setFacetDateHardEnd(bool $value, string $field_override = ?)
public SolrQuery SolrQuery::setFacetDateStart(string $value, string $field_override = ?)
public SolrQuery SolrQuery::setFacetEnumCacheMinDefaultFrequency(int $frequency, string $field_override = ?)
public SolrQuery SolrQuery::setFacetLimit(int $limit, string $field_override = ?)
public SolrQuery SolrQuery::setFacetMethod(string $method, string $field_override = ?)
public SolrQuery SolrQuery::setFacetMinCount(int $mincount, string $field_override = ?)
public SolrQuery SolrQuery::setFacetMissing(bool $flag, string $field_override = ?)
public SolrQuery SolrQuery::setFacetOffset(int $offset, string $field_override = ?)
public SolrQuery SolrQuery::setFacetPrefix(string $prefix, string $field_override = ?)
public SolrQuery SolrQuery::setFacetSort(int $facetSort, string $field_override = ?)
public SolrQuery SolrQuery::setGroup(bool $value)
public SolrQuery SolrQuery::setGroupCachePercent(int $percent)
public SolrQuery SolrQuery::setGroupFacet(bool $value)
public SolrQuery SolrQuery::setGroupFormat(string $value)
public SolrQuery SolrQuery::setGroupLimit(int $value)
public SolrQuery SolrQuery::setGroupMain(string $value)
public SolrQuery SolrQuery::setGroupNGroups(bool $value)
public SolrQuery SolrQuery::setGroupOffset(int $value)
public SolrQuery SolrQuery::setGroupTruncate(bool $value)
public SolrQuery SolrQuery::setHighlight(bool $flag)
public SolrQuery SolrQuery::setHighlightAlternateField(string $field, string $field_override = ?)
public SolrQuery SolrQuery::setHighlightFormatter(string $formatter, string $field_override = ?)
public SolrQuery SolrQuery::setHighlightFragmenter(string $fragmenter, string $field_override = ?)
public SolrQuery SolrQuery::setHighlightFragsize(int $size, string $field_override = ?)
public SolrQuery SolrQuery::setHighlightHighlightMultiTerm(bool $flag)
public SolrQuery SolrQuery::setHighlightMaxAlternateFieldLength(int $fieldLength, string $field_override = ?)
public SolrQuery SolrQuery::setHighlightMaxAnalyzedChars(int $value)
public SolrQuery SolrQuery::setHighlightMergeContiguous(bool $flag, string $field_override = ?)
public SolrQuery SolrQuery::setHighlightQuery(string $q)
public SolrQuery SolrQuery::setHighlightRegexMaxAnalyzedChars(int $maxAnalyzedChars)
public SolrQuery SolrQuery::setHighlightRegexPattern(string $value)
public SolrQuery SolrQuery::setHighlightRegexSlop(float $factor)
public SolrQuery SolrQuery::setHighlightRequireFieldMatch(bool $flag)
public SolrQuery SolrQuery::setHighlightSimplePost(string $simplePost, string $field_override = ?)
public SolrQuery SolrQuery::setHighlightSimplePre(string $simplePre, string $field_override = ?)
public SolrQuery SolrQuery::setHighlightSnippets(int $value, string $field_override = ?)
public SolrQuery SolrQuery::setHighlightUsePhraseHighlighter(bool $flag)
public SolrQuery SolrQuery::setMlt(bool $flag)
public SolrQuery SolrQuery::setMltBoost(bool $flag)
public SolrQuery SolrQuery::setMltCount(int $count)
public SolrQuery SolrQuery::setMltMaxNumQueryTerms(int $value)
public SolrQuery SolrQuery::setMltMaxNumTokens(int $value)
public SolrQuery SolrQuery::setMltMaxWordLength(int $maxWordLength)
public SolrQuery SolrQuery::setMltMinDocFrequency(int $minDocFrequency)
public SolrQuery SolrQuery::setMltMinTermFrequency(int $minTermFrequency)
public SolrQuery SolrQuery::setMltMinWordLength(int $minWordLength)
public SolrQuery SolrQuery::setOmitHeader(bool $flag)
public SolrQuery SolrQuery::setQuery(string $query)
public SolrQuery SolrQuery::setRows(int $rows)
public SolrQuery SolrQuery::setShowDebugInfo(bool $flag)
public SolrQuery SolrQuery::setStart(int $start)
public SolrQuery SolrQuery::setStats(bool $flag)
public SolrQuery SolrQuery::setTerms(bool $flag)
public SolrQuery SolrQuery::setTermsField(string $fieldname)
public SolrQuery SolrQuery::setTermsIncludeLowerBound(bool $flag)
public SolrQuery SolrQuery::setTermsIncludeUpperBound(bool $flag)
public SolrQuery SolrQuery::setTermsLimit(int $limit)
public SolrQuery SolrQuery::setTermsLowerBound(string $lowerBound)
public SolrQuery SolrQuery::setTermsMaxCount(int $frequency)
public SolrQuery SolrQuery::setTermsMinCount(int $frequency)
public SolrQuery SolrQuery::setTermsPrefix(string $prefix)
public SolrQuery SolrQuery::setTermsReturnRaw(bool $flag)
public SolrQuery SolrQuery::setTermsSort(int $sortType)
public SolrQuery SolrQuery::setTermsUpperBound(string $upperBound)
public SolrQuery SolrQuery::setTimeAllowed(int $timeAllowed)
}

Predefined Constants

SolrDisMaxQuery::ORDER_ASC

Used to specify that the sorting should be in acending order (Duplicated for easier migration)

SolrDisMaxQuery::ORDER_DESC

Used to specify that the sorting should be in descending order (Duplicated for easier migration)

SolrDisMaxQuery::FACET_SORT_INDEX

Used to specify that the facet should sort by index (Duplicated for easier migration)

SolrDisMaxQuery::FACET_SORT_COUNT

Used to specify that the facet should sort by count (Duplicated for easier migration)

SolrDisMaxQuery::TERMS_SORT_INDEX

Used in the TermsComponent (Duplicated for easier migration)

SolrDisMaxQuery::TERMS_SORT_COUNT

Used in the TermsComponent (Duplicated for easier migration)

Table of Contents