Class: Solr::Request::Standard
- Defined in:
- lib/solr/request/standard.rb
Overview
The ASF licenses this file to You under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Direct Known Subclasses
Constant Summary collapse
- VALID_PARAMS =
[:query, :sort, :default_field, :operator, :start, :rows, :shards, :filter_queries, :field_list, :debug_query, :explain_other, :facets, :highlighting, :mlt]
Instance Attribute Summary
Attributes inherited from Select
Instance Method Summary collapse
-
#initialize(params) ⇒ Standard
constructor
A new instance of Standard.
- #to_hash ⇒ Object
Methods inherited from Select
#content_type, #handler, #response_format, #to_s
Methods inherited from Base
#content_type, #handler, #response_format
Constructor Details
#initialize(params) ⇒ Standard
Returns a new instance of Standard.
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 |
# File 'lib/solr/request/standard.rb', line 18 def initialize(params) super('standard') raise "Invalid parameters: #{(params.keys - VALID_PARAMS).join(',')}" unless (params.keys - VALID_PARAMS).empty? raise ":query parameter required" unless params[:query] @params = params.dup # Validate operator if params[:operator] raise "Only :and/:or operators allowed" unless [:and, :or].include?(params[:operator]) @params[:operator] = params[:operator].to_s.upcase end # Validate start, rows can be transformed to ints @params[:start] = params[:start].to_i if params[:start] @params[:rows] = params[:rows].to_i if params[:rows] @params[:field_list] ||= ["*","score"] @params[:shards] ||= [] end |
Instance Method Details
#to_hash ⇒ Object
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 |
# File 'lib/solr/request/standard.rb', line 45 def to_hash hash = {} # standard request param processing sort = @params[:sort].collect do |sort| key = sort.keys[0] "#{key.to_s} #{sort[key] == :descending ? 'desc' : 'asc'}" end.join(',') if @params[:sort] hash[:q] = sort ? "#{@params[:query]};#{sort}" : @params[:query] hash["q.op"] = @params[:operator] hash[:df] = @params[:default_field] # common parameter processing hash[:start] = @params[:start] hash[:rows] = @params[:rows] hash[:fq] = @params[:filter_queries] hash[:fl] = @params[:field_list].join(',') hash[:debugQuery] = @params[:debug_query] hash[:explainOther] = @params[:explain_other] hash[:shards] = @params[:shards].join(',') unless @params[:shards].empty? # facet parameter processing if @params[:facets] # TODO need validation of all that is under the :facets Hash too hash[:facet] = true hash["facet.field"] = [] hash["facet.query"] = @params[:facets][:queries] hash["facet.sort"] = (@params[:facets][:sort] == :count) if @params[:facets][:sort] hash["facet.limit"] = @params[:facets][:limit] hash["facet.missing"] = @params[:facets][:missing] hash["facet.mincount"] = @params[:facets][:mincount] hash["facet.prefix"] = @params[:facets][:prefix] hash["facet.offset"] = @params[:facets][:offset] if @params[:facets][:fields] # facet fields are optional (could be facet.query only) @params[:facets][:fields].each do |f| if f.kind_of? Hash key = f.keys[0] value = f[key] hash["facet.field"] << key hash["f.#{key}.facet.sort"] = (value[:sort] == :count) if value[:sort] hash["f.#{key}.facet.limit"] = value[:limit] hash["f.#{key}.facet.missing"] = value[:missing] hash["f.#{key}.facet.mincount"] = value[:mincount] hash["f.#{key}.facet.prefix"] = value[:prefix] hash["f.#{key}.facet.offset"] = value[:offset] else hash["facet.field"] << f end end end end # highlighting parameter processing - http://wiki.apache.org/solr/HighlightingParameters #TODO need to add per-field overriding to snippets, fragsize, requiredFieldMatch, formatting, and simple.pre/post if @params[:highlighting] hash[:hl] = true hash["hl.fl"] = @params[:highlighting][:field_list].join(',') if @params[:highlighting][:field_list] hash["hl.snippets"] = @params[:highlighting][:max_snippets] hash["hl.requireFieldMatch"] = @params[:highlighting][:require_field_match] hash["hl.simple.pre"] = @params[:highlighting][:prefix] hash["hl.simple.post"] = @params[:highlighting][:suffix] hash["hl.fragsize"] = @params[:highlighting][:fragment_size] if @params[:highlighting][:alternate_fields] @params[:highlighting][:alternate_fields].each do |k,v| hash["f.#{k}.hl.alternateField"] = v end end if @params[:highlighting][:max_alternate_field_length] @params[:highlighting][:max_alternate_field_length].each do |k,v| hash["f.#{k}.hl.maxAlternateFieldLength"] = v end end end if @params[:mlt] hash[:mlt] = true hash["mlt.count"] = @params[:mlt][:count] hash["mlt.fl"] = @params[:mlt][:field_list].join(',') hash["mlt.mintf"] = @params[:mlt][:min_term_freq] hash["mlt.mindf"] = @params[:mlt][:min_doc_freq] hash["mlt.minwl"] = @params[:mlt][:min_word_length] hash["mlt.maxwl"] = @params[:mlt][:max_word_length] hash["mlt.maxqt"] = @params[:mlt][:max_query_terms] hash["mlt.maxntp"] = @params[:mlt][:max_tokens_parsed] hash["mlt.boost"] = @params[:mlt][:boost] end hash.merge(super.to_hash) end |