Module org.eclipse.persistence.nosql
Package org.eclipse.persistence.internal.eis.cobol

Interface FieldMetaData

All Known Implementing Classes:
CompositeFieldMetaData, ElementaryFieldMetaData
public interface FieldMetaData
Purpose: This interface defines behavior for a field meta data be they elementary or composite. This allows reference to either type field indiscriminatly. It also defines some statics for use in the type attribute of field meta data.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ALPHA_NUMERIC
     
    static final int
    ALPHABETIC
     
    static final int
    BINARY
     
    static final int
    COMPOSITE
     
    static final int
    MANTISSA
     
    static final int
    NUMERIC
     
    static final int
    PACKED_DECIMAL
     
    static final int
    VOID
     

  • Method Summary

    Modifier and Type
    Method
    Description
    FieldMetaData
    deepCopy()
    this method returns an new instance with the same values
    boolean
    dependsOn()
    this method returns true if the array size depends on another field
    Object
    extractValueFromArray(byte[] recordData)
    this method will extract the field's value from a byte array
    int
    getArraySize()
    this method returns the array size
    int
    getDecimalPosition()
    this method returns the decimal position index
    String
    getDependentFieldName()
    this method returns the name of the dependent field name
    FieldMetaData
    getFieldRedefined()
    this method returns the field that is redefined
    String
    getName()
    this method will return the name of the field
    int
    getOffset()
    this method returns the offset, in bytes, of the field in the record
    RecordMetaData
    getRecord()
    this method will return the associated record
    int
    getSize()
    this method will return the size in bytes of the field
    int
    getType()
    this method returns the type of the field
    boolean
    hasDecimal()
    this method returns true is the field has a preset decimal position
    boolean
    isArray()
    this method returns true if this field is an array
    boolean
    isComposite()
    this method returns true if the field is composite, false otherwise
    boolean
    isFieldRedefine()
    this method sets whether this is a field redefine or not
    boolean
    isSigned()
    this method returns true if the field is signed
    void
    setArraySize(int newSize)
    this method sets the array size for the field
    void
    setDecimalPosition(int newPosition)
    this method sets the decimal position to the new index
    void
    setDependentFieldName(String fieldName)
    this method sets the dependent field name
    void
    setFieldRedefined(FieldMetaData field)
    this method sets the redefined field
    void
    setIsFieldRedefine(boolean status)
    this method sets the boolean for field redefine to true
    void
    setIsSigned(boolean signed)
    this method sets the signed attribute for the field
    void
    setName(String newName)
    this method will set the name of the field
    void
    setOffset(int offset)
    this method sets the offset of the field
    void
    setRecord(RecordMetaData newRecord)
    this method will set the assoicated record
    void
    setSize(int size)
    this method will set the size of the field
    void
    setType(int type)
    this method sets the type of the field
    void
    writeOnArray(CobolRow row, byte[] recordData)
    this method will write itself on the given byte array from the data in the row
    void
    writeOnRow(CobolRow row, byte[] recordData)
    this method will write itself on the give row extracting the data from the given byte array

  • Field Details

  • Method Details

    • deepCopy

      FieldMetaData deepCopy()
      this method returns an new instance with the same values

    • isSigned

      boolean isSigned()
      this method returns true if the field is signed

    • setIsSigned

      void setIsSigned(boolean signed)
      this method sets the signed attribute for the field

    • getName

      String getName()
      this method will return the name of the field

    • setName

      void setName(String newName)
      this method will set the name of the field

    • getRecord

      RecordMetaData getRecord()
      this method will return the associated record

    • setRecord

      void setRecord(RecordMetaData newRecord)
      this method will set the assoicated record

    • getSize

      int getSize()
      this method will return the size in bytes of the field

    • setSize

      void setSize(int size)
      this method will set the size of the field

    • isComposite

      boolean isComposite()
      this method returns true if the field is composite, false otherwise

    • getOffset

      int getOffset()
      this method returns the offset, in bytes, of the field in the record

    • setOffset

      void setOffset(int offset)
      this method sets the offset of the field

    • getType

      int getType()
      this method returns the type of the field

    • setType

      void setType(int type)
      this method sets the type of the field

    • isFieldRedefine

      boolean isFieldRedefine()
      this method sets whether this is a field redefine or not

    • setIsFieldRedefine

      void setIsFieldRedefine(boolean status)
      this method sets the boolean for field redefine to true

    • setFieldRedefined

      void setFieldRedefined(FieldMetaData field)
      this method sets the redefined field

    • getFieldRedefined

      FieldMetaData getFieldRedefined()
      this method returns the field that is redefined

    • hasDecimal

      boolean hasDecimal()
      this method returns true is the field has a preset decimal position

    • getDecimalPosition

      int getDecimalPosition()
      this method returns the decimal position index

    • setDecimalPosition

      void setDecimalPosition(int newPosition)
      this method sets the decimal position to the new index

    • isArray

      boolean isArray()
      this method returns true if this field is an array

    • getArraySize

      int getArraySize()
      this method returns the array size

    • setArraySize

      void setArraySize(int newSize)
      this method sets the array size for the field

    • dependsOn

      boolean dependsOn()
      this method returns true if the array size depends on another field

    • getDependentFieldName

      String getDependentFieldName()
      this method returns the name of the dependent field name

    • setDependentFieldName

      void setDependentFieldName(String fieldName)
      this method sets the dependent field name

    • extractValueFromArray

      Object extractValueFromArray(byte[] recordData)
      this method will extract the field's value from a byte array

    • writeOnRow

      void writeOnRow(CobolRow row, byte[] recordData)
      this method will write itself on the give row extracting the data from the given byte array

    • writeOnArray

      void writeOnArray(CobolRow row, byte[] recordData)
      this method will write itself on the given byte array from the data in the row