Class: Relaton::Core::Hit

Inherits:

Object

• Object
• Relaton::Core::Hit

Defined in:

lib/relaton/core/hit.rb

Direct Known Subclasses

Bsi::Hit, Relaton::Calconnect::Hit, Relaton::Ccsds::Hit, Relaton::Cen::Hit, Gb::Hit, Iec::Hit, Iso::Hit, Itu::Hit, Jis::Hit, Nist::Hit, Ogc::Hit, Plateau::Hit, Un::Hit, Xsf::Hit

Instance Attribute Summary

• #hit ⇒ Array<Hash> readonly
• #hit_collection ⇒ RelatonBib::HitCollection

Instance Method Summary

• #fetched? ⇒ Boolean
• #initialize(hit, hit_collection = nil) ⇒ Hit constructor

  A new instance of Hit.

• #inspect ⇒ String
• #item ⇒ RelatonBib::ItemData
• #to_s ⇒ String
• #to_xml(**opts) ⇒ String

  XML.

Constructor Details

#initialize(hit, hit_collection = nil) ⇒ Hit

Returns a new instance of Hit.

Parameters:

• hit (Hash)
• hit_collection (RelatonBib::HitCollection) (defaults to: nil)

# File 'lib/relaton/core/hit.rb', line 14

def initialize(hit, hit_collection = nil)
  @hit            = hit
  @hit_collection = WeakRef.new hit_collection if hit_collection
end

Instance Attribute Details

#hit ⇒ Array<Hash> (readonly)

Returns:

• (Array<Hash>)

# File 'lib/relaton/core/hit.rb', line 10

def hit
  @hit
end

#hit_collection ⇒ RelatonBib::HitCollection

Returns:

• (RelatonBib::HitCollection)

# File 'lib/relaton/core/hit.rb', line 7

def hit_collection
  @hit_collection
end

Instance Method Details

#fetched? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/relaton/core/hit.rb', line 37

def fetched?
  !@item.nil?
end

#inspect ⇒ String

Returns:

• (String)

# File 'lib/relaton/core/hit.rb', line 25

def inspect
  "<#{self.class}:#{format('%<id>#.14x', id: object_id << 1)} " \
    "@reference=\"#{@hit_collection&.ref}\" " \
    "@fetched=\"#{fetched?}\" " \
    "@docidentifier=\"#{@hit[:code]}\">"
end

#item ⇒ RelatonBib::ItemData

Returns:

• (RelatonBib::ItemData)

# File 'lib/relaton/core/hit.rb', line 33

def item
  raise "Not implemented"
end

#to_s ⇒ String

Returns:

• (String)

# File 'lib/relaton/core/hit.rb', line 20

def to_s
  inspect
end

#to_xml(**opts) ⇒ String

Returns XML.

Parameters:

• opts (Hash)

Options Hash (**opts):

• :bibdata (Boolean)

Returns:

• (String) —

  XML

# File 'lib/relaton/core/hit.rb', line 44

def to_xml(**opts)
  item.to_xml(**opts)
end