Class: AsposeWordsCloud::CompareOptions

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

Overview

Container class for 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



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
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 120

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?(:'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

#ignore_case_changes ⇒ Object

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



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

def ignore_case_changes
  @ignore_case_changes
end

#ignore_comments ⇒ Object

Gets or sets a value indicating whether specifies whether to compare differences in comments. By default comments are not ignored.



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

def ignore_comments
  @ignore_comments
end

#ignore_fields ⇒ Object

Gets or sets a value indicating whether specifies whether to compare differences in fields. By default fields are not ignored.



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

def ignore_fields
  @ignore_fields
end

#ignore_footnotes ⇒ Object

Gets or sets a value indicating whether specifies whether to compare differences in footnotes and endnotes. By default footnotes are not ignored.



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

def ignore_footnotes
  @ignore_footnotes
end

#ignore_formatting ⇒ Object

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



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

def ignore_formatting
  @ignore_formatting
end

#ignore_headers_and_footers ⇒ Object

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



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

def ignore_headers_and_footers
  @ignore_headers_and_footers
end

#ignore_tables ⇒ Object

Gets or sets a value indicating whether specifies whether to compare the differences in data contained in tables. 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 specifies whether to compare differences in the data contained within text boxes. By default textboxes are not ignored.



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

def ignore_textboxes
  @ignore_textboxes
end

#target ⇒ Object

Gets or sets specifies which document shall be used as a target during comparison.



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

def target
  @target
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'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.



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

def self.swagger_types
  {
    :'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



196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 196

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      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



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
281
282
283
284
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 247

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
    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



314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/aspose_words_cloud/models/compare_options.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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 225

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

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


212
213
214
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 212

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



218
219
220
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 218

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

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



165
166
167
168
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 165

def list_invalid_properties
  invalid_properties = []
  return 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



294
295
296
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 294

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



300
301
302
303
304
305
306
307
308
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 300

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



288
289
290
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 288

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



172
173
174
175
176
177
 
# File 'lib/aspose_words_cloud/models/compare_options.rb', line 172

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

  return true
end