Class: WordsRubySdk::PageStatData
- Inherits:
-
Object
- Object
- WordsRubySdk::PageStatData
- Defined in:
- lib/words_ruby_sdk/models/page_stat_data.rb
Overview
Container for the page’s statistical data
Instance Attribute Summary collapse
-
#footnotes_stat_data ⇒ Object
Detailed statistics of footnotes.
-
#page_number ⇒ Object
Page number.
-
#paragraph_count ⇒ Object
Total count of paragraphs in the page.
-
#word_count ⇒ Object
Total count of words in the page.
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 = {}) ⇒ PageStatData
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 = {}) ⇒ PageStatData
Initializes the object
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 |
# File 'lib/words_ruby_sdk/models/page_stat_data.rb', line 69 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?(:'PageNumber') self.page_number = attributes[:'PageNumber'] end if attributes.key?(:'WordCount') self.word_count = attributes[:'WordCount'] end if attributes.key?(:'ParagraphCount') self.paragraph_count = attributes[:'ParagraphCount'] end if attributes.key?(:'FootnotesStatData') self.footnotes_stat_data = attributes[:'FootnotesStatData'] end end |
Instance Attribute Details
#footnotes_stat_data ⇒ Object
Detailed statistics of footnotes
44 45 46 |
# File 'lib/words_ruby_sdk/models/page_stat_data.rb', line 44 def footnotes_stat_data @footnotes_stat_data end |
#page_number ⇒ Object
Page number
35 36 37 |
# File 'lib/words_ruby_sdk/models/page_stat_data.rb', line 35 def page_number @page_number end |
#paragraph_count ⇒ Object
Total count of paragraphs in the page
41 42 43 |
# File 'lib/words_ruby_sdk/models/page_stat_data.rb', line 41 def paragraph_count @paragraph_count end |
#word_count ⇒ Object
Total count of words in the page
38 39 40 |
# File 'lib/words_ruby_sdk/models/page_stat_data.rb', line 38 def word_count @word_count end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
48 49 50 51 52 53 54 55 |
# File 'lib/words_ruby_sdk/models/page_stat_data.rb', line 48 def self.attribute_map { :'page_number' => :'PageNumber', :'word_count' => :'WordCount', :'paragraph_count' => :'ParagraphCount', :'footnotes_stat_data' => :'FootnotesStatData' } end |
.swagger_types ⇒ Object
Attribute type mapping.
58 59 60 61 62 63 64 65 |
# File 'lib/words_ruby_sdk/models/page_stat_data.rb', line 58 def self.swagger_types { :'page_number' => :'Integer', :'word_count' => :'Integer', :'paragraph_count' => :'Integer', :'footnotes_stat_data' => :'FootnotesStatData' } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
123 124 125 126 127 128 129 130 |
# File 'lib/words_ruby_sdk/models/page_stat_data.rb', line 123 def ==(other) return true if self.equal?(other) self.class == other.class && page_number == other.page_number && word_count == other.word_count && paragraph_count == other.paragraph_count && footnotes_stat_data == other.footnotes_stat_data end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 199 200 201 202 203 204 205 206 |
# File 'lib/words_ruby_sdk/models/page_stat_data.rb', line 169 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 = WordsRubySdk.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
236 237 238 239 240 241 242 243 244 245 246 247 248 |
# File 'lib/words_ruby_sdk/models/page_stat_data.rb', line 236 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
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 |
# File 'lib/words_ruby_sdk/models/page_stat_data.rb', line 147 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
134 135 136 |
# File 'lib/words_ruby_sdk/models/page_stat_data.rb', line 134 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
140 141 142 |
# File 'lib/words_ruby_sdk/models/page_stat_data.rb', line 140 def hash [page_number, word_count, paragraph_count, footnotes_stat_data].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 |
# File 'lib/words_ruby_sdk/models/page_stat_data.rb', line 95 def list_invalid_properties invalid_properties = [] if @page_number.nil? invalid_properties.push("invalid value for 'page_number', page_number cannot be nil.") end 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 return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
216 217 218 |
# File 'lib/words_ruby_sdk/models/page_stat_data.rb', line 216 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
222 223 224 225 226 227 228 229 230 |
# File 'lib/words_ruby_sdk/models/page_stat_data.rb', line 222 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
210 211 212 |
# File 'lib/words_ruby_sdk/models/page_stat_data.rb', line 210 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
114 115 116 117 118 119 |
# File 'lib/words_ruby_sdk/models/page_stat_data.rb', line 114 def valid? return false if @page_number.nil? return false if @word_count.nil? return false if @paragraph_count.nil? return true end |