Class: AsposeWordsCloud::PageStatData

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

Overview

Container for the page’s statistical data.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PageStatData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/aspose_words_cloud/models/page_stat_data.rb', line 65

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

  if attributes.key?(:'ParagraphCount')
    self.paragraph_count = attributes[:'ParagraphCount']
  end

  if attributes.key?(:'WordCount')
    self.word_count = attributes[:'WordCount']
  end

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

Instance Attribute Details

#footnotes_stat_data ⇒ Object

Gets or sets the detailed statistics on the footnotes.



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

def footnotes_stat_data
  @footnotes_stat_data
end

#page_number ⇒ Object

Gets or sets the page number.



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

def page_number
  @page_number
end

#paragraph_count ⇒ Object

Gets or sets the total count of paragraphs in the page.



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

def paragraph_count
  @paragraph_count
end

#word_count ⇒ Object

Gets or sets the total count of words in the page.



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

def word_count
  @word_count
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
 
# File 'lib/aspose_words_cloud/models/page_stat_data.rb', line 44

def self.attribute_map
  {
    :'footnotes_stat_data' => :'FootnotesStatData',
    :'paragraph_count' => :'ParagraphCount',
    :'word_count' => :'WordCount',
    :'page_number' => :'PageNumber'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
 
# File 'lib/aspose_words_cloud/models/page_stat_data.rb', line 54

def self.swagger_types
  {
    :'footnotes_stat_data' => :'FootnotesStatData',
    :'paragraph_count' => :'Integer',
    :'word_count' => :'Integer',
    :'page_number' => :'Integer'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



96
97
98
99
100
101
102
103
 
# File 'lib/aspose_words_cloud/models/page_stat_data.rb', line 96

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



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
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/aspose_words_cloud/models/page_stat_data.rb', line 142

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



213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/aspose_words_cloud/models/page_stat_data.rb', line 213

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



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/aspose_words_cloud/models/page_stat_data.rb', line 120

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 



227
228
 
# File 'lib/aspose_words_cloud/models/page_stat_data.rb', line 227

def collectFilesContent(resultFilesContent)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


107
108
109
 
# File 'lib/aspose_words_cloud/models/page_stat_data.rb', line 107

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



113
114
115
 
# File 'lib/aspose_words_cloud/models/page_stat_data.rb', line 113

def hash
  [footnotes_stat_data, paragraph_count, word_count, page_number].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



193
194
195
 
# File 'lib/aspose_words_cloud/models/page_stat_data.rb', line 193

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



199
200
201
202
203
204
205
206
207
 
# File 'lib/aspose_words_cloud/models/page_stat_data.rb', line 199

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



187
188
189
 
# File 'lib/aspose_words_cloud/models/page_stat_data.rb', line 187

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



90
91
92
 
# File 'lib/aspose_words_cloud/models/page_stat_data.rb', line 90

def valid?
  return true
end

#validate ⇒ Object

Raises:

  • (ArgumentError) 


230
231
232
233
234
235
236
237
238
 
# File 'lib/aspose_words_cloud/models/page_stat_data.rb', line 230

def validate()
  raise ArgumentError, 'Property paragraph_count in PageStatData is required.' if self.paragraph_count.nil?
  raise ArgumentError, 'Property word_count in PageStatData is required.' if self.word_count.nil?
  raise ArgumentError, 'Property page_number in PageStatData is required.' if self.page_number.nil?
  unless self.footnotes_stat_data.nil?
      self.footnotes_stat_data.validate
  end

end