Class: TCAClient::SimilarityViewSettings
- Inherits:
-
Object
- Object
- TCAClient::SimilarityViewSettings
- Defined in:
- lib/tca_client/models/similarity_view_settings.rb
Instance Attribute Summary collapse
-
#exclude_abstract ⇒ Object
If set to true, text in the abstract section of the submission will not count as similar content.
-
#exclude_bibliography ⇒ Object
If set to true, text in a bibliography section will not count as similar content.
-
#exclude_citations ⇒ Object
If set to true, text in citations will not count as similar content.
-
#exclude_crossref ⇒ Object
If set to true, text matched to the Crossref collection will not count as similar content.
-
#exclude_crossref_posted_content ⇒ Object
If set to true, text matched to the Crossref Posted Content collection will not count as similar content.
-
#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.
-
#exclude_internet ⇒ Object
If set to true, text matched to the internet collection will not count as similar content.
-
#exclude_methods ⇒ Object
If set to true, text in the method section of the submission will not count as similar content.
-
#exclude_preprints ⇒ Object
If set to true, it will exclude preprints.
-
#exclude_publications ⇒ Object
If set to true, text matched to the publications collection will not count as similar content.
-
#exclude_quotes ⇒ Object
If set to true, text in quotes will not count as similar content.
-
#exclude_small_matches ⇒ Object
If set, similarity matches that match less than the specified amount of words will not count as similar content.
-
#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.
Class Method Summary collapse
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ SimilarityViewSettings
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ SimilarityViewSettings
Initializes the object
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 166 167 168 169 170 171 172 |
# File 'lib/tca_client/models/similarity_view_settings.rb', line 108 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
28 29 30 |
# File 'lib/tca_client/models/similarity_view_settings.rb', line 28 def exclude_abstract @exclude_abstract end |
#exclude_bibliography ⇒ Object
If set to true, text in a bibliography section will not count as similar content
22 23 24 |
# File 'lib/tca_client/models/similarity_view_settings.rb', line 22 def exclude_bibliography @exclude_bibliography end |
#exclude_citations ⇒ Object
If set to true, text in citations will not count as similar content
25 26 27 |
# File 'lib/tca_client/models/similarity_view_settings.rb', line 25 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
43 44 45 |
# File 'lib/tca_client/models/similarity_view_settings.rb', line 43 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
46 47 48 |
# File 'lib/tca_client/models/similarity_view_settings.rb', line 46 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
52 53 54 |
# File 'lib/tca_client/models/similarity_view_settings.rb', line 52 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
37 38 39 |
# File 'lib/tca_client/models/similarity_view_settings.rb', line 37 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
31 32 33 |
# File 'lib/tca_client/models/similarity_view_settings.rb', line 31 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.
55 56 57 |
# File 'lib/tca_client/models/similarity_view_settings.rb', line 55 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
40 41 42 |
# File 'lib/tca_client/models/similarity_view_settings.rb', line 40 def exclude_publications @exclude_publications end |
#exclude_quotes ⇒ Object
If set to true, text in quotes will not count as similar content
19 20 21 |
# File 'lib/tca_client/models/similarity_view_settings.rb', line 19 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
34 35 36 |
# File 'lib/tca_client/models/similarity_view_settings.rb', line 34 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
49 50 51 |
# File 'lib/tca_client/models/similarity_view_settings.rb', line 49 def exclude_submitted_works @exclude_submitted_works end |
Class Method Details
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
77 78 79 |
# File 'lib/tca_client/models/similarity_view_settings.rb', line 77 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 |
# File 'lib/tca_client/models/similarity_view_settings.rb', line 58 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
222 223 224 |
# File 'lib/tca_client/models/similarity_view_settings.rb', line 222 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
101 102 103 104 |
# File 'lib/tca_client/models/similarity_view_settings.rb', line 101 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 |
# File 'lib/tca_client/models/similarity_view_settings.rb', line 82 def self.openapi_types { :'exclude_quotes' => :'Boolean', :'exclude_bibliography' => :'Boolean', :'exclude_citations' => :'Boolean', :'exclude_abstract' => :'Boolean', :'exclude_methods' => :'Boolean', :'exclude_small_matches' => :'Integer', :'exclude_internet' => :'Boolean', :'exclude_publications' => :'Boolean', :'exclude_crossref' => :'Boolean', :'exclude_crossref_posted_content' => :'Boolean', :'exclude_submitted_works' => :'Boolean', :'exclude_custom_sections' => :'Boolean', :'exclude_preprints' => :'Boolean' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 |
# File 'lib/tca_client/models/similarity_view_settings.rb', line 189 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
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 281 282 283 284 285 286 287 288 289 290 |
# File 'lib/tca_client/models/similarity_view_settings.rb', line 253 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
324 325 326 327 328 329 330 331 332 333 334 335 336 |
# File 'lib/tca_client/models/similarity_view_settings.rb', line 324 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
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 |
# File 'lib/tca_client/models/similarity_view_settings.rb', line 229 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
209 210 211 |
# File 'lib/tca_client/models/similarity_view_settings.rb', line 209 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
215 216 217 |
# File 'lib/tca_client/models/similarity_view_settings.rb', line 215 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?
176 177 178 179 |
# File 'lib/tca_client/models/similarity_view_settings.rb', line 176 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
300 301 302 |
# File 'lib/tca_client/models/similarity_view_settings.rb', line 300 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
306 307 308 309 310 311 312 313 314 315 316 317 318 |
# File 'lib/tca_client/models/similarity_view_settings.rb', line 306 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
294 295 296 |
# File 'lib/tca_client/models/similarity_view_settings.rb', line 294 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
183 184 185 |
# File 'lib/tca_client/models/similarity_view_settings.rb', line 183 def valid? true end |