Class: CloudmersiveConvertApiClient::PdfAnnotation

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudmersive-convert-api-client/models/pdf_annotation.rb

Overview

PDF Annotation details

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PdfAnnotation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



92
93
94
95
96
97
98
99
100
101
102
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
 
# File 'lib/cloudmersive-convert-api-client/models/pdf_annotation.rb', line 92

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

  if attributes.has_key?(:'AnnotationType')
    self.annotation_type = attributes[:'AnnotationType']
  end

  if attributes.has_key?(:'PageNumber')
    self.page_number = attributes[:'PageNumber']
  end

  if attributes.has_key?(:'AnnotationIndex')
    self.annotation_index = attributes[:'AnnotationIndex']
  end

  if attributes.has_key?(:'Subject')
    self.subject = attributes[:'Subject']
  end

  if attributes.has_key?(:'TextContents')
    self.text_contents = attributes[:'TextContents']
  end

  if attributes.has_key?(:'CreationDate')
    self.creation_date = attributes[:'CreationDate']
  end

  if attributes.has_key?(:'ModifiedDate')
    self.modified_date = attributes[:'ModifiedDate']
  end

  if attributes.has_key?(:'LeftX')
    self.left_x = attributes[:'LeftX']
  end

  if attributes.has_key?(:'TopY')
    self.top_y = attributes[:'TopY']
  end

  if attributes.has_key?(:'Width')
    self.width = attributes[:'Width']
  end

  if attributes.has_key?(:'Height')
    self.height = attributes[:'Height']
  end
end

Instance Attribute Details

#annotation_index ⇒ Object

The 0-based index of the annotation in the document



28
29
30
 
# File 'lib/cloudmersive-convert-api-client/models/pdf_annotation.rb', line 28

def annotation_index
  @annotation_index
end

#annotation_type ⇒ Object

Type of the annotation; possible values are Text



22
23
24
 
# File 'lib/cloudmersive-convert-api-client/models/pdf_annotation.rb', line 22

def annotation_type
  @annotation_type
end

#creation_date ⇒ Object

Date that the annotation was created



37
38
39
 
# File 'lib/cloudmersive-convert-api-client/models/pdf_annotation.rb', line 37

def creation_date
  @creation_date
end

#height ⇒ Object

Height of the annotation



52
53
54
 
# File 'lib/cloudmersive-convert-api-client/models/pdf_annotation.rb', line 52

def height
  @height
end

#left_x ⇒ Object

Left X coordinate for the location of the annotation



43
44
45
 
# File 'lib/cloudmersive-convert-api-client/models/pdf_annotation.rb', line 43

def left_x
  @left_x
end

#modified_date ⇒ Object

Date that the annotation was last modified



40
41
42
 
# File 'lib/cloudmersive-convert-api-client/models/pdf_annotation.rb', line 40

def modified_date
  @modified_date
end

#page_number ⇒ Object

The 1-based index of the page containing the annotation



25
26
27
 
# File 'lib/cloudmersive-convert-api-client/models/pdf_annotation.rb', line 25

def page_number
  @page_number
end

#subject ⇒ Object

Subject of the annotation



31
32
33
 
# File 'lib/cloudmersive-convert-api-client/models/pdf_annotation.rb', line 31

def subject
  @subject
end

#text_contents ⇒ Object

Text contents of the annotation



34
35
36
 
# File 'lib/cloudmersive-convert-api-client/models/pdf_annotation.rb', line 34

def text_contents
  @text_contents
end

#title ⇒ Object

Title of the annotation; this is often the author of the annotation in Acrobat-created PDF files



19
20
21
 
# File 'lib/cloudmersive-convert-api-client/models/pdf_annotation.rb', line 19

def title
  @title
end

#top_y ⇒ Object

Top Y coordination of the location of the annotation



46
47
48
 
# File 'lib/cloudmersive-convert-api-client/models/pdf_annotation.rb', line 46

def top_y
  @top_y
end

#width ⇒ Object

Width of the annotation



49
50
51
 
# File 'lib/cloudmersive-convert-api-client/models/pdf_annotation.rb', line 49

def width
  @width
end

Class Method Details

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/cloudmersive-convert-api-client/models/pdf_annotation.rb', line 55

def self.attribute_map
  {
    :'title' => :'Title',
    :'annotation_type' => :'AnnotationType',
    :'page_number' => :'PageNumber',
    :'annotation_index' => :'AnnotationIndex',
    :'subject' => :'Subject',
    :'text_contents' => :'TextContents',
    :'creation_date' => :'CreationDate',
    :'modified_date' => :'ModifiedDate',
    :'left_x' => :'LeftX',
    :'top_y' => :'TopY',
    :'width' => :'Width',
    :'height' => :'Height'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/cloudmersive-convert-api-client/models/pdf_annotation.rb', line 73

def self.swagger_types
  {
    :'title' => :'String',
    :'annotation_type' => :'String',
    :'page_number' => :'Integer',
    :'annotation_index' => :'Integer',
    :'subject' => :'String',
    :'text_contents' => :'String',
    :'creation_date' => :'DateTime',
    :'modified_date' => :'DateTime',
    :'left_x' => :'Float',
    :'top_y' => :'Float',
    :'width' => :'Float',
    :'height' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/cloudmersive-convert-api-client/models/pdf_annotation.rb', line 162

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      title == o.title &&
      annotation_type == o.annotation_type &&
      page_number == o.page_number &&
      annotation_index == o.annotation_index &&
      subject == o.subject &&
      text_contents == o.text_contents &&
      creation_date == o.creation_date &&
      modified_date == o.modified_date &&
      left_x == o.left_x &&
      top_y == o.top_y &&
      width == o.width &&
      height == o.height
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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/cloudmersive-convert-api-client/models/pdf_annotation.rb', line 215

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



281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/cloudmersive-convert-api-client/models/pdf_annotation.rb', line 281

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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/cloudmersive-convert-api-client/models/pdf_annotation.rb', line 194

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 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?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


181
182
183
 
# File 'lib/cloudmersive-convert-api-client/models/pdf_annotation.rb', line 181

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



187
188
189
 
# File 'lib/cloudmersive-convert-api-client/models/pdf_annotation.rb', line 187

def hash
  [title, annotation_type, page_number, annotation_index, subject, text_contents, creation_date, modified_date, left_x, top_y, width, height].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



149
150
151
152
 
# File 'lib/cloudmersive-convert-api-client/models/pdf_annotation.rb', line 149

def list_invalid_properties
  invalid_properties = Array.new
  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



261
262
263
 
# File 'lib/cloudmersive-convert-api-client/models/pdf_annotation.rb', line 261

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



267
268
269
270
271
272
273
274
275
 
# File 'lib/cloudmersive-convert-api-client/models/pdf_annotation.rb', line 267

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



255
256
257
 
# File 'lib/cloudmersive-convert-api-client/models/pdf_annotation.rb', line 255

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



156
157
158
 
# File 'lib/cloudmersive-convert-api-client/models/pdf_annotation.rb', line 156

def valid?
  true
end