Class/Object

za.co.absa.cobrix.spark.cobol.schema

CobolSchema

Related Docs: object CobolSchema | package schema

Permalink

class CobolSchema extends cobol.reader.schema.CobolSchema with Logging with Serializable

This class provides a view on a COBOL schema from the perspective of Spark. When provided with a parsed copybook the class provides the corresponding Spark schema and also other properties for the Spark data source.

Linear Supertypes
Logging, cobol.reader.schema.CobolSchema, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CobolSchema
  2. Logging
  3. CobolSchema
  4. Serializable
  5. Serializable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CobolSchema(copybook: Copybook, policy: SchemaRetentionPolicy, inputFileNameField: String, generateRecordId: Boolean, generateRecordBytes: Boolean = false, generateSegIdFieldsCnt: Int = 0, segmentIdProvidedPrefix: String = "", metadataPolicy: MetadataPolicy = MetadataPolicy.Basic)

    Permalink

    copybook

    A parsed copybook.

    policy

    Specifies a policy to transform the input schema. The default policy is to keep the schema exactly as it is in the copybook.

    inputFileNameField

    If non-empty, a source file name will be prepended to the beginning of the schema.

    generateRecordId

    If true, a record id field will be prepended to the beginning of the schema.

    generateRecordBytes

    If true, a record bytes field will be appended to the beginning of the schema.

    generateSegIdFieldsCnt

    A number of segment ID levels to generate

    segmentIdProvidedPrefix

    A prefix for each segment id levels to make segment ids globally unique (by default the current timestamp will be used)

    metadataPolicy

    Specifies a policy to generate metadata fields.

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. val copybook: Copybook

    Permalink

    A parsed copybook.

    A parsed copybook.

    Definition Classes
    CobolSchema
  7. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. val generateRecordBytes: Boolean

    Permalink

    If true, a record bytes field will be appended to the beginning of the schema.

    If true, a record bytes field will be appended to the beginning of the schema.

    Definition Classes
    CobolSchema
  11. val generateRecordId: Boolean

    Permalink

    If true, a record id field will be prepended to the beginning of the schema.

    If true, a record id field will be prepended to the beginning of the schema.

    Definition Classes
    CobolSchema
  12. val generateSegIdFieldsCnt: Int

    Permalink

    A number of segment ID levels to generate

    A number of segment ID levels to generate

    Definition Classes
    CobolSchema
  13. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  14. def getCobolSchema: Copybook

    Permalink
    Definition Classes
    CobolSchema
  15. lazy val getRecordSize: Int

    Permalink
    Definition Classes
    CobolSchema
  16. def getSparkFlatSchema: StructType

    Permalink
  17. def getSparkSchema: StructType

    Permalink
  18. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  19. val inputFileNameField: String

    Permalink

    If non-empty, a source file name will be prepended to the beginning of the schema.

    If non-empty, a source file name will be prepended to the beginning of the schema.

    Definition Classes
    CobolSchema
  20. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  21. def isRecordFixedSize: Boolean

    Permalink
    Definition Classes
    CobolSchema
  22. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  23. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  24. def logger: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  25. val metadataPolicy: MetadataPolicy

    Permalink

    Specifies a policy to generate metadata fields.

    Specifies a policy to generate metadata fields.

    Definition Classes
    CobolSchema
  26. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  29. val policy: SchemaRetentionPolicy

    Permalink

    Specifies a policy to transform the input schema.

    Specifies a policy to transform the input schema. The default policy is to keep the schema exactly as it is in the copybook.

    Definition Classes
    CobolSchema
  30. val segmentIdPrefix: String

    Permalink
    Definition Classes
    CobolSchema
  31. val segmentIdProvidedPrefix: String

    Permalink

    A prefix for each segment id levels to make segment ids globally unique (by default the current timestamp will be used)

    A prefix for each segment id levels to make segment ids globally unique (by default the current timestamp will be used)

    Definition Classes
    CobolSchema
  32. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

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

Inherited from Logging

Inherited from cobol.reader.schema.CobolSchema

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped