The SolrDisMaxQuery class

(No version information available, might only be in Git)

Introduction

Class synopsis

SolrDisMaxQuery extends SolrQuery implements Serializable {

/* Inherited properties */

const integer SolrQuery::ORDER_ASC = 0 ;

const integer SolrQuery::ORDER_DESC = 1 ;

const integer SolrQuery::FACET_SORT_INDEX = 0 ;

const integer SolrQuery::FACET_SORT_COUNT = 1 ;

const integer SolrQuery::TERMS_SORT_INDEX = 0 ;

const integer SolrQuery::TERMS_SORT_COUNT = 1 ;

/* Methods */

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 __construct ([ string $q ] )

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 ( void )

public SolrDisMaxQuery useEDisMaxQueryParser ( void )

/* 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 [, integer $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 SolrQuery::__construct ([ string $q ] )

public void SolrQuery::__destruct ( void )

public bool SolrQuery::getExpand ( void )

public array SolrQuery::getExpandFilterQueries ( void )

public array SolrQuery::getExpandQuery ( void )

public integer SolrQuery::getExpandRows ( void )

public array SolrQuery::getExpandSortFields ( void )

public bool SolrQuery::getFacet ( void )

public string SolrQuery::getFacetDateEnd ([ string $field_override ] )

public array SolrQuery::getFacetDateFields ( void )

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 ( void )

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 ( void )

public int SolrQuery::getFacetSort ([ string $field_override ] )

public array SolrQuery::getFields ( void )

public array SolrQuery::getFilterQueries ( void )

public bool SolrQuery::getGroup ( void )

public integer SolrQuery::getGroupCachePercent ( void )

public bool SolrQuery::getGroupFacet ( void )

public array SolrQuery::getGroupFields ( void )

public string SolrQuery::getGroupFormat ( void )

public array SolrQuery::getGroupFunctions ( void )

public integer SolrQuery::getGroupLimit ( void )

public bool SolrQuery::getGroupMain ( void )

public bool SolrQuery::getGroupNGroups ( void )

public integer SolrQuery::getGroupOffset ( void )

public array SolrQuery::getGroupQueries ( void )

public array SolrQuery::getGroupSortFields ( void )

public bool SolrQuery::getGroupTruncate ( void )

public bool SolrQuery::getHighlight ( void )

public string SolrQuery::getHighlightAlternateField ([ string $field_override ] )

public array SolrQuery::getHighlightFields ( void )

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 ( void )

public int SolrQuery::getHighlightMaxAlternateFieldLength ([ string $field_override ] )

public int SolrQuery::getHighlightMaxAnalyzedChars ( void )

public bool SolrQuery::getHighlightMergeContiguous ([ string $field_override ] )

public int SolrQuery::getHighlightRegexMaxAnalyzedChars ( void )

public string SolrQuery::getHighlightRegexPattern ( void )

public float SolrQuery::getHighlightRegexSlop ( void )

public bool SolrQuery::getHighlightRequireFieldMatch ( void )

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 ( void )

public bool SolrQuery::getMlt ( void )

public bool SolrQuery::getMltBoost ( void )

public int SolrQuery::getMltCount ( void )

public array SolrQuery::getMltFields ( void )

public int SolrQuery::getMltMaxNumQueryTerms ( void )

public int SolrQuery::getMltMaxNumTokens ( void )

public int SolrQuery::getMltMaxWordLength ( void )

public int SolrQuery::getMltMinDocFrequency ( void )

public int SolrQuery::getMltMinTermFrequency ( void )

public int SolrQuery::getMltMinWordLength ( void )

public array SolrQuery::getMltQueryFields ( void )

public string SolrQuery::getQuery ( void )

public int SolrQuery::getRows ( void )

public array SolrQuery::getSortFields ( void )

public int SolrQuery::getStart ( void )

public bool SolrQuery::getStats ( void )

public array SolrQuery::getStatsFacets ( void )

public array SolrQuery::getStatsFields ( void )

public bool SolrQuery::getTerms ( void )

public string SolrQuery::getTermsField ( void )

public bool SolrQuery::getTermsIncludeLowerBound ( void )

public bool SolrQuery::getTermsIncludeUpperBound ( void )

public int SolrQuery::getTermsLimit ( void )

public string SolrQuery::getTermsLowerBound ( void )

public int SolrQuery::getTermsMaxCount ( void )

public int SolrQuery::getTermsMinCount ( void )

public string SolrQuery::getTermsPrefix ( void )

public bool SolrQuery::getTermsReturnRaw ( void )

public int SolrQuery::getTermsSort ( void )

public string SolrQuery::getTermsUpperBound ( void )

public int SolrQuery::getTimeAllowed ( void )

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 ( integer $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 ( integer $percent )

public SolrQuery SolrQuery::setGroupFacet ( bool $value )

public SolrQuery SolrQuery::setGroupFormat ( string $value )

public SolrQuery SolrQuery::setGroupLimit ( integer $value )

public SolrQuery SolrQuery::setGroupMain ( string $value )

public SolrQuery SolrQuery::setGroupNGroups ( bool $value )

public SolrQuery SolrQuery::setGroupOffset ( integer $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::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)

SolrDisMaxQuery::addBigramPhraseField — Adds a Phrase Bigram Field (pf2 parameter)
SolrDisMaxQuery::addBoostQuery — Adds a boost query field with value and optional boost (bq parameter)
SolrDisMaxQuery::addPhraseField — Adds a Phrase Field (pf parameter)
SolrDisMaxQuery::addQueryField — Add a query field with optional boost (qf parameter)
SolrDisMaxQuery::addTrigramPhraseField — Adds a Trigram Phrase Field (pf3 parameter)
SolrDisMaxQuery::addUserField — Adds a field to User Fields Parameter (uf)
SolrDisMaxQuery::__construct — Class Constructor
SolrDisMaxQuery::removeBigramPhraseField — Removes phrase bigram field (pf2 parameter)
SolrDisMaxQuery::removeBoostQuery — Removes a boost query partial by field name (bq)
SolrDisMaxQuery::removePhraseField — Removes a Phrase Field (pf parameter)
SolrDisMaxQuery::removeQueryField — Removes a Query Field (qf parameter)
SolrDisMaxQuery::removeTrigramPhraseField — Removes a Trigram Phrase Field (pf3 parameter)
SolrDisMaxQuery::removeUserField — Removes a field from The User Fields Parameter (uf)
SolrDisMaxQuery::setBigramPhraseFields — Sets Bigram Phrase Fields and their boosts (and slops) using pf2 parameter
SolrDisMaxQuery::setBigramPhraseSlop — Sets Bigram Phrase Slop (ps2 parameter)
SolrDisMaxQuery::setBoostFunction — Sets a Boost Function (bf parameter).
SolrDisMaxQuery::setBoostQuery — Directly Sets Boost Query Parameter (bq)
SolrDisMaxQuery::setMinimumMatch — Set Minimum "Should" Match (mm)
SolrDisMaxQuery::setPhraseFields — Sets Phrase Fields and their boosts (and slops) using pf2 parameter
SolrDisMaxQuery::setPhraseSlop — Sets the default slop on phrase queries (ps parameter)
SolrDisMaxQuery::setQueryAlt — Set Query Alternate (q.alt parameter)
SolrDisMaxQuery::setQueryPhraseSlop — specifies the amount of slop permitted on phrase queries explicitly included in the user's query string (qf parameter)
SolrDisMaxQuery::setTieBreaker — Sets Tie Breaker parameter (tie parameter)
SolrDisMaxQuery::setTrigramPhraseFields — Directly Sets Trigram Phrase Fields (pf3 parameter)
SolrDisMaxQuery::setTrigramPhraseSlop — Sets Trigram Phrase Slop (ps3 parameter)
SolrDisMaxQuery::setUserFields — Sets User Fields parameter (uf)
SolrDisMaxQuery::useDisMaxQueryParser — Switch QueryParser to be DisMax Query Parser
SolrDisMaxQuery::useEDisMaxQueryParser — Switch QueryParser to be EDisMax

User Contributed Notes

There are no user contributed notes for this page.

The SolrDisMaxQuery class

Introduction

Class synopsis

Predefined Constants

Table of Contents

User Contributed Notes