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



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

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

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

  if attributes.key?(:'PageCount')
    self.page_count = attributes[:'PageCount']
  end

  if attributes.key?(:'FootnotesStatData')
    self.footnotes_stat_data = attributes[:'FootnotesStatData']
  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 detailed statistics of footnotes.



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

def footnotes_stat_data
  @footnotes_stat_data
end

#page_count ⇒ Object

Gets or sets total count of pages in the document.



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

def page_count
  @page_count
end

#page_stat_data ⇒ Object

Gets or sets detailed statistics of all pages.



47
48
49
 
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 47

def page_stat_data
  @page_stat_data
end

#paragraph_count ⇒ Object

Gets or sets total count of paragraphs in the document.



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

def paragraph_count
  @paragraph_count
end

#word_count ⇒ Object

Gets or sets total count of words in the document.



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

def word_count
  @word_count
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
 
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 51

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

.swagger_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
70
 
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 62

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

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



134
135
136
137
138
139
140
141
142
 
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 134

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



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 181

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
    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



248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 248

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



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 159

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

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


146
147
148
 
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 146

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



152
153
154
 
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 152

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



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 106

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

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

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



228
229
230
 
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 228

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



234
235
236
237
238
239
240
241
242
 
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 234

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



222
223
224
 
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 222

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



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

def valid?
  return false if @word_count.nil?
  return false if @paragraph_count.nil?
  return false if @page_count.nil?
  return true
end