Class: Eddy::Models::Segment

Inherits:

Object

• Object
• Eddy::Models::Segment

Defined in:

lib/eddy/models/segment.rb

Overview

Base class for EDI Segments.

Direct Known Subclasses

Segments::ACK, Segments::AMT, Segments::BAK, Segments::BEG, Segments::BIA, Segments::BIG, Segments::BSN, Segments::CAD, Segments::CTP, Segments::CTT, Segments::CUR, Segments::DTM, Segments::FOB, Segments::GE, Segments::GS, Segments::HL, Segments::IEA, Segments::ISA, Segments::IT1, Segments::ITD, Segments::LIN, Segments::MAN, Segments::MTX, Segments::N1, Segments::N2, Segments::N3, Segments::N4, Segments::N9, Segments::PER, Segments::PID, Segments::PO1, Segments::PO3, Segments::PRF, Segments::QTY, Segments::REF, Segments::SAC, Segments::SCH, Segments::SDQ, Segments::SE, Segments::SLN, Segments::SN1, Segments::ST, Segments::TD1, Segments::TD5, Segments::TDS, Segments::TXI

Instance Attribute Summary

• #elements ⇒ Array<Element>
• #id ⇒ String readonly

  An alphanumeric code unique to each Segment type.

• #name ⇒ String readonly

  Short name of the Segment.

• #skip ⇒ Boolean

  (false) If true, #render will return nil.

• #store ⇒ Eddy::Data::Store

  Data passed down from a Transaction Set.

Instance Method Summary

• #initialize(store, *elements) ⇒ void constructor

  All of a Segment's elements need to be declared in its constructor.

• #render(separator = self.store.element_separator) ⇒ String^?

Constructor Details

#initialize(store, *elements) ⇒ void

All of a Segment's elements need to be declared in its constructor.

Parameters:

• store (Eddy::Data::Store)
• elements (Eddy::Models::Element::Base)

# File 'lib/eddy/models/segment.rb', line 24

def initialize(store, *elements)
  self.skip = false
  self.store = store
  elements.flatten!
  self.elements = elements || []
end

Instance Attribute Details

#elements ⇒ Array<Element>

Returns:

• (Array<Element>)

# File 'lib/eddy/models/segment.rb', line 13

def elements
  @elements
end

#id ⇒ String (readonly)

An alphanumeric code unique to each Segment type.

Returns:

• (String)

# File 'lib/eddy/models/segment.rb', line 8

def id
  @id
end

#name ⇒ String (readonly)

Short name of the Segment.

Returns:

• (String)

# File 'lib/eddy/models/segment.rb', line 11

def name
  @name
end

#skip ⇒ Boolean

Returns (false) If true, #render will return nil.

Returns:

• (Boolean) —

  (false) If true, #render will return nil.

# File 'lib/eddy/models/segment.rb', line 17

def skip
  @skip
end

#store ⇒ Eddy::Data::Store

Returns Data passed down from a Transaction Set.

Returns:

• (Eddy::Data::Store) —

  Data passed down from a Transaction Set.

# File 'lib/eddy/models/segment.rb', line 15

def store
  @store
end

Instance Method Details

#render(separator = self.store.element_separator) ⇒ String^?

Parameters:

• separator (String) (defaults to: self.store.element_separator) —

  (self.store.element_separator) String used to delimit elements within a segment.

Returns:

• (String, nil)

# File 'lib/eddy/models/segment.rb', line 33

def render(separator = self.store.element_separator)
  return nil if self.skip
  segment = [self.id, self.elements.map(&:value)].join(separator)
  return Eddy::Util.trim_delims_from_segment(segment, separator: separator)
end