Class/Object

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

Group

Related Docs: object Group | package ast

Permalink

case class Group(level: Int, name: String, originalName: String, lineNumber: Int, children: ArrayBuffer[Statement] = mutable.ArrayBuffer(), redefines: Option[String] = None, isRedefined: Boolean = false, isSegmentRedefine: Boolean = false, parentSegment: Option[Group] = None, occurs: Option[Int] = None, to: Option[Int] = None, dependingOn: Option[String] = None, dependingOnHandlers: Map[String, Int] = Map(), isFiller: Boolean = false, groupUsage: Option[Usage] = None, nonFillerSize: Int = 0, binaryProperties: BinaryProperties = BinaryProperties(0, 0, 0))(parent: Option[Group] = None) extends Statement with Product with Serializable

An abstraction for the non-leaves 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

children

Child entities

redefines

A name of a field which is redefined by this one

isRedefined

Is the field redefined by an other field

isSegmentRedefine

Is the field corresponds to one of the segments (it should be a redefine)

parentSegment

Specifies a parent segment for a segment redefine in hierarchical files

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

isFiller

Is the group a filler (unnamed block of data)

groupUsage

A USAGE to be inherited by all the fields in the group

nonFillerSize

The number of non-filler children in the group

binaryProperties

Pre-calculated offsets and sizes of thebinary data of the group

parent

A parent node

Linear Supertypes
Serializable, Serializable, Product, Equals, Statement, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Group
  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 Group(level: Int, name: String, originalName: String, lineNumber: Int, children: ArrayBuffer[Statement] = mutable.ArrayBuffer(), redefines: Option[String] = None, isRedefined: Boolean = false, isSegmentRedefine: Boolean = false, parentSegment: Option[Group] = None, occurs: Option[Int] = None, to: Option[Int] = None, dependingOn: Option[String] = None, dependingOnHandlers: Map[String, Int] = Map(), isFiller: Boolean = false, groupUsage: Option[Usage] = None, nonFillerSize: Int = 0, 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

    children

    Child entities

    redefines

    A name of a field which is redefined by this one

    isRedefined

    Is the field redefined by an other field

    isSegmentRedefine

    Is the field corresponds to one of the segments (it should be a redefine)

    parentSegment

    Specifies a parent segment for a segment redefine in hierarchical files

    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

    isFiller

    Is the group a filler (unnamed block of data)

    groupUsage

    A USAGE to be inherited by all the fields in the group

    nonFillerSize

    The number of non-filler children in the group

    binaryProperties

    Pre-calculated offsets and sizes of thebinary data of the group

    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 add[T <: Statement](tree: T): Statement

    Permalink

    This method is used to add a za.co.absa.cobrix.cobol.parser.ast.Statement object as a child of another za.co.absa.cobrix.cobol.parser.ast.Statement object

    This method is used to add a za.co.absa.cobrix.cobol.parser.ast.Statement object as a child of another za.co.absa.cobrix.cobol.parser.ast.Statement object

    T

    Either Group or Primitive

    tree

    A tree to add this item to

    returns

    the new tree

    Annotations
    @throws( ... )
  5. 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( ... )
  6. 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( ... )
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. val binaryProperties: BinaryProperties

    Permalink

    Pre-calculated offsets and sizes of thebinary data of the group

    Pre-calculated offsets and sizes of thebinary data of the group

    Definition Classes
    GroupStatement
  9. 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
  10. val camelCased: String

    Permalink
    Definition Classes
    Statement
  11. val children: ArrayBuffer[Statement]

    Permalink

    Child entities

  12. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. 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
    GroupStatement
  14. 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
    GroupStatement
  15. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  18. val groupUsage: Option[Usage]

    Permalink

    A USAGE to be inherited by all the fields in the group

  19. 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
  20. def isChildSegment: Boolean

    Permalink

    Returns true if the field is a child segment

    Returns true if the field is a child segment

    Definition Classes
    GroupStatement
  21. val isFiller: Boolean

    Permalink

    Is the group a filler (unnamed block of data)

    Is the group a filler (unnamed block of data)

    Definition Classes
    GroupStatement
  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  23. val isRedefined: Boolean

    Permalink

    Is the field redefined by an other field

    Is the field redefined by an other field

    Definition Classes
    GroupStatement
  24. val isSegmentRedefine: Boolean

    Permalink

    Is the field corresponds to one of the segments (it should be a redefine)

  25. val level: Int

    Permalink

    A level for the statement

    A level for the statement

    Definition Classes
    GroupStatement
  26. val lineNumber: Int

    Permalink

    An line number in the copybook

    An line number in the copybook

    Definition Classes
    GroupStatement
  27. val name: String

    Permalink

    An identifier

    An identifier

    Definition Classes
    GroupStatement
  28. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  29. val nonFillerSize: Int

    Permalink

    The number of non-filler children in the group

  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
    GroupStatement
  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
    GroupStatement
  34. val parent: Option[Group]

    Permalink

    A parent node

    A parent node

    Definition Classes
    GroupStatement
  35. val parentSegment: Option[Group]

    Permalink

    Specifies a parent segment for a segment redefine in hierarchical files

  36. 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
    GroupStatement
  37. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  38. 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
    GroupStatement
  39. def toString(): String

    Permalink

    Returns a string representation of the AST element

    Returns a string representation of the AST element

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

    Permalink

    Returns a parent of the current node *

    Returns a parent of the current node *

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. def withUpdatedBinaryProperties(newBinaryProperties: BinaryProperties): Group

    Permalink

    Returns the original Group with updated binary properties

    Returns the original Group with updated binary properties

    Definition Classes
    GroupStatement
  45. def withUpdatedChildren(newChildren: ArrayBuffer[Statement]): Group

    Permalink

    Returns the original Group with updated children

  46. def withUpdatedDependingOnHandlers(newDependingOnHandlers: Map[String, Int]): Group

    Permalink

    Returns the original AST element with updated isRedefined flag

    Returns the original AST element with updated isRedefined flag

    Definition Classes
    GroupStatement
  47. def withUpdatedIsRedefined(newIsRedefined: Boolean): Group

    Permalink

    Returns the original Group with updated isRedefined flag

    Returns the original Group with updated isRedefined flag

    Definition Classes
    GroupStatement
  48. def withUpdatedIsSegmentRedefine(newIsSegmentRedefine: Boolean): Group

    Permalink

    Returns the original AST element with updated isSegmentRedefine flag

  49. def withUpdatedParentSegment(newParentSegmentOpt: Option[Group]): Group

    Permalink

    Returns the original AST element with updated isSegmentRedefine flag

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Statement

Inherited from AnyRef

Inherited from Any

Ungrouped