Class/Object

za.co.absa.cobrix.cobol.parser

Copybook

Related Docs: object Copybook | package parser

Permalink

class Copybook extends Logging with Serializable

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

Instance Constructors

  1. new Copybook(ast: CopybookAST)

    Permalink

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. val ast: CopybookAST

    Permalink
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def dropFillers(dropGroupFillers: Boolean, dropValueFillers: Boolean): Copybook

    Permalink
  8. def dropRoot(): Copybook

    Permalink
  9. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  11. def extractPrimitiveField(field: Primitive, bytes: Array[Byte], startOffset: Int = 0): Any

    Permalink

    Get value of a field of the copybook record by the AST object of the field

    Get value of a field of the copybook record by the AST object of the field

    Nested field names can contain '.' to identify the exact field. If the field name is unique '.' is not required.

    field

    The AST object of the field

    bytes

    Binary encoded data of the record

    startOffset

    An offset to the beginning of the field in the data (in bytes).

    returns

    The value of the field

    Annotations
    @throws( classOf[Exception] )
  12. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. def generateRecordLayoutPositions(): String

    Permalink

    This routine is used for testing by generating a layout position information to compare with mainframe output

  14. def getAllSegmentRedefines: List[CopybookAST]

    Permalink

    Returns all segment redefines defined in an AST.

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

    Permalink
    Definition Classes
    AnyRef → Any
  16. def getCobolSchema: CopybookAST

    Permalink
  17. def getFieldByName(fieldName: String): Statement

    Permalink

    Get the AST object of a field by name.

    Get the AST object of a field by name.

    Nested field names can contain '.' to identify the exact field. If the field name is unique '.' is not required.

    fieldName

    A field name

    returns

    An AST object of the field. Throws an IllegalStateException if not found of found multiple.

    Annotations
    @throws( classOf[IllegalArgumentException] )
  18. def getFieldValueByName(fieldName: String, bytes: Array[Byte], startOffset: Int = 0): Any

    Permalink

    Get value of a field of the copybook record by name

    Get value of a field of the copybook record by name

    Nested field names can contain '.' to identify the exact field. If the field name is unique '.' is not required.

    fieldName

    A field name

    bytes

    Binary encoded data of the record

    startOffset

    An offset where the record starts in the data (in bytes).

    returns

    The value of the field

    Annotations
    @throws( classOf[IllegalStateException] ) @throws( classOf[Exception] )
  19. def getParentChildrenSegmentMap: Map[String, Seq[Group]]

    Permalink

    Returns a mapping from a segment redefine field name to its children.

  20. lazy val getRecordSize: Int

    Permalink
  21. def getRootRecords: Seq[Statement]

    Permalink
  22. def getRootSegmentAST: CopybookAST

    Permalink

    Returns a root segment AST stripped of all child segment ASTs.

  23. def getRootSegmentIds(segmentIdRedefineMap: Map[String, String], fieldParentMap: Map[String, String]): List[String]

    Permalink

    Returns a a list of values of segment ids for the root segment.

  24. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  25. val isFlatCopybook: Boolean

    Permalink
  26. lazy val isHierarchical: Boolean

    Permalink

    Returns true if there at least 1 parent-child relationships defined in any of segment redefines.

  27. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  28. def isRecordFixedSize: Boolean

    Permalink
  29. def logDebug(msg: ⇒ String): Unit

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  35. def restrictTo(fieldName: String): Copybook

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  38. def visitPrimitive(f: (Primitive) ⇒ Unit): Unit

    Permalink

    This method traverses the AST and invokes the provided function on each primitive field

    This method traverses the AST and invokes the provided function on each primitive field

    f

    A function to invoke on each primitive field.

  39. final def wait(): Unit

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

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

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

Inherited from Serializable

Inherited from Serializable

Inherited from Logging

Inherited from AnyRef

Inherited from Any

Ungrouped