Class: BitClust::SearchResult

Inherits:
Object
  • Object
show all
Includes:
DRb::DRbUndumped
Defined in:
lib/bitclust/server.rb,
lib/bitclust/completion.rb
more...

Overview

Represents result of completion search. Has many SearchResult::Record.

Defined Under Namespace

Classes: Record

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(db, pattern, classes, records) ⇒ SearchResult

Returns a new instance of SearchResult.

[View source]

409
410
411
412
413
414
# File 'lib/bitclust/completion.rb', line 409

def initialize(db, pattern, classes, records)
  @database = db
  @pattern = pattern
  @classes = classes
  @records = records
end

Instance Attribute Details

#classesObject (readonly)

Returns the value of attribute classes.


418
419
420
# File 'lib/bitclust/completion.rb', line 418

def classes
  @classes
end

#databaseObject (readonly)

Returns the value of attribute database.


416
417
418
# File 'lib/bitclust/completion.rb', line 416

def database
  @database
end

#patternObject (readonly)

Returns the value of attribute pattern.


417
418
419
# File 'lib/bitclust/completion.rb', line 417

def pattern
  @pattern
end

#recordsObject (readonly)

Returns the value of attribute records.


419
420
421
# File 'lib/bitclust/completion.rb', line 419

def records
  @records
end

Class Method Details

.empty(db, pattern) ⇒ Object

[View source]

405
406
407
# File 'lib/bitclust/completion.rb', line 405

def SearchResult.empty(db, pattern)
  new(db, pattern, [], [])
end

Instance Method Details

#determined?Boolean

Returns:

  • (Boolean)
[View source]

433
434
435
# File 'lib/bitclust/completion.rb', line 433

def determined?
  @records.size == 1
end

#each_record(&block) ⇒ Object

[View source]

449
450
451
# File 'lib/bitclust/completion.rb', line 449

def each_record(&block)
  @records.sort.each(&block)
end

#fail?Boolean

Returns:

  • (Boolean)
[View source]

425
426
427
# File 'lib/bitclust/completion.rb', line 425

def fail?
  @records.empty?
end

#inspectObject

[View source]

421
422
423
# File 'lib/bitclust/completion.rb', line 421

def inspect
  "\#<BitClust::SearchResult @pattern=#{@pattern.inspect} @classes=#{@classes.inspect} @database=#{@database.inspect} @records=[#{record.inspect}, ...] >"
end

#nameObject

[View source]

437
438
439
# File 'lib/bitclust/completion.rb', line 437

def name
  @records.first.name
end

#namesObject

[View source]

441
442
443
# File 'lib/bitclust/completion.rb', line 441

def names
  @records.map {|rec| rec.names }.flatten
end

#recordObject

[View source]

445
446
447
# File 'lib/bitclust/completion.rb', line 445

def record
  @records.first
end

#success?Boolean

Returns:

  • (Boolean)
[View source]

429
430
431
# File 'lib/bitclust/completion.rb', line 429

def success?
  not @records.empty?
end