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



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
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 88

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
  }

  # call parent's initialize
  super(attributes)

  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



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

def internet_match_percentage
  @internet_match_percentage
end

#overall_match_percentage ⇒ Object

Represents the percentage match against all sources



17
18
19
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 17

def overall_match_percentage
  @overall_match_percentage
end

#publication_match_percentage ⇒ Object

Represents the percentage match against all publications



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

def publication_match_percentage
  @publication_match_percentage
end

#status ⇒ Object

possible values PENDING, COMPLETE



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

def status
  @status
end

#submission_id ⇒ Object

Returns the value of attribute submission_id.



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

def submission_id
  @submission_id
end

#submitted_works_match_percentage ⇒ Object

Represents the percentage match against all submitted works



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

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



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

def time_generated
  @time_generated
end

#time_requested ⇒ Object

Time the report was requested



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

def time_requested
  @time_requested
end

#top_matches ⇒ Object

Top matches



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

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.



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

def top_source_largest_matched_word_count
  @top_source_largest_matched_word_count
end

Class Method Details

.attribute_map ⇒ Object

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



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

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



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

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



78
79
80
81
82
83
84
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 78

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

.openapi_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 62

def self.openapi_types
  {
    :'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' => :''
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 197

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 && super(o)
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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 258

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
    TCAClient.const_get(type).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



327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 327

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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 234

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  self.class.openapi_types.each_pair do |key, type|
    if 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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


214
215
216
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 214

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



220
221
222
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 220

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



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 149

def list_invalid_properties
  invalid_properties = super
  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



303
304
305
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 303

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



309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 309

def to_hash
  hash = super
  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



297
298
299
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 297

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



184
185
186
187
188
189
190
191
192
193
 
# File 'lib/tca_client/models/similarity_metadata.rb', line 184

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