Class: TCAClient::SimilarityViewSettings

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SimilarityViewSettings

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/tca_client/models/similarity_view_settings.rb', line 101

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TCAClient::SimilarityViewSettings` 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::SimilarityViewSettings`. 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?(:'exclude_quotes')
    self.exclude_quotes = attributes[:'exclude_quotes']
  end

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#exclude_abstract ⇒ Object

If set to true, text in the abstract section of the submission will not count as similar content



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

def exclude_abstract
  @exclude_abstract
end

#exclude_bibliography ⇒ Object

If set to true, text in a bibliography section will not count as similar content



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

def exclude_bibliography
  @exclude_bibliography
end

#exclude_citations ⇒ Object

If set to true, text in citations will not count as similar content



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

def exclude_citations
  @exclude_citations
end

#exclude_crossref ⇒ Object

If set to true, text matched to the Crossref collection will not count as similar content



41
42
43
 
# File 'lib/tca_client/models/similarity_view_settings.rb', line 41

def exclude_crossref
  @exclude_crossref
end

#exclude_crossref_posted_content ⇒ Object

If set to true, text matched to the Crossref Posted Content collection will not count as similar content



44
45
46
 
# File 'lib/tca_client/models/similarity_view_settings.rb', line 44

def exclude_crossref_posted_content
  @exclude_crossref_posted_content
end

#exclude_custom_sections ⇒ Object

If set to true, text matched to the custom sections defined in the admin settings will not count as similar content calculated as if section was not part of the paper



50
51
52
 
# File 'lib/tca_client/models/similarity_view_settings.rb', line 50

def exclude_custom_sections
  @exclude_custom_sections
end

#exclude_internet ⇒ Object

If set to true, text matched to the internet collection will not count as similar content



35
36
37
 
# File 'lib/tca_client/models/similarity_view_settings.rb', line 35

def exclude_internet
  @exclude_internet
end

#exclude_methods ⇒ Object

If set to true, text in the method section of the submission will not count as similar content



29
30
31
 
# File 'lib/tca_client/models/similarity_view_settings.rb', line 29

def exclude_methods
  @exclude_methods
end

#exclude_preprints ⇒ Object

If set to true, it will exclude preprints. A preprint is a version of a scholarly or scientific paper that precedes formal peer review and publication in a peer-reviewed scholarly or scientific journal.



53
54
55
 
# File 'lib/tca_client/models/similarity_view_settings.rb', line 53

def exclude_preprints
  @exclude_preprints
end

#exclude_publications ⇒ Object

If set to true, text matched to the publications collection will not count as similar content



38
39
40
 
# File 'lib/tca_client/models/similarity_view_settings.rb', line 38

def exclude_publications
  @exclude_publications
end

#exclude_quotes ⇒ Object

If set to true, text in quotes will not count as similar content



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

def exclude_quotes
  @exclude_quotes
end

#exclude_small_matches ⇒ Object

If set, similarity matches that match less than the specified amount of words will not count as similar content



32
33
34
 
# File 'lib/tca_client/models/similarity_view_settings.rb', line 32

def exclude_small_matches
  @exclude_small_matches
end

#exclude_submitted_works ⇒ Object

If set to true, text matched to the submitted works collection will not count as similar content calculated as if submitted work was not part of the paper



47
48
49
 
# File 'lib/tca_client/models/similarity_view_settings.rb', line 47

def exclude_submitted_works
  @exclude_submitted_works
end

Class Method Details

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/tca_client/models/similarity_view_settings.rb', line 56

def self.attribute_map
  {
    :'exclude_quotes' => :'exclude_quotes',
    :'exclude_bibliography' => :'exclude_bibliography',
    :'exclude_citations' => :'exclude_citations',
    :'exclude_abstract' => :'exclude_abstract',
    :'exclude_methods' => :'exclude_methods',
    :'exclude_small_matches' => :'exclude_small_matches',
    :'exclude_internet' => :'exclude_internet',
    :'exclude_publications' => :'exclude_publications',
    :'exclude_crossref' => :'exclude_crossref',
    :'exclude_crossref_posted_content' => :'exclude_crossref_posted_content',
    :'exclude_submitted_works' => :'exclude_submitted_works',
    :'exclude_custom_sections' => :'exclude_custom_sections',
    :'exclude_preprints' => :'exclude_preprints'
  }
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



215
216
217
 
# File 'lib/tca_client/models/similarity_view_settings.rb', line 215

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



94
95
96
97
 
# File 'lib/tca_client/models/similarity_view_settings.rb', line 94

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/tca_client/models/similarity_view_settings.rb', line 75

def self.openapi_types
  {
    :'exclude_quotes' => :'Object',
    :'exclude_bibliography' => :'Object',
    :'exclude_citations' => :'Object',
    :'exclude_abstract' => :'Object',
    :'exclude_methods' => :'Object',
    :'exclude_small_matches' => :'Object',
    :'exclude_internet' => :'Object',
    :'exclude_publications' => :'Object',
    :'exclude_crossref' => :'Object',
    :'exclude_crossref_posted_content' => :'Object',
    :'exclude_submitted_works' => :'Object',
    :'exclude_custom_sections' => :'Object',
    :'exclude_preprints' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/tca_client/models/similarity_view_settings.rb', line 182

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      exclude_quotes == o.exclude_quotes &&
      exclude_bibliography == o.exclude_bibliography &&
      exclude_citations == o.exclude_citations &&
      exclude_abstract == o.exclude_abstract &&
      exclude_methods == o.exclude_methods &&
      exclude_small_matches == o.exclude_small_matches &&
      exclude_internet == o.exclude_internet &&
      exclude_publications == o.exclude_publications &&
      exclude_crossref == o.exclude_crossref &&
      exclude_crossref_posted_content == o.exclude_crossref_posted_content &&
      exclude_submitted_works == o.exclude_submitted_works &&
      exclude_custom_sections == o.exclude_custom_sections &&
      exclude_preprints == o.exclude_preprints
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



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/tca_client/models/similarity_view_settings.rb', line 245

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



314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/tca_client/models/similarity_view_settings.rb', line 314

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



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/tca_client/models/similarity_view_settings.rb', line 222

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  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


202
203
204
 
# File 'lib/tca_client/models/similarity_view_settings.rb', line 202

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



208
209
210
 
# File 'lib/tca_client/models/similarity_view_settings.rb', line 208

def hash
  [exclude_quotes, exclude_bibliography, exclude_citations, exclude_abstract, exclude_methods, exclude_small_matches, exclude_internet, exclude_publications, exclude_crossref, exclude_crossref_posted_content, exclude_submitted_works, exclude_custom_sections, exclude_preprints].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



169
170
171
172
 
# File 'lib/tca_client/models/similarity_view_settings.rb', line 169

def list_invalid_properties
  invalid_properties = Array.new
  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



290
291
292
 
# File 'lib/tca_client/models/similarity_view_settings.rb', line 290

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



296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/tca_client/models/similarity_view_settings.rb', line 296

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



284
285
286
 
# File 'lib/tca_client/models/similarity_view_settings.rb', line 284

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



176
177
178
 
# File 'lib/tca_client/models/similarity_view_settings.rb', line 176

def valid?
  true
end