CobolParameters

This class holds parameters for the job.

copybookPath: String containing the path to the copybook in a given file system.
multiCopybookPath: Sequence containing the paths to the copybooks.
copybookContent: String containing the actual content of the copybook. Either this, the copybookPath, or multiCopybookPath parameter must be specified.
sourcePath: String containing the path to the Cobol file to be parsed.
isText: If true the input data consists of text files where records are separated by a line ending character
isEbcdic: If true the input data file encoding is EBCDIC, otherwise it is ASCII
ebcdicCodePage: Specifies what code page to use for EBCDIC to ASCII/Unicode conversions
ebcdicCodePageClass: An optional custom code page conversion class provided by a user
asciiCharset: A charset for ASCII data
isUtf16BigEndian: If true UTF-16 is considered big-endian.
floatingPointFormat: A format of floating-point numbers
recordStartOffset: A number of bytes to skip at the beginning of the record before parsing a record according to a copybook
recordEndOffset: A number of bytes to skip at the end of each record
variableLengthParams: VariableLengthParameters containing the specifications for the consumption of variable-length Cobol records.
schemaRetentionPolicy: A copybook usually has a root group struct element that acts like a rowtag in XML. This can be retained in Spark schema or can be collapsed
stringTrimmingPolicy: Specify if and how strings should be trimmed when parsed
multisegmentParams: Parameters for reading multisegment mainframe files
commentPolicy: A comment truncation policy
dropGroupFillers: If true the parser will drop all FILLER fields, even GROUP FILLERS that have non-FILLER nested fields
nonTerminals: A list of non-terminals (GROUPS) to combine and parse as primitive fields
debugFieldsPolicy: Specifies if debugging fields need to be added and what should they contain (false, hex, raw).
debugIgnoreFileSize: If true the fixed length file reader won't check file size divisibility. Useful for debugging binary file / copybook mismatches.

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new CobolParameters(copybookPath: Option[String], multiCopybookPath: Seq[String], copybookContent: Option[String], sourcePath: Option[String], isText: Boolean, isEbcdic: Boolean, ebcdicCodePage: String, ebcdicCodePageClass: Option[String], asciiCharset: String, isUtf16BigEndian: Boolean, floatingPointFormat: FloatingPointFormat, recordStartOffset: Int, recordEndOffset: Int, variableLengthParams: Option[VariableLengthParameters], schemaRetentionPolicy: SchemaRetentionPolicy, stringTrimmingPolicy: StringTrimmingPolicy, multisegmentParams: Option[MultisegmentParameters], commentPolicy: CommentPolicy, dropGroupFillers: Boolean, nonTerminals: Seq[String], occursMappings: Map[String, Map[String, Int]], debugFieldsPolicy: DebugFieldsPolicy, debugIgnoreFileSize: Boolean)

copybookPath
String containing the path to the copybook in a given file system.
multiCopybookPath
Sequence containing the paths to the copybooks.
copybookContent
String containing the actual content of the copybook. Either this, the copybookPath, or multiCopybookPath parameter must be specified.
sourcePath
String containing the path to the Cobol file to be parsed.
isText
If true the input data consists of text files where records are separated by a line ending character
isEbcdic
If true the input data file encoding is EBCDIC, otherwise it is ASCII
ebcdicCodePage
Specifies what code page to use for EBCDIC to ASCII/Unicode conversions
ebcdicCodePageClass
An optional custom code page conversion class provided by a user
asciiCharset
A charset for ASCII data
isUtf16BigEndian
If true UTF-16 is considered big-endian.
floatingPointFormat
A format of floating-point numbers
recordStartOffset
A number of bytes to skip at the beginning of the record before parsing a record according to a copybook
recordEndOffset
A number of bytes to skip at the end of each record
variableLengthParams
VariableLengthParameters containing the specifications for the consumption of variable-length Cobol records.
schemaRetentionPolicy
A copybook usually has a root group struct element that acts like a rowtag in XML. This can be retained in Spark schema or can be collapsed
stringTrimmingPolicy
Specify if and how strings should be trimmed when parsed
multisegmentParams
Parameters for reading multisegment mainframe files
commentPolicy
A comment truncation policy
dropGroupFillers
If true the parser will drop all FILLER fields, even GROUP FILLERS that have non-FILLER nested fields
nonTerminals
A list of non-terminals (GROUPS) to combine and parse as primitive fields
debugFieldsPolicy
Specifies if debugging fields need to be added and what should they contain (false, hex, raw).
debugIgnoreFileSize
If true the fixed length file reader won't check file size divisibility. Useful for debugging binary file / copybook mismatches.

Value Members

final def !=(arg0: Any): Boolean

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

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

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

Definition Classes
Any
val asciiCharset: String

A charset for ASCII data
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val commentPolicy: CommentPolicy

A comment truncation policy
val copybookContent: Option[String]

String containing the actual content of the copybook.
String containing the actual content of the copybook. Either this, the copybookPath, or multiCopybookPath parameter must be specified.
val copybookPath: Option[String]

String containing the path to the copybook in a given file system.
val debugFieldsPolicy: DebugFieldsPolicy

Specifies if debugging fields need to be added and what should they contain (false, hex, raw).
val debugIgnoreFileSize: Boolean

If true the fixed length file reader won't check file size divisibility.
If true the fixed length file reader won't check file size divisibility. Useful for debugging binary file / copybook mismatches.
val dropGroupFillers: Boolean

If true the parser will drop all FILLER fields, even GROUP FILLERS that have non-FILLER nested fields
val ebcdicCodePage: String

Specifies what code page to use for EBCDIC to ASCII/Unicode conversions
val ebcdicCodePageClass: Option[String]

An optional custom code page conversion class provided by a user
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
val floatingPointFormat: FloatingPointFormat

A format of floating-point numbers
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val isEbcdic: Boolean

If true the input data file encoding is EBCDIC, otherwise it is ASCII
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val isText: Boolean

If true the input data consists of text files where records are separated by a line ending character
val isUtf16BigEndian: Boolean

If true UTF-16 is considered big-endian.
val multiCopybookPath: Seq[String]

Sequence containing the paths to the copybooks.
val multisegmentParams: Option[MultisegmentParameters]

Parameters for reading multisegment mainframe files
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val nonTerminals: Seq[String]

A list of non-terminals (GROUPS) to combine and parse as primitive fields
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val occursMappings: Map[String, Map[String, Int]]
val recordEndOffset: Int

A number of bytes to skip at the end of each record
val recordStartOffset: Int

A number of bytes to skip at the beginning of the record before parsing a record according to a copybook
val schemaRetentionPolicy: SchemaRetentionPolicy

A copybook usually has a root group struct element that acts like a rowtag in XML.
A copybook usually has a root group struct element that acts like a rowtag in XML. This can be retained in Spark schema or can be collapsed
val sourcePath: Option[String]

String containing the path to the Cobol file to be parsed.
val stringTrimmingPolicy: StringTrimmingPolicy

Specify if and how strings should be trimmed when parsed
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val variableLengthParams: Option[VariableLengthParameters]

VariableLengthParameters containing the specifications for the consumption of variable-length Cobol records.
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package parameters

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val asciiCharset: String

def clone(): AnyRef

val commentPolicy: CommentPolicy

val copybookContent: Option[String]

val copybookPath: Option[String]

val debugFieldsPolicy: DebugFieldsPolicy

val debugIgnoreFileSize: Boolean

val dropGroupFillers: Boolean

val ebcdicCodePage: String

val ebcdicCodePageClass: Option[String]

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

val floatingPointFormat: FloatingPointFormat

final def getClass(): Class[_]

val isEbcdic: Boolean

final def isInstanceOf[T0]: Boolean

val isText: Boolean

val isUtf16BigEndian: Boolean

val multiCopybookPath: Seq[String]

val multisegmentParams: Option[MultisegmentParameters]

final def ne(arg0: AnyRef): Boolean

val nonTerminals: Seq[String]

final def notify(): Unit

final def notifyAll(): Unit

val occursMappings: Map[String, Map[String, Int]]

val recordEndOffset: Int

val recordStartOffset: Int

val schemaRetentionPolicy: SchemaRetentionPolicy

val sourcePath: Option[String]

val stringTrimmingPolicy: StringTrimmingPolicy

final def synchronized[T0](arg0: ⇒ T0): T0

val variableLengthParams: Option[VariableLengthParameters]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped