Packages

c

za.co.absa.cobrix.cobol.reader

VarLenNestedReader

class VarLenNestedReader[T] extends VarLenReader with Logging with Serializable

The Cobol data reader for variable length records that gets input binary data as a stream and produces nested structure schema

Linear Supertypes
Logging, VarLenReader, Reader, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. VarLenNestedReader
  2. Logging
  3. VarLenReader
  4. Reader
  5. Serializable
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new VarLenNestedReader(copybookContents: Seq[String], readerProperties: ReaderParameters, handler: RecordHandler[T])(implicit arg0: ClassTag[T])

    copybookContents

    The contents of a copybook.

    readerProperties

    Additional properties for customizing the reader.

Type Members

  1. type Field = String
    Definition Classes
    Reader
  2. type Value = String
    Definition Classes
    Reader

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. val cobolSchema: CobolSchema
    Attributes
    protected
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. def generateIndex(dataStream: SimpleStream, headerStream: SimpleStream, fileNumber: Int, isRdwBigEndian: Boolean): ArrayBuffer[SparseIndexEntry]

    Traverses the data sequentially as fast as possible to generate record index.

    Traverses the data sequentially as fast as possible to generate record index. This index will be used to distribute workload of the conversion.

    dataStream

    A stream of input binary data

    headerStream

    A stream pointing to the beginning of the file, even if inputStream is pointing to a record in the middle.

    fileNumber

    A file number uniquely identified a particular file of the data set

    returns

    An index of the file

    Definition Classes
    VarLenNestedReaderVarLenReader
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def getCobolSchema: CobolSchema
    Definition Classes
    VarLenNestedReaderReader
  13. def getRecordIterator(dataStream: SimpleStream, headerStream: SimpleStream, startingFileOffset: Long, fileNumber: Int, startingRecordIndex: Long): Iterator[Seq[Any]]

    Returns a file iterator between particular offsets.

    Returns a file iterator between particular offsets. This is for faster traversal of big binary files

    dataStream

    A stream positioned at the beginning of the intended file portion to read

    headerStream

    A stream pointing to the beginning of the file, even if inputStream is pointing to a record in the middle.

    startingFileOffset

    An offset of the file where parsing should be started

    fileNumber

    A file number uniquely identified a particular file of the data set

    startingRecordIndex

    A starting record index of the data

    returns

    An iterator of Spark Row objects

    Definition Classes
    VarLenNestedReaderVarLenReader
  14. def getRecordSize: Int
    Definition Classes
    VarLenNestedReaderReader
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def isIndexGenerationNeeded: Boolean

    Returns true if index generation is requested

    Returns true if index generation is requested

    Definition Classes
    VarLenNestedReaderVarLenReader
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. def isRdwBigEndian: Boolean

    Returns true if RDW header of variable length files is big endian

    Returns true if RDW header of variable length files is big endian

    Definition Classes
    VarLenNestedReaderVarLenReader
  19. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  20. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  21. def logger: Logger
    Attributes
    protected
    Definition Classes
    Logging
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. def recordExtractor(startingRecordNumber: Long, dataStream: SimpleStream, headerStream: SimpleStream, copybook: Copybook): Option[RawRecordExtractor]
  26. val recordHeaderParser: RecordHeaderParser
  27. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Logging

Inherited from VarLenReader

Inherited from Reader

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped