Class: AsposeWordsCloud::CompareOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_words_cloud/models/compare_options.rb

Overview

DTO container with compare documents options.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CompareOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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/aspose_words_cloud/models/compare_options.rb', line 123

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.key?(:'AcceptAllRevisionsBeforeComparison')
    self.accept_all_revisions_before_comparison = attributes[:'AcceptAllRevisionsBeforeComparison']
  end

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#accept_all_revisions_before_comparison ⇒ Object

Gets or sets whether accept revisions before comparison or not.



33
34
35
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 33

def accept_all_revisions_before_comparison
  @accept_all_revisions_before_comparison
end

#granularity ⇒ Object

Gets or sets the option indicating whether changes are tracked by character or by word.



36
37
38
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 36

def granularity
  @granularity
end

#ignore_case_changes ⇒ Object

Gets or sets a value indicating whether documents comparison is case insensitive. By default comparison is case sensitive.



39
40
41
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 39

def ignore_case_changes
  @ignore_case_changes
end

#ignore_comments ⇒ Object

Gets or sets a value indicating whether comments content is ignored. By default comments are not ignored.



42
43
44
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 42

def ignore_comments
  @ignore_comments
end

#ignore_fields ⇒ Object

Gets or sets a value indicating whether fields content is ignored. By default fields are not ignored.



45
46
47
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 45

def ignore_fields
  @ignore_fields
end

#ignore_footnotes ⇒ Object

Gets or sets a value indicating whether footnotes/endnotes content is ignored. By default footnotes/endnotes are not ignored.



48
49
50
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 48

def ignore_footnotes
  @ignore_footnotes
end

#ignore_formatting ⇒ Object

Gets or sets a value indicating whether formatting is ignored. By default document formatting is not ignored.



51
52
53
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 51

def ignore_formatting
  @ignore_formatting
end

#ignore_headers_and_footers ⇒ Object

Gets or sets a value indicating whether headers and footers content is ignored. By default headers and footers are not ignored.



54
55
56
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 54

def ignore_headers_and_footers
  @ignore_headers_and_footers
end

#ignore_tables ⇒ Object

Gets or sets a value indicating whether tables content is ignored. By default tables are not ignored.



57
58
59
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 57

def ignore_tables
  @ignore_tables
end

#ignore_textboxes ⇒ Object

Gets or sets a value indicating whether textboxes content is ignored. By default textboxes are not ignored.



60
61
62
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 60

def ignore_textboxes
  @ignore_textboxes
end

#target ⇒ Object

Gets or sets the option that controls which document shall be used as a target during comparison.



63
64
65
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 63

def target
  @target
end

Class Method Details

.attribute_map ⇒ Object

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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 88

def self.attribute_map
  {
    :'accept_all_revisions_before_comparison' => :'AcceptAllRevisionsBeforeComparison',
    :'granularity' => :'Granularity',
    :'ignore_case_changes' => :'IgnoreCaseChanges',
    :'ignore_comments' => :'IgnoreComments',
    :'ignore_fields' => :'IgnoreFields',
    :'ignore_footnotes' => :'IgnoreFootnotes',
    :'ignore_formatting' => :'IgnoreFormatting',
    :'ignore_headers_and_footers' => :'IgnoreHeadersAndFooters',
    :'ignore_tables' => :'IgnoreTables',
    :'ignore_textboxes' => :'IgnoreTextboxes',
    :'target' => :'Target'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 105

def self.swagger_types
  {
    :'accept_all_revisions_before_comparison' => :'BOOLEAN',
    :'granularity' => :'String',
    :'ignore_case_changes' => :'BOOLEAN',
    :'ignore_comments' => :'BOOLEAN',
    :'ignore_fields' => :'BOOLEAN',
    :'ignore_footnotes' => :'BOOLEAN',
    :'ignore_formatting' => :'BOOLEAN',
    :'ignore_headers_and_footers' => :'BOOLEAN',
    :'ignore_tables' => :'BOOLEAN',
    :'ignore_textboxes' => :'BOOLEAN',
    :'target' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 216

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      accept_all_revisions_before_comparison == other.accept_all_revisions_before_comparison &&
      granularity == other.granularity &&
      ignore_case_changes == other.ignore_case_changes &&
      ignore_comments == other.ignore_comments &&
      ignore_fields == other.ignore_fields &&
      ignore_footnotes == other.ignore_footnotes &&
      ignore_formatting == other.ignore_formatting &&
      ignore_headers_and_footers == other.ignore_headers_and_footers &&
      ignore_tables == other.ignore_tables &&
      ignore_textboxes == other.ignore_textboxes &&
      target == other.target
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



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
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 269

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    Time.at(/\d/.match(value)[0].to_f).to_datetime
  when :Date
    Time.at(/\d/.match(value)[0].to_f).to_date
  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
    if value[:'$type']
        type = value[:'$type'][0..-4]
    end

    temp_model = AsposeWordsCloud.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



340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 340

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



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

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

#collectFilesContent(resultFilesContent) ⇒ Object 



354
355
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 354

def collectFilesContent(resultFilesContent)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


234
235
236
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 234

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



240
241
242
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 240

def hash
  [accept_all_revisions_before_comparison, granularity, ignore_case_changes, ignore_comments, ignore_fields, ignore_footnotes, ignore_formatting, ignore_headers_and_footers, ignore_tables, ignore_textboxes, target].hash
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



320
321
322
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 320

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



326
327
328
329
330
331
332
333
334
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 326

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



314
315
316
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 314

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
179
180
181
182
183
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 176

def valid?
  granularity_validator = EnumAttributeValidator.new('String', ["CharLevel", "WordLevel"])
  return false unless granularity_validator.valid?(@granularity)
  target_validator = EnumAttributeValidator.new('String', ["Current", "New"])
  return false unless target_validator.valid?(@target)

  return true
end

#validate ⇒ Object 



357
358
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 357

def validate()
end