Class: GroupDocsParserCloud::FieldPosition

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_parser_cloud/models/field_position.rb

Overview

Field position class.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FieldPosition

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/groupdocs_parser_cloud/models/field_position.rb', line 103

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#auto_scale ⇒ Object

Gets or sets Gets the value that indicates whether SearchArea is scaled by the linked field size.



65
66
67
 
# File 'lib/groupdocs_parser_cloud/models/field_position.rb', line 65

def auto_scale
  @auto_scale
end

#field_position_type ⇒ Object

Provides a template field position.



35
36
37
 
# File 'lib/groupdocs_parser_cloud/models/field_position.rb', line 35

def field_position_type
  @field_position_type
end

#is_bottom_linked ⇒ Object

Gets or sets a value indicating whether this instance is bottom linked.



59
60
61
 
# File 'lib/groupdocs_parser_cloud/models/field_position.rb', line 59

def is_bottom_linked
  @is_bottom_linked
end

#is_left_linked ⇒ Object

Gets or sets the value that indicates whether a field is searched by the left from the linked field.



50
51
52
 
# File 'lib/groupdocs_parser_cloud/models/field_position.rb', line 50

def is_left_linked
  @is_left_linked
end

#is_right_linked ⇒ Object

Gets or sets a value indicating whether this instance is right linked.



53
54
55
 
# File 'lib/groupdocs_parser_cloud/models/field_position.rb', line 53

def is_right_linked
  @is_right_linked
end

#is_top_linked ⇒ Object

Gets or sets a value indicating whether this instance is top linked.



56
57
58
 
# File 'lib/groupdocs_parser_cloud/models/field_position.rb', line 56

def is_top_linked
  @is_top_linked
end

#linked_field_name ⇒ Object

Gets or sets the name of the linked field.



47
48
49
 
# File 'lib/groupdocs_parser_cloud/models/field_position.rb', line 47

def linked_field_name
  @linked_field_name
end

#match_case ⇒ Object

Gets or sets the value that indicates whether a text case isn’t ignored.



44
45
46
 
# File 'lib/groupdocs_parser_cloud/models/field_position.rb', line 44

def match_case
  @match_case
end

#rectangle ⇒ Object

Rectangular area on the page that bounds the field value.



38
39
40
 
# File 'lib/groupdocs_parser_cloud/models/field_position.rb', line 38

def rectangle
  @rectangle
end

#regex ⇒ Object

Gets or sets the regular expression.



41
42
43
 
# File 'lib/groupdocs_parser_cloud/models/field_position.rb', line 41

def regex
  @regex
end

#search_area ⇒ Object

Gets or sets the size of the area where a field is searched.



62
63
64
 
# File 'lib/groupdocs_parser_cloud/models/field_position.rb', line 62

def search_area
  @search_area
end

Class Method Details

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/groupdocs_parser_cloud/models/field_position.rb', line 68

def self.attribute_map
  {
    :'field_position_type' => :'FieldPositionType',
    :'rectangle' => :'Rectangle',
    :'regex' => :'Regex',
    :'match_case' => :'MatchCase',
    :'linked_field_name' => :'LinkedFieldName',
    :'is_left_linked' => :'IsLeftLinked',
    :'is_right_linked' => :'IsRightLinked',
    :'is_top_linked' => :'IsTopLinked',
    :'is_bottom_linked' => :'IsBottomLinked',
    :'search_area' => :'SearchArea',
    :'auto_scale' => :'AutoScale'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/groupdocs_parser_cloud/models/field_position.rb', line 85

def self.swagger_types
  {
    :'field_position_type' => :'String',
    :'rectangle' => :'Rectangle',
    :'regex' => :'String',
    :'match_case' => :'BOOLEAN',
    :'linked_field_name' => :'String',
    :'is_left_linked' => :'BOOLEAN',
    :'is_right_linked' => :'BOOLEAN',
    :'is_top_linked' => :'BOOLEAN',
    :'is_bottom_linked' => :'BOOLEAN',
    :'search_area' => :'Size',
    :'auto_scale' => :'BOOLEAN'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/groupdocs_parser_cloud/models/field_position.rb', line 200

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      field_position_type == other.field_position_type &&
      rectangle == other.rectangle &&
      regex == other.regex &&
      match_case == other.match_case &&
      linked_field_name == other.linked_field_name &&
      is_left_linked == other.is_left_linked &&
      is_right_linked == other.is_right_linked &&
      is_top_linked == other.is_top_linked &&
      is_bottom_linked == other.is_bottom_linked &&
      search_area == other.search_area &&
      auto_scale == other.auto_scale
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



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
291
292
293
294
295
296
297
298
 
# File 'lib/groupdocs_parser_cloud/models/field_position.rb', line 261

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 = GroupDocsParserCloud.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



328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/groupdocs_parser_cloud/models/field_position.rb', line 328

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



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/groupdocs_parser_cloud/models/field_position.rb', line 237

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


218
219
220
 
# File 'lib/groupdocs_parser_cloud/models/field_position.rb', line 218

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



224
225
226
 
# File 'lib/groupdocs_parser_cloud/models/field_position.rb', line 224

def hash
  [field_position_type, rectangle, regex, match_case, linked_field_name, is_left_linked, is_right_linked, is_top_linked, is_bottom_linked, search_area, auto_scale].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



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/groupdocs_parser_cloud/models/field_position.rb', line 157

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

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

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

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

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

  if @auto_scale.nil?
    invalid_properties.push("invalid value for 'auto_scale', auto_scale 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



308
309
310
 
# File 'lib/groupdocs_parser_cloud/models/field_position.rb', line 308

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



314
315
316
317
318
319
320
321
322
 
# File 'lib/groupdocs_parser_cloud/models/field_position.rb', line 314

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



302
303
304
 
# File 'lib/groupdocs_parser_cloud/models/field_position.rb', line 302

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



230
231
232
 
# File 'lib/groupdocs_parser_cloud/models/field_position.rb', line 230

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



188
189
190
191
192
193
194
195
196
 
# File 'lib/groupdocs_parser_cloud/models/field_position.rb', line 188

def valid?
  return false if @match_case.nil?
  return false if @is_left_linked.nil?
  return false if @is_right_linked.nil?
  return false if @is_top_linked.nil?
  return false if @is_bottom_linked.nil?
  return false if @auto_scale.nil?
  return true
end