Class: Couchbase::SearchFacet::SearchFacetDateRange

Inherits:
Object
  • Object
show all
Defined in:
lib/couchbase/search_options.rb

Constant Summary collapse

DATE_FORMAT_RFC3339 = 
"%Y-%m-%dT%H:%M:%S%:z"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(field) {|_self| ... } ⇒ SearchFacetDateRange

Returns a new instance of SearchFacetDateRange.

Parameters:

  • field (String) —

    name of the field

Yields:

  • (_self)

Yield Parameters:



1330
1331
1332
1333
1334
1335
 
# File 'lib/couchbase/search_options.rb', line 1330

def initialize(field)
  super()
  @field = field
  @ranges = []
  yield self if block_given?
end

Instance Attribute Details

#field ⇒ String (readonly)

Returns:

  • (String) 


1324
1325
1326
 
# File 'lib/couchbase/search_options.rb', line 1324

def field
  @field
end

#size ⇒ Integer

Returns:

  • (Integer) 


1327
1328
1329
 
# File 'lib/couchbase/search_options.rb', line 1327

def size
  @size
end

Instance Method Details

#add(name, start_time, end_time) ⇒ Object

Parameters:

  • name (String) —

    the name of the range

  • start_time (Time, String, nil) —

    lower bound of the range (pass nil if there is no lower bound)

  • end_time (Time, String, nil) —

    lower bound of the range (pass nil if there is no lower bound)



1342
1343
1344
1345
1346
 
# File 'lib/couchbase/search_options.rb', line 1342

def add(name, start_time, end_time)
  start_time = start_time.strftime(DATE_FORMAT_RFC3339) if start_time.respond_to?(:strftime)
  end_time = end_time.strftime(DATE_FORMAT_RFC3339) if end_time.respond_to?(:strftime)
  @ranges.append({name: name, start: start_time, end: end_time})
end

#to_json(*args) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1349
1350
1351
 
# File 'lib/couchbase/search_options.rb', line 1349

def to_json(*args)
  {field: field, size: size, date_ranges: @ranges}.to_json(*args)
end