class Comet::SearchClause
SearchClause
is a typed class wrapper around the underlying Comet
Server API data structure.
Attributes
clause_children[RW]
@type [Array<Comet::SearchClause>] clause_children
clause_type[RW]
@type [String] clause_type
rule_field[RW]
@type [String] rule_field
rule_operator[RW]
@type [String] rule_operator
rule_value[RW]
@type [String] rule_value
unknown_json_fields[RW]
@type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
Public Class Methods
new()
click to toggle source
# File lib/comet/models/search_clause.rb, line 35 def initialize clear end
Public Instance Methods
clear()
click to toggle source
# File lib/comet/models/search_clause.rb, line 39 def clear @clause_type = '' @rule_field = '' @rule_operator = '' @rule_value = '' @clause_children = [] @unknown_json_fields = {} end
from_hash(obj)
click to toggle source
@param [Hash] obj The complete object as a Ruby hash
# File lib/comet/models/search_clause.rb, line 56 def from_hash(obj) raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash obj.each do |k, v| case k when 'ClauseType' raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String @clause_type = v when 'RuleField' raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String @rule_field = v when 'RuleOperator' raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String @rule_operator = v when 'RuleValue' raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String @rule_value = v when 'ClauseChildren' if v.nil? @clause_children = [] else @clause_children = Array.new(v.length) v.each_with_index do |v1, i1| @clause_children[i1] = Comet::SearchClause.new @clause_children[i1].from_hash(v1) end end else @unknown_json_fields[k] = v end end end
from_json(json_string)
click to toggle source
@param [String] json_string The complete object in JSON format
# File lib/comet/models/search_clause.rb, line 49 def from_json(json_string) raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String from_hash(JSON.parse(json_string)) end
to_h()
click to toggle source
@return [Hash] The complete object as a Ruby hash
# File lib/comet/models/search_clause.rb, line 110 def to_h to_hash end
to_hash()
click to toggle source
@return [Hash] The complete object as a Ruby hash
# File lib/comet/models/search_clause.rb, line 94 def to_hash ret = {} ret['ClauseType'] = @clause_type ret['RuleField'] = @rule_field ret['RuleOperator'] = @rule_operator ret['RuleValue'] = @rule_value unless @clause_children.nil? ret['ClauseChildren'] = @clause_children end @unknown_json_fields.each do |k, v| ret[k] = v end ret end
to_json(options = {})
click to toggle source
@return [String] The complete object as a JSON string
# File lib/comet/models/search_clause.rb, line 115 def to_json(options = {}) to_hash.to_json(options) end