Sha256: 1b9ec11b52e1e799dc8c155ac97679a6641d5ce9c3f6fa1f5fa4e2b52a48f6f4
Contents?: true
Size: 1.18 KB
Versions: 28
Compression:
Stored size: 1.18 KB
Contents
module Scrivito
# Instances of this class represent the result of a faceted search.
#
# @api public
class ObjFacetValue
def initialize(value, total, included_objs = [])
@name = value
@count = total
@included_objs = included_objs
end
# The name of this ObjFacetValue, i.e. the value of the attribute.
#
# Example: If you do faceting using the attribute +color+,
# you might receive an +ObjFacetValue+ with the name +"yellow"+,
# another one with the name +"green"+ and so on.
#
# @return [String]
# @api public
def name
@name
end
# Total number of Objs available that have this value.
#
# Note that this refers to all Objs, not just the Objs included in this search.
# Also note that the count is approximate.
#
# @return [Integer]
# @api public
def count
@count
end
# The Objs that were included in this search.
#
# If you did not specify +include_objs+ in your facet options,
# an empty array is returned.
# The Objs are ordered by relevance.
#
# @return [Array<BasicObj>]
# @api public
def included_objs
@included_objs
end
end
end
Version data entries
28 entries across 28 versions & 1 rubygems