Class

za.co.absa.cobrix.cobol.parser.headerparsers

RecordHeaderParserFixedLen

Related Doc: package headerparsers

Permalink

class RecordHeaderParserFixedLen extends Serializable with RecordHeaderParser

This is a parser for fixed length record files.

Linear Supertypes
RecordHeaderParser, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RecordHeaderParserFixedLen
  2. RecordHeaderParser
  3. Serializable
  4. Serializable
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RecordHeaderParserFixedLen(recordSize: Int, fileHeaderBytes: Int, fileFooterBytes: Int)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def getHeaderLength: Int

    Permalink

    This type of files do not have record headers

    This type of files do not have record headers

    Definition Classes
    RecordHeaderParserFixedLenRecordHeaderParser
  11. def getRecordMetadata(header: Array[Byte], fileOffset: Long, maxOffset: Long, fileSize: Long, recordNum: Long): RecordMetadata

    Permalink

    Given a raw values of a record header returns metadata sufficient to parse the record.

    Given a raw values of a record header returns metadata sufficient to parse the record.

    header

    A record header as an array of bytes

    fileOffset

    An offset from the beginning of the underlying file

    maxOffset

    A maximum offset allowed to read by the current index chunk

    fileSize

    A size of the underlying file

    recordNum

    A sequential record number

    returns

    A parsed record metadata

    Definition Classes
    RecordHeaderParserFixedLenRecordHeaderParser
  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  13. def isHeaderDefinedInCopybook: Boolean

    Permalink

    If true the record parser will expect record headers to be defined in the copybook itself.

    If true the record parser will expect record headers to be defined in the copybook itself. If false the headers are not expected to be defined in the copybook and the number of bytes returned by getHeaderLength will be truncated before record bytes are passed to the parser.

    Definition Classes
    RecordHeaderParserFixedLenRecordHeaderParser
  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. def onReceiveAdditionalInfo(additionalInfo: String): Unit

    Permalink

    Clients of 'spark-cobol' can pass additional information to custom record header parsers using

    Clients of 'spark-cobol' can pass additional information to custom record header parsers using

    .option("rhp_additional_info", "...anything as a string...")

    If a client provides any additional info the method will be executed just after constructing the record header parser.

    Built-in record header parsers ignore the additional info. This info string is intended for custom record header parsers.

    additionalInfo

    A string provided by a client for the record header parser.

    Definition Classes
    RecordHeaderParser
  19. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  20. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  21. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from RecordHeaderParser

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped