Class: GroupDocsMergerCloud::JoinItem

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_merger_cloud/models/join_item.rb

Overview

Describes document for join operation.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ JoinItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/groupdocs_merger_cloud/models/join_item.rb', line 109

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

  if attributes.key?(:'Pages')
    if (value = attributes[:'Pages']).is_a?(Array)
      self.pages = value
    end
  end

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

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

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

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

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

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

end

Instance Attribute Details

#end_page_number ⇒ Object

End page number. Ignored if Pages collection is not empty.



44
45
46
 
# File 'lib/groupdocs_merger_cloud/models/join_item.rb', line 44

def end_page_number
  @end_page_number
end

#file_info ⇒ Object

File info.



35
36
37
 
# File 'lib/groupdocs_merger_cloud/models/join_item.rb', line 35

def file_info
  @file_info
end

#image_join_mode ⇒ Object

Possible modes for the image joining.



56
57
58
 
# File 'lib/groupdocs_merger_cloud/models/join_item.rb', line 56

def image_join_mode
  @image_join_mode
end

#pages ⇒ Object

List of page numbers to use in a Join operation. NOTE: page numbering starts from 1.



38
39
40
 
# File 'lib/groupdocs_merger_cloud/models/join_item.rb', line 38

def pages
  @pages
end

#range_mode ⇒ Object

Range mode. Ignored if Pages collection is not empty. Default value is AllPages.



47
48
49
 
# File 'lib/groupdocs_merger_cloud/models/join_item.rb', line 47

def range_mode
  @range_mode
end

#start_page_number ⇒ Object

Start page number. Ignored if Pages collection is not empty.



41
42
43
 
# File 'lib/groupdocs_merger_cloud/models/join_item.rb', line 41

def start_page_number
  @start_page_number
end

#word_join_compliance ⇒ Object

Compliance mode for the Word Ooxml format



53
54
55
 
# File 'lib/groupdocs_merger_cloud/models/join_item.rb', line 53

def word_join_compliance
  @word_join_compliance
end

#word_join_mode ⇒ Object

Allows to join word documents without empty space between documents.



50
51
52
 
# File 'lib/groupdocs_merger_cloud/models/join_item.rb', line 50

def word_join_mode
  @word_join_mode
end

Class Method Details

.attribute_map ⇒ Object

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



80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/groupdocs_merger_cloud/models/join_item.rb', line 80

def self.attribute_map
  {
    :'file_info' => :'FileInfo',
    :'pages' => :'Pages',
    :'start_page_number' => :'StartPageNumber',
    :'end_page_number' => :'EndPageNumber',
    :'range_mode' => :'RangeMode',
    :'word_join_mode' => :'WordJoinMode',
    :'word_join_compliance' => :'WordJoinCompliance',
    :'image_join_mode' => :'ImageJoinMode'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/groupdocs_merger_cloud/models/join_item.rb', line 94

def self.swagger_types
  {
    :'file_info' => :'FileInfo',
    :'pages' => :'Array<Integer>',
    :'start_page_number' => :'Integer',
    :'end_page_number' => :'Integer',
    :'range_mode' => :'String',
    :'word_join_mode' => :'String',
    :'word_join_compliance' => :'String',
    :'image_join_mode' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/groupdocs_merger_cloud/models/join_item.rb', line 260

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      file_info == other.file_info &&
      pages == other.pages &&
      start_page_number == other.start_page_number &&
      end_page_number == other.end_page_number &&
      range_mode == other.range_mode &&
      word_join_mode == other.word_join_mode &&
      word_join_compliance == other.word_join_compliance &&
      image_join_mode == other.image_join_mode
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



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/groupdocs_merger_cloud/models/join_item.rb', line 318

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    Date.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
    temp_model = GroupDocsMergerCloud.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



385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/groupdocs_merger_cloud/models/join_item.rb', line 385

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



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/groupdocs_merger_cloud/models/join_item.rb', line 294

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    pname = uncap(self.class.attribute_map[key]).intern
    value = attributes[pname]
    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 value.is_a?(Array)
        self.send("#{key}=", value.map { |v| _deserialize($1, v) })
      end
    elsif !value.nil?
      self.send("#{key}=", _deserialize(type, value))
    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


275
276
277
 
# File 'lib/groupdocs_merger_cloud/models/join_item.rb', line 275

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



281
282
283
 
# File 'lib/groupdocs_merger_cloud/models/join_item.rb', line 281

def hash
  [file_info, pages, start_page_number, end_page_number, range_mode, word_join_mode, word_join_compliance, image_join_mode].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



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/groupdocs_merger_cloud/models/join_item.rb', line 153

def list_invalid_properties
  invalid_properties = []
  if @start_page_number.nil?
    invalid_properties.push("invalid value for 'start_page_number', start_page_number cannot be nil.")
  end

  if @end_page_number.nil?
    invalid_properties.push("invalid value for 'end_page_number', end_page_number cannot be nil.")
  end

  if @range_mode.nil?
    invalid_properties.push("invalid value for 'range_mode', range_mode cannot be nil.")
  end

  if @word_join_mode.nil?
    invalid_properties.push("invalid value for 'word_join_mode', word_join_mode cannot be nil.")
  end

  if @word_join_compliance.nil?
    invalid_properties.push("invalid value for 'word_join_compliance', word_join_compliance cannot be nil.")
  end

  if @image_join_mode.nil?
    invalid_properties.push("invalid value for 'image_join_mode', image_join_mode cannot be nil.")
  end

  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



365
366
367
 
# File 'lib/groupdocs_merger_cloud/models/join_item.rb', line 365

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



371
372
373
374
375
376
377
378
379
 
# File 'lib/groupdocs_merger_cloud/models/join_item.rb', line 371

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



359
360
361
 
# File 'lib/groupdocs_merger_cloud/models/join_item.rb', line 359

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



287
288
289
 
# File 'lib/groupdocs_merger_cloud/models/join_item.rb', line 287

def uncap(str)
  str[0, 1].downcase + str[1..-1]
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
194
195
196
197
198
199
200
 
# File 'lib/groupdocs_merger_cloud/models/join_item.rb', line 184

def valid?
  return false if @start_page_number.nil?
  return false if @end_page_number.nil?
  return false if @range_mode.nil?
  range_mode_validator = EnumAttributeValidator.new('String', ["AllPages", "OddPages", "EvenPages"])
  return false unless range_mode_validator.valid?(@range_mode)
  return false if @word_join_mode.nil?
  word_join_mode_validator = EnumAttributeValidator.new('String', ["Default", "Continuous"])
  return false unless word_join_mode_validator.valid?(@word_join_mode)
  return false if @word_join_compliance.nil?
  word_join_compliance_validator = EnumAttributeValidator.new('String', ["Ecma376_2006", "Iso29500_2008_Transitional", "Iso29500_2008_Strict", "Auto"])
  return false unless word_join_compliance_validator.valid?(@word_join_compliance)
  return false if @image_join_mode.nil?
  image_join_mode_validator = EnumAttributeValidator.new('String', ["Horizontal", "Vertical"])
  return false unless image_join_mode_validator.valid?(@image_join_mode)
  return true
end