Class

za.co.absa.cobrix.cobol.parser.ast

Primitive

Related Doc: package ast

Permalink

case class Primitive(level: Int, name: String, originalName: String, lineNumber: Int, dataType: CobolType, redefines: Option[String] = None, isRedefined: Boolean = false, occurs: Option[Int] = None, to: Option[Int] = None, dependingOn: Option[String] = None, dependingOnHandlers: Map[String, Int] = Map(), isDependee: Boolean = false, isFiller: Boolean = false, decode: Decoder, binaryProperties: BinaryProperties = BinaryProperties(0, 0, 0))(parent: Option[Group] = None) extends Statement with Product with Serializable

An abstraction of the statements describing fields of primitive data types in the COBOL copybook

level

A level for the statement

name

An identifier

originalName

Original name of the AST element (before the conversion to the Spark-compatible name)

lineNumber

An line number in the copybook

redefines

A name of a field which is redefined by this one

occurs

The number of elements in an fixed size array / minimum items in variable-sized array

to

The maximum number of items in a variable size array

dependingOn

A field which specifies size of the array in a record

parent

A parent node

Linear Supertypes
Serializable, Serializable, Product, Equals, Statement, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Primitive
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Statement
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Primitive(level: Int, name: String, originalName: String, lineNumber: Int, dataType: CobolType, redefines: Option[String] = None, isRedefined: Boolean = false, occurs: Option[Int] = None, to: Option[Int] = None, dependingOn: Option[String] = None, dependingOnHandlers: Map[String, Int] = Map(), isDependee: Boolean = false, isFiller: Boolean = false, decode: Decoder, binaryProperties: BinaryProperties = BinaryProperties(0, 0, 0))(parent: Option[Group] = None)

    Permalink

    level

    A level for the statement

    name

    An identifier

    originalName

    Original name of the AST element (before the conversion to the Spark-compatible name)

    lineNumber

    An line number in the copybook

    redefines

    A name of a field which is redefined by this one

    occurs

    The number of elements in an fixed size array / minimum items in variable-sized array

    to

    The maximum number of items in a variable size array

    dependingOn

    A field which specifies size of the array in a record

    parent

    A parent node

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. def arrayMaxSize: Int

    Permalink

    Returns the maximum OCCURS (array) size of the field.

    Returns the maximum OCCURS (array) size of the field. Returns 1 for non-OCCURS (non-array) fields.

    Definition Classes
    Statement
    Annotations
    @throws( ... )
  5. def arrayMinSize: Int

    Permalink

    Returns the minimum OCCURS (array) size of the field.

    Returns the minimum OCCURS (array) size of the field. Returns 1 for non-OCCURS (non-array) fields.

    Definition Classes
    Statement
    Annotations
    @throws( ... )
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. val binaryProperties: BinaryProperties

    Permalink

    A binary properties of a field

    A binary properties of a field

    Definition Classes
    PrimitiveStatement
  8. def camelCase(s: String): String

    Permalink

    Returns this the name of this fields as a camel cased string

    Returns this the name of this fields as a camel cased string

    Definition Classes
    Statement
  9. val camelCased: String

    Permalink
    Definition Classes
    Statement
  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. val dataType: CobolType

    Permalink
  12. val decode: Decoder

    Permalink
  13. def decodeTypeValue(itOffset: Int, record: Array[Byte]): Any

    Permalink

    Returns a value of a field biven a binary data.

    Returns a value of a field biven a binary data. The return data type depends on the data type of the field

    itOffset

    An offset of the field inside the binary data

    record

    A record in a binary format represented as a vector of bits

    Annotations
    @throws( classOf[Exception] )
  14. val dependingOn: Option[String]

    Permalink

    A field which specifies size of the array in a record

    A field which specifies size of the array in a record

    Definition Classes
    PrimitiveStatement
  15. val dependingOnHandlers: Map[String, Int]

    Permalink

    Returns a mapping used for OCCURS (arrays) integral conversion.

    Returns a mapping used for OCCURS (arrays) integral conversion.

    Definition Classes
    PrimitiveStatement
  16. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def getBinarySizeBytes: Int

    Permalink

    Returns the binary size in bits for the field

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

    Permalink
    Definition Classes
    AnyRef → Any
  20. def isArray: Boolean

    Permalink

    Returns true is the AST element is an array (has OCCURS)

    Returns true is the AST element is an array (has OCCURS)

    Definition Classes
    Statement
  21. def isChildSegment: Boolean

    Permalink

    Returns true if the field is a child segment

    Returns true if the field is a child segment

    Definition Classes
    PrimitiveStatement
  22. val isDependee: Boolean

    Permalink
  23. val isFiller: Boolean

    Permalink

    Returns true if the field is a filler

    Returns true if the field is a filler

    Definition Classes
    PrimitiveStatement
  24. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  25. val isRedefined: Boolean

    Permalink

    Returns true if this field is redefined by some other field

    Returns true if this field is redefined by some other field

    Definition Classes
    PrimitiveStatement
  26. val level: Int

    Permalink

    A level for the statement

    A level for the statement

    Definition Classes
    PrimitiveStatement
  27. val lineNumber: Int

    Permalink

    An line number in the copybook

    An line number in the copybook

    Definition Classes
    PrimitiveStatement
  28. val name: String

    Permalink

    An identifier

    An identifier

    Definition Classes
    PrimitiveStatement
  29. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  32. val occurs: Option[Int]

    Permalink

    The number of elements in an fixed size array / minimum items in variable-sized array

    The number of elements in an fixed size array / minimum items in variable-sized array

    Definition Classes
    PrimitiveStatement
  33. val originalName: String

    Permalink

    Original name of the AST element (before the conversion to the Spark-compatible name)

    Original name of the AST element (before the conversion to the Spark-compatible name)

    Definition Classes
    PrimitiveStatement
  34. val parent: Option[Group]

    Permalink

    A parent node

    A parent node

    Definition Classes
    PrimitiveStatement
  35. val redefines: Option[String]

    Permalink

    A name of a field which is redefined by this one

    A name of a field which is redefined by this one

    Definition Classes
    PrimitiveStatement
  36. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  37. val to: Option[Int]

    Permalink

    The maximum number of items in a variable size array

    The maximum number of items in a variable size array

    Definition Classes
    PrimitiveStatement
  38. def toString(): String

    Permalink

    Returns a string representation of the field

    Returns a string representation of the field

    Definition Classes
    PrimitiveStatement → AnyRef → Any
  39. def up(): Option[Statement]

    Permalink

    Returns a parent of the current node *

    Returns a parent of the current node *

    Definition Classes
    Statement
  40. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. def withUpdatedBinaryProperties(newBinaryProperties: BinaryProperties): Primitive

    Permalink

    Returns the original field with updated binary properties

    Returns the original field with updated binary properties

    Definition Classes
    PrimitiveStatement
  44. def withUpdatedDependingOnHandlers(newDependingOnHandlers: Map[String, Int]): Primitive

    Permalink

    Returns the original AST element with updated isRedefined flag

    Returns the original AST element with updated isRedefined flag

    Definition Classes
    PrimitiveStatement
  45. def withUpdatedIsDependee(newIsDependee: Boolean): Primitive

    Permalink

    Returns the original field with updated isDependee flag

  46. def withUpdatedIsRedefined(newIsRedefined: Boolean): Primitive

    Permalink

    Returns the original field with updated isRedefined flag

    Returns the original field with updated isRedefined flag

    Definition Classes
    PrimitiveStatement

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Statement

Inherited from AnyRef

Inherited from Any

Ungrouped