Class

za.co.absa.cobrix.cobol.reader.schema

CobolSchema

Related Doc: package schema

Permalink

class CobolSchema extends 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
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CobolSchema
  2. Serializable
  3. Serializable
  4. AnyRef
  5. 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, 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.

  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.

  11. val generateRecordId: Boolean

    Permalink

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

  12. val generateSegIdFieldsCnt: Int

    Permalink

    A number of segment ID levels to generate

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

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

    Permalink
  15. lazy val getRecordSize: Int

    Permalink
  16. def hashCode(): Int

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

    Permalink

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

  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  19. def isRecordFixedSize: Boolean

    Permalink
  20. val metadataPolicy: MetadataPolicy

    Permalink

    Specifies a policy to generate metadata fields.

  21. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  24. 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.

  25. val segmentIdPrefix: String

    Permalink
  26. 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)

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

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

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

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

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

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

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped