Class: Alfresco::RequestHighlight

Inherits:
Object
  • Object
show all
Defined in:
lib/alfresco/models/request_highlight.rb

Overview

Request that highlight fragments to be added to result set rows The properties reflect SOLR highlighting parameters.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RequestHighlight

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
 
# File 'lib/alfresco/models/request_highlight.rb', line 73

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'prefix')
    self.prefix = attributes[:'prefix']
  end

  if attributes.has_key?(:'postfix')
    self.postfix = attributes[:'postfix']
  end

  if attributes.has_key?(:'snippetCount')
    self.snippet_count = attributes[:'snippetCount']
  end

  if attributes.has_key?(:'fragmentSize')
    self.fragment_size = attributes[:'fragmentSize']
  end

  if attributes.has_key?(:'maxAnalyzedChars')
    self.max_analyzed_chars = attributes[:'maxAnalyzedChars']
  end

  if attributes.has_key?(:'mergeContiguous')
    self.merge_contiguous = attributes[:'mergeContiguous']
  end

  if attributes.has_key?(:'usePhraseHighlighter')
    self.use_phrase_highlighter = attributes[:'usePhraseHighlighter']
  end

  if attributes.has_key?(:'fields')
    if (value = attributes[:'fields']).is_a?(Array)
      self.fields = value
    end
  end

end

Instance Attribute Details

#fields ⇒ Object

The fields to highlight and field specific configuration properties for each field



40
41
42
 
# File 'lib/alfresco/models/request_highlight.rb', line 40

def fields
  @fields
end

#fragment_size ⇒ Object

The character length of each snippet.



28
29
30
 
# File 'lib/alfresco/models/request_highlight.rb', line 28

def fragment_size
  @fragment_size
end

#max_analyzed_chars ⇒ Object

The number of characters to be considered for highlighting. Matches after this count will not be shown.



31
32
33
 
# File 'lib/alfresco/models/request_highlight.rb', line 31

def max_analyzed_chars
  @max_analyzed_chars
end

#merge_contiguous ⇒ Object

If fragments over lap they can be merged into one larger fragment



34
35
36
 
# File 'lib/alfresco/models/request_highlight.rb', line 34

def merge_contiguous
  @merge_contiguous
end

#postfix ⇒ Object

The string used to mark the end of a highlight in a fragment.



22
23
24
 
# File 'lib/alfresco/models/request_highlight.rb', line 22

def postfix
  @postfix
end

#prefix ⇒ Object

The string used to mark the start of a highlight in a fragment.



19
20
21
 
# File 'lib/alfresco/models/request_highlight.rb', line 19

def prefix
  @prefix
end

#snippet_count ⇒ Object

The maximum number of distinct highlight snippets to return for each highlight field.



25
26
27
 
# File 'lib/alfresco/models/request_highlight.rb', line 25

def snippet_count
  @snippet_count
end

#use_phrase_highlighter ⇒ Object

Should phrases be identified.



37
38
39
 
# File 'lib/alfresco/models/request_highlight.rb', line 37

def use_phrase_highlighter
  @use_phrase_highlighter
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/alfresco/models/request_highlight.rb', line 44

def self.attribute_map
  {
    :'prefix' => :'prefix',
    :'postfix' => :'postfix',
    :'snippet_count' => :'snippetCount',
    :'fragment_size' => :'fragmentSize',
    :'max_analyzed_chars' => :'maxAnalyzedChars',
    :'merge_contiguous' => :'mergeContiguous',
    :'use_phrase_highlighter' => :'usePhraseHighlighter',
    :'fields' => :'fields'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/alfresco/models/request_highlight.rb', line 58

def self.swagger_types
  {
    :'prefix' => :'String',
    :'postfix' => :'String',
    :'snippet_count' => :'Integer',
    :'fragment_size' => :'Integer',
    :'max_analyzed_chars' => :'Integer',
    :'merge_contiguous' => :'BOOLEAN',
    :'use_phrase_highlighter' => :'BOOLEAN',
    :'fields' => :'Array<RequestHighlightFields>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/alfresco/models/request_highlight.rb', line 130

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      prefix == o.prefix &&
      postfix == o.postfix &&
      snippet_count == o.snippet_count &&
      fragment_size == o.fragment_size &&
      max_analyzed_chars == o.max_analyzed_chars &&
      merge_contiguous == o.merge_contiguous &&
      use_phrase_highlighter == o.use_phrase_highlighter &&
      fields == o.fields
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/alfresco/models/request_highlight.rb', line 179

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = Alfresco.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/alfresco/models/request_highlight.rb', line 245

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map{ |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/alfresco/models/request_highlight.rb', line 158

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


145
146
147
 
# File 'lib/alfresco/models/request_highlight.rb', line 145

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



151
152
153
 
# File 'lib/alfresco/models/request_highlight.rb', line 151

def hash
  [prefix, postfix, snippet_count, fragment_size, max_analyzed_chars, merge_contiguous, use_phrase_highlighter, fields].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



117
118
119
120
 
# File 'lib/alfresco/models/request_highlight.rb', line 117

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



225
226
227
 
# File 'lib/alfresco/models/request_highlight.rb', line 225

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



231
232
233
234
235
236
237
238
239
 
# File 'lib/alfresco/models/request_highlight.rb', line 231

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



219
220
221
 
# File 'lib/alfresco/models/request_highlight.rb', line 219

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



124
125
126
 
# File 'lib/alfresco/models/request_highlight.rb', line 124

def valid?
  return true
end