Class: FeedTools::OpensearchQuery

Inherits:
Object
  • Object
show all
Defined in:
lib/opensearch_query.rb

Instance Method Summary collapse

Constructor Details

#initialize(role = 'request', attributes = {}) ⇒ OpensearchQuery

Returns a new instance of OpensearchQuery.



3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
 
# File 'lib/opensearch_query.rb', line 3

def initialize(role='request', attributes={})
  @role = self.role=role
  @title = nil
  @search_terms = nil
  @total_results = nil
  @count = nil
  @start_index = nil
  @start_page = nil
  @language = nil
  @input_encoding = nil
  @output_encoding = nil
  attributes.each { | key, val |
    next unless val
    iv = "@"+key.to_s
    self.instance_variable_set(iv.to_sym, val) if self.instance_variables.index(iv)
  }
end

Instance Method Details

#build_xml(xml) ⇒ Object 



82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/opensearch_query.rb', line 82

def build_xml(xml)
  attrs = {}
  attrs[:role]=@role if @role
  attrs[:title]=@title if @title
  attrs[:count]=@count if @count
  attrs[:language]=@language if @language
  attrs[:searchTerms]=@search_terms if @search_terms
  attrs[:startIndex]=@start_index if @start_index
  attrs[:startPage]=@start_page if @start_page
  attrs[:inputEncoding]=@input_encoding if @input_encoding
  attrs[:outputEncoding]=@output_encoding if @output_encoding      
  attrs[:totalResults]=@total_results if @total_results
  xml.tag!("opensearch:Query", attrs)
end

#count ⇒ Object 



46
47
48
 
# File 'lib/opensearch_query.rb', line 46

def count
  return @count
end

#count=(count) ⇒ Object 



49
50
51
 
# File 'lib/opensearch_query.rb', line 49

def count=(count)
  @count=count
end

#input_encoding ⇒ Object 



70
71
72
 
# File 'lib/opensearch_query.rb', line 70

def input_encoding
  return @input_encoding
end

#input_encoding=(ip) ⇒ Object 



73
74
75
 
# File 'lib/opensearch_query.rb', line 73

def input_encoding=(ip)
  @input_encoding=ip
end

#language ⇒ Object 



64
65
66
 
# File 'lib/opensearch_query.rb', line 64

def language
  return @language
end

#language=(lang) ⇒ Object 



67
68
69
 
# File 'lib/opensearch_query.rb', line 67

def language=(lang)
  @language=lang
end

#output_encoding ⇒ Object 



76
77
78
 
# File 'lib/opensearch_query.rb', line 76

def output_encoding
  return @output_encoding
end

#output_encoding=(op) ⇒ Object 



79
80
81
 
# File 'lib/opensearch_query.rb', line 79

def output_encoding=(op)
  @output_encoding=op
end

#role ⇒ Object 



20
21
22
 
# File 'lib/opensearch_query.rb', line 20

def role
  return @role
end

#role=(role) ⇒ Object

Raises:

  • (ArgumentError) 


23
24
25
26
27
 
# File 'lib/opensearch_query.rb', line 23

def role=(role)
  roles = ["request","example","related","correction","subset","superset"]
  raise(ArgumentError, "Must be a valid role") unless roles.index(role)
  @role=role
end

#search_terms ⇒ Object 



34
35
36
 
# File 'lib/opensearch_query.rb', line 34

def search_terms
  return @search_terms
end

#search_terms=(search_terms) ⇒ Object 



37
38
39
 
# File 'lib/opensearch_query.rb', line 37

def search_terms=(search_terms)
  @search_terms=search_terms
end

#start_index ⇒ Object 



52
53
54
 
# File 'lib/opensearch_query.rb', line 52

def start_index
  return @start_index
end

#start_index=(start_index) ⇒ Object 



55
56
57
 
# File 'lib/opensearch_query.rb', line 55

def start_index=(start_index)
  @start_index=start_index
end

#start_page ⇒ Object 



58
59
60
 
# File 'lib/opensearch_query.rb', line 58

def start_page
  return @start_page
end

#start_page=(start_page) ⇒ Object 



61
62
63
 
# File 'lib/opensearch_query.rb', line 61

def start_page=(start_page)
  @start_page=start_page
end

#title ⇒ Object 



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

def title
  return @title
end

#title=(title) ⇒ Object 



31
32
33
 
# File 'lib/opensearch_query.rb', line 31

def title=(title)
  @title=title
end

#total_results ⇒ Object 



40
41
42
 
# File 'lib/opensearch_query.rb', line 40

def total_results
  return @total_results
end

#total_results=(total_results) ⇒ Object 



43
44
45
 
# File 'lib/opensearch_query.rb', line 43

def total_results=(total_results)
  @total_results=total_results
end