Class: TCAClient::SimilarityMetadata

Inherits:
Object
  • Object
show all
Defined in:
lib/tca_client/models/similarity_metadata.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SimilarityMetadata

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 103

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TCAClient::SimilarityMetadata` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `TCAClient::SimilarityMetadata`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'overall_match_percentage')
    self.overall_match_percentage = attributes[:'overall_match_percentage']
  end

  if attributes.key?(:'internet_match_percentage')
    self.internet_match_percentage = attributes[:'internet_match_percentage']
  end

  if attributes.key?(:'publication_match_percentage')
    self.publication_match_percentage = attributes[:'publication_match_percentage']
  end

  if attributes.key?(:'submitted_works_match_percentage')
    self.submitted_works_match_percentage = attributes[:'submitted_works_match_percentage']
  end

  if attributes.key?(:'submission_id')
    self.submission_id = attributes[:'submission_id']
  end

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.key?(:'time_generated')
    self.time_generated = attributes[:'time_generated']
  end

  if attributes.key?(:'time_requested')
    self.time_requested = attributes[:'time_requested']
  end

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

  if attributes.key?(:'top_source_largest_matched_word_count')
    self.top_source_largest_matched_word_count = attributes[:'top_source_largest_matched_word_count']
  end
end

Instance Attribute Details

#internet_match_percentage ⇒ Object

Represents the percentage match against internet



22
23
24
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 22

def internet_match_percentage
  @internet_match_percentage
end

#overall_match_percentage ⇒ Object

Represents the percentage match against all sources



19
20
21
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 19

def overall_match_percentage
  @overall_match_percentage
end

#publication_match_percentage ⇒ Object

Represents the percentage match against all publications



25
26
27
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 25

def publication_match_percentage
  @publication_match_percentage
end

#status ⇒ Object

possible values PENDING, COMPLETE



33
34
35
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 33

def status
  @status
end

#submission_id ⇒ Object

Returns the value of attribute submission_id.



30
31
32
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 30

def submission_id
  @submission_id
end

#submitted_works_match_percentage ⇒ Object

Represents the percentage match against all submitted works



28
29
30
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 28

def submitted_works_match_percentage
  @submitted_works_match_percentage
end

#time_generated ⇒ Object

Time the report finished generating. If not set the report has not finished generating



36
37
38
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 36

def time_generated
  @time_generated
end

#time_requested ⇒ Object

Time the report was requested



39
40
41
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 39

def time_requested
  @time_requested
end

#top_matches ⇒ Object

Top matches



42
43
44
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 42

def top_matches
  @top_matches
end

#top_source_largest_matched_word_count ⇒ Object

Largest individual matched word count, 0 if there isn’t a match to this submission.



45
46
47
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 45

def top_source_largest_matched_word_count
  @top_source_largest_matched_word_count
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



64
65
66
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 64

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 48

def self.attribute_map
  {
    :'overall_match_percentage' => :'overall_match_percentage',
    :'internet_match_percentage' => :'internet_match_percentage',
    :'publication_match_percentage' => :'publication_match_percentage',
    :'submitted_works_match_percentage' => :'submitted_works_match_percentage',
    :'submission_id' => :'submission_id',
    :'status' => :'status',
    :'time_generated' => :'time_generated',
    :'time_requested' => :'time_requested',
    :'top_matches' => :'top_matches',
    :'top_source_largest_matched_word_count' => :'top_source_largest_matched_word_count'
  }
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



239
240
241
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 239

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



94
95
96
97
98
99
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 94

def self.openapi_all_of
  [
  :'SimilarityMetadataAllOf',
  :'SimilarityScoreData'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



85
86
87
88
89
90
91
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 85

def self.openapi_nullable
  Set.new([
    :'internet_match_percentage',
    :'publication_match_percentage',
    :'submitted_works_match_percentage',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 69

def self.openapi_types
  {
    :'overall_match_percentage' => :'Integer',
    :'internet_match_percentage' => :'Integer',
    :'publication_match_percentage' => :'Integer',
    :'submitted_works_match_percentage' => :'Integer',
    :'submission_id' => :'String',
    :'status' => :'String',
    :'time_generated' => :'String',
    :'time_requested' => :'String',
    :'top_matches' => :'Array<SimilarityMetadataAllOfTopMatches>',
    :'top_source_largest_matched_word_count' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 209

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      overall_match_percentage == o.overall_match_percentage &&
      internet_match_percentage == o.internet_match_percentage &&
      publication_match_percentage == o.publication_match_percentage &&
      submitted_works_match_percentage == o.submitted_works_match_percentage &&
      submission_id == o.submission_id &&
      status == o.status &&
      time_generated == o.time_generated &&
      time_requested == o.time_requested &&
      top_matches == o.top_matches &&
      top_source_largest_matched_word_count == o.top_source_largest_matched_word_count
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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 270

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = TCAClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 341

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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 246

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


226
227
228
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 226

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



232
233
234
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 232

def hash
  [overall_match_percentage, internet_match_percentage, publication_match_percentage, submitted_works_match_percentage, submission_id, status, time_generated, time_requested, top_matches, top_source_largest_matched_word_count].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 161

def list_invalid_properties
  invalid_properties = Array.new
  if @overall_match_percentage.nil?
    invalid_properties.push('invalid value for "overall_match_percentage", overall_match_percentage cannot be nil.')
  end

  if @submission_id.nil?
    invalid_properties.push('invalid value for "submission_id", submission_id cannot be nil.')
  end

  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  end

  if @time_generated.nil?
    invalid_properties.push('invalid value for "time_generated", time_generated cannot be nil.')
  end

  if @time_requested.nil?
    invalid_properties.push('invalid value for "time_requested", time_requested cannot be nil.')
  end

  if @top_matches.nil?
    invalid_properties.push('invalid value for "top_matches", top_matches cannot be nil.')
  end

  if @top_source_largest_matched_word_count.nil?
    invalid_properties.push('invalid value for "top_source_largest_matched_word_count", top_source_largest_matched_word_count cannot be nil.')
  end

  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



317
318
319
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 317

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



323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 323

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



311
312
313
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 311

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



196
197
198
199
200
201
202
203
204
205
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 196

def valid?
  return false if @overall_match_percentage.nil?
  return false if @submission_id.nil?
  return false if @status.nil?
  return false if @time_generated.nil?
  return false if @time_requested.nil?
  return false if @top_matches.nil?
  return false if @top_source_largest_matched_word_count.nil?
  true
end