Class: AsposeWordsCloud::DocumentStatData
- Inherits:
-
Object
- Object
- AsposeWordsCloud::DocumentStatData
- Defined in:
- lib/aspose_words_cloud/models/document_stat_data.rb
Overview
Container for the document’s statistical data.
Instance Attribute Summary collapse
-
#footnotes_stat_data ⇒ Object
Gets or sets the detailed statistics on footnotes.
-
#page_count ⇒ Object
Gets or sets the total count of pages in the document.
-
#page_stat_data ⇒ Object
Gets or sets the detailed statistics on all pages.
-
#paragraph_count ⇒ Object
Gets or sets the total count of paragraphs in the document.
-
#word_count ⇒ Object
Gets or sets the total count of words in the document.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ DocumentStatData
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ DocumentStatData
Initializes the object
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?(:'PageStatData') if (value = attributes[:'PageStatData']).is_a?(Array) self.page_stat_data = value end end if attributes.key?(:'ParagraphCount') self.paragraph_count = attributes[:'ParagraphCount'] end if attributes.key?(:'WordCount') self.word_count = attributes[:'WordCount'] 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.
39 40 41 |
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 39 def page_stat_data @page_stat_data end |
#paragraph_count ⇒ Object
Gets or sets the total count of paragraphs in the document.
42 43 44 |
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 42 def paragraph_count @paragraph_count end |
#word_count ⇒ Object
Gets or sets the total count of words in the document.
45 46 47 |
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 45 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', :'page_stat_data' => :'PageStatData', :'paragraph_count' => :'ParagraphCount', :'word_count' => :'WordCount' } 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', :'page_stat_data' => :'Array<PageStatData>', :'paragraph_count' => :'Integer', :'word_count' => :'Integer' } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
114 115 116 117 118 119 120 121 122 |
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 114 def ==(other) return true if self.equal?(other) self.class == other.class && footnotes_stat_data == other.footnotes_stat_data && page_count == other.page_count && page_stat_data == other.page_stat_data && paragraph_count == other.paragraph_count && word_count == other.word_count end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 196 197 198 |
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 161 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
228 229 230 231 232 233 234 235 236 237 238 239 240 |
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 228 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
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 |
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 139 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
126 127 128 |
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 126 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
132 133 134 |
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 132 def hash [footnotes_stat_data, page_count, page_stat_data, paragraph_count, word_count].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
101 102 103 104 |
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 101 def list_invalid_properties invalid_properties = [] return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
208 209 210 |
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 208 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
214 215 216 217 218 219 220 221 222 |
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 214 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
202 203 204 |
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 202 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
108 109 110 |
# File 'lib/aspose_words_cloud/models/document_stat_data.rb', line 108 def valid? return true end |