Class: AsposeWordsCloud::DocumentStatData

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

Overview

Container for the document’s statistical data.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DocumentStatData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 70

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

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

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

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

Instance Attribute Details

#footnotes_stat_data ⇒ Object

Gets or sets the detailed statistics on footnotes.



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

def footnotes_stat_data
  @footnotes_stat_data
end

#page_count ⇒ Object

Gets or sets the total count of pages in the document.



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

def page_count
  @page_count
end

#page_stat_data ⇒ Object

Gets or sets the detailed statistics on all pages.



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

def page_stat_data
  @page_stat_data
end

#paragraph_count ⇒ Object

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



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

def paragraph_count
  @paragraph_count
end

#word_count ⇒ Object

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



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

def word_count
  @word_count
end

Class Method Details

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
 
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 47

def self.attribute_map
  {
    :'footnotes_stat_data' => :'FootnotesStatData',
    :'page_count' => :'PageCount',
    :'paragraph_count' => :'ParagraphCount',
    :'word_count' => :'WordCount',
    :'page_stat_data' => :'PageStatData'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
 
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 58

def self.swagger_types
  {
    :'footnotes_stat_data' => :'FootnotesStatData',
    :'page_count' => :'Integer',
    :'paragraph_count' => :'Integer',
    :'word_count' => :'Integer',
    :'page_stat_data' => :'Array<PageStatData>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



107
108
109
110
111
112
113
114
115
 
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 107

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



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
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 154

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



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

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



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 132

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 



239
240
 
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 239

def collectFilesContent(resultFilesContent)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


119
120
121
 
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 119

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



125
126
127
 
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 125

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



205
206
207
 
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 205

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



211
212
213
214
215
216
217
218
219
 
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 211

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



199
200
201
 
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 199

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



101
102
103
 
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 101

def valid?
  return true
end

#validate ⇒ Object

Raises:

  • (ArgumentError) 


242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 242

def validate()
  raise ArgumentError, 'Property page_count in DocumentStatData is required.' if self.page_count.nil?
  raise ArgumentError, 'Property paragraph_count in DocumentStatData is required.' if self.paragraph_count.nil?
  raise ArgumentError, 'Property word_count in DocumentStatData is required.' if self.word_count.nil?
  unless self.footnotes_stat_data.nil?
      self.footnotes_stat_data.validate
  end
  unless self.page_stat_data.nil?
      for elementPageStatData in self.page_stat_data
          unless elementPageStatData.nil?
              elementPageStatData.validate
          end
      end
  end

end