Class: Solr::Field

Inherits:
Object
  • Object
show all
Defined in:
lib/solr/field.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.

Constant Summary collapse

VALID_PARAMS =
[:boost]

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params) ⇒ Field

Accepts an optional :boost parameter, used to boost the relevance of a particular field.


20
21
22
23
24
25
26
# File 'lib/solr/field.rb', line 20

def initialize(params)
  boost = params[:boost]
  @name = params[:name].to_s
  @value = params[:value]
  # Convert any Time values into UTC/XML schema format (which Solr requires).
  @value = @value.respond_to?(:utc) ? @value.utc.xmlschema : @value
end

Instance Attribute Details

#boostObject

Returns the value of attribute boost


17
18
19
# File 'lib/solr/field.rb', line 17

def boost
  @boost
end

#nameObject

Returns the value of attribute name


15
16
17
# File 'lib/solr/field.rb', line 15

def name
  @name
end

#valueObject

Returns the value of attribute value


16
17
18
# File 'lib/solr/field.rb', line 16

def value
  @value
end

Instance Method Details

#to_xmlObject


36
37
38
39
40
41
42
# File 'lib/solr/field.rb', line 36

def to_xml
  e = Solr::XML::Element.new 'field'
  e.attributes['name'] = @name
  e.attributes['boost'] = @boost.to_s if @boost
  e.text = @value.to_str
  return e
end

#value_to_jsonhashObject


28
29
30
# File 'lib/solr/field.rb', line 28

def value_to_jsonhash
  @boost.nil? ? @value : {'boost' => @boost, 'value' => @value}
end