Object

za.co.absa.cobrix.spark.cobol.parameters

CobolParametersParser

Related Doc: package parameters

Permalink

object CobolParametersParser extends Logging

This class provides methods for parsing the parameters set as Spark options.

Linear Supertypes
Logging, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CobolParametersParser
  2. Logging
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. val PARAM_ALLOW_PARTIAL_RECORDS: String

    Permalink
  5. val PARAM_ASCII_CHARSET: String

    Permalink
  6. val PARAM_BDW_ADJUSTMENT: String

    Permalink
  7. val PARAM_BINARY_AS_HEX: String

    Permalink
  8. val PARAM_BLOCK_LENGTH: String

    Permalink
  9. val PARAM_COMMENTS_LBOUND: String

    Permalink
  10. val PARAM_COMMENTS_UBOUND: String

    Permalink
  11. val PARAM_COPYBOOK_CONTENTS: String

    Permalink
  12. val PARAM_COPYBOOK_PATH: String

    Permalink
  13. val PARAM_DEBUG: String

    Permalink
  14. val PARAM_DEBUG_IGNORE_FILE_SIZE: String

    Permalink
  15. val PARAM_EBCDIC_CODE_PAGE: String

    Permalink
  16. val PARAM_EBCDIC_CODE_PAGE_CLASS: String

    Permalink
  17. val PARAM_ENABLE_INDEXES: String

    Permalink
  18. val PARAM_ENCODING: String

    Permalink
  19. val PARAM_FIELD_CODE_PAGE_PREFIX: String

    Permalink
  20. val PARAM_FILE_END_OFFSET: String

    Permalink
  21. val PARAM_FILE_START_OFFSET: String

    Permalink
  22. val PARAM_FILLER_NAMING_POLICY: String

    Permalink
  23. val PARAM_FLOATING_POINT_FORMAT: String

    Permalink
  24. val PARAM_GENERATE_RECORD_BYTES: String

    Permalink
  25. val PARAM_GENERATE_RECORD_ID: String

    Permalink
  26. val PARAM_GROUP_FILLERS: String

    Permalink
  27. val PARAM_GROUP_NOT_TERMINALS: String

    Permalink
  28. val PARAM_IMPROVED_NULL_DETECTION: String

    Permalink
  29. val PARAM_IMPROVE_LOCALITY: String

    Permalink
  30. val PARAM_INPUT_FILE_COLUMN: String

    Permalink
  31. val PARAM_INPUT_SPLIT_RECORDS: String

    Permalink
  32. val PARAM_INPUT_SPLIT_SIZE_MB: String

    Permalink
  33. val PARAM_IS_BDW_BIG_ENDIAN: String

    Permalink
  34. val PARAM_IS_RDW_BIG_ENDIAN: String

    Permalink
  35. val PARAM_IS_RDW_PART_REC_LENGTH: String

    Permalink
  36. val PARAM_IS_RECORD_SEQUENCE: String

    Permalink
  37. val PARAM_IS_TEXT: String

    Permalink
  38. val PARAM_IS_UTF16_BIG_ENDIAN: String

    Permalink
  39. val PARAM_IS_XCOM: String

    Permalink
  40. val PARAM_MAXIMUM_RECORD_LENGTH: String

    Permalink
  41. val PARAM_METADATA: String

    Permalink
  42. val PARAM_MINIMUM_RECORD_LENGTH: String

    Permalink
  43. val PARAM_MULTI_COPYBOOK_PATH: String

    Permalink
  44. val PARAM_OCCURS_MAPPINGS: String

    Permalink
  45. val PARAM_OPTIMIZE_ALLOCATION: String

    Permalink
  46. val PARAM_PEDANTIC: String

    Permalink
  47. val PARAM_RDW_ADJUSTMENT: String

    Permalink
  48. val PARAM_RECORDS_PER_BLOCK: String

    Permalink
  49. val PARAM_RECORD_END_OFFSET: String

    Permalink
  50. val PARAM_RECORD_EXTRACTOR: String

    Permalink
  51. val PARAM_RECORD_FORMAT: String

    Permalink
  52. val PARAM_RECORD_HEADER_PARSER: String

    Permalink
  53. val PARAM_RECORD_LENGTH: String

    Permalink
  54. val PARAM_RECORD_LENGTH_FIELD: String

    Permalink
  55. val PARAM_RECORD_START_OFFSET: String

    Permalink
  56. val PARAM_RE_ADDITIONAL_INFO: String

    Permalink
  57. val PARAM_RHP_ADDITIONAL_INFO: String

    Permalink
  58. val PARAM_SCHEMA_RETENTION_POLICY: String

    Permalink
  59. val PARAM_SEGMENT_FIELD: String

    Permalink
  60. val PARAM_SEGMENT_FILTER: String

    Permalink
  61. val PARAM_SEGMENT_ID_LEVEL_PREFIX: String

    Permalink
  62. val PARAM_SEGMENT_ID_PREFIX: String

    Permalink
  63. val PARAM_SEGMENT_ID_ROOT: String

    Permalink
  64. val PARAM_SOURCE_PATH: String

    Permalink
  65. val PARAM_SOURCE_PATHS: String

    Permalink
  66. val PARAM_SOURCE_PATHS_LEGACY: String

    Permalink
  67. val PARAM_STRICT_SIGN_OVERPUNCHING: String

    Permalink
  68. val PARAM_STRING_TRIMMING_POLICY: String

    Permalink
  69. val PARAM_TRUNCATE_COMMENTS: String

    Permalink
  70. val PARAM_VALUE_FILLERS: String

    Permalink
  71. val PARAM_VARIABLE_SIZE_OCCURS: String

    Permalink
  72. val SHORT_NAME: String

    Permalink
  73. final def asInstanceOf[T0]: T0

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  79. def getFieldCodepageMap(parameters: Parameters): Map[String, String]

    Permalink
  80. def getIsEbcdic(params: Parameters, recordFormat: RecordFormat): Boolean

    Permalink
  81. def getOccursMappings(params: String): Map[String, Map[String, Int]]

    Permalink

    Parses the options for the occurs mappings.

    Parses the options for the occurs mappings.

    params

    Parameters provided by spark.read.option(...)

    returns

    Returns a mapping for OCCURS fields

    Annotations
    @throws( classOf[IllegalArgumentException] )
  82. def getReaderProperties(parameters: CobolParameters, defaultBlockSize: Option[Int]): ReaderParameters

    Permalink
  83. def getSegmentIdRedefineMapping(params: Parameters): Map[String, String]

    Permalink

    Parses the list of redefines and their corresponding segment ids.

    Parses the list of redefines and their corresponding segment ids.

    Example: For

    sprak.read
      .option("redefine-segment-id-map:0", "COMPANY => C,D")
      .option("redefine-segment-id-map:1", "CONTACT => P")

    The corresponding mapping will be:

    "C" -> "COMPANY"
    "D" -> "COMPANY"
    "P" -> "PERSON"
    params

    Parameters provided by spark.read.option(...)

    returns

    Returns a sequence of segment ids on the order of hierarchy levels

    Annotations
    @throws( classOf[IllegalArgumentException] )
  84. def getSegmentRedefineParents(params: Parameters): Map[String, String]

    Permalink

    Parses the list of sergent redefine fields and their children for a hierarchical data.

    Parses the list of sergent redefine fields and their children for a hierarchical data. Produces a mapping between redefined fields and their parents. Root level redefines are not added to the mapping since they don't have parents.

    Example: For

    spark.read
      .option("segment-children:0", "COMPANY => DEPT,CUSTOMER")
      .option("segment-children:1", "DEPT => EMPLOYEE,OFFICE")

    The corresponding mapping will be:

    "DEPT" -> "COMPANY"
    "CUSTOMER" -> "COMPANY"
    "EMPLOYEE" -> "DEPT"
    "OFFICE" -> "DEPT"
    params

    Parameters provided by spark.read.option(...)

    returns

    Returns a mapping between redefined fields and their parents

    Annotations
    @throws( classOf[IllegalArgumentException] )
  85. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  86. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  87. def logDebug(msg: ⇒ String): Unit

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  90. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  93. def parse(params: Parameters): CobolParameters

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

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

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

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

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

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

Inherited from Logging

Inherited from AnyRef

Inherited from Any

Ungrouped