com.ibm.jtopenlite.ddm

Class DDMRecordFormat

  • java.lang.Object
    • com.ibm.jtopenlite.ddm.DDMRecordFormat


  • public class DDMRecordFormat
    extends java.lang.Object
    Represents the record format and field information for a file.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      DDMField getField(int index)
      Returns the field at the specified index, or null if the index is not valid.
      DDMField getField(java.lang.String fieldName)
      Returns the field with the specified name, or null if no such field exists in this record format.
      int getFieldCount()
      Returns the number of fields in this record format.
      java.lang.String getFile()
      Returns the name of the file (WHFILE) for this record format.
      int getLength()
      Returns the total length in bytes of this record format.
      java.lang.String getLibrary()
      Returns the library (WHLIB) in which the file resides.
      java.lang.String getName()
      Returns the name (WHNAME) of this record format.
      int getRecommendedBatchSize()
      Returns the recommended batch size to use for reading or writing records with this record format.
      java.lang.String getText()
      Returns the text description (WHTEXT) of this record format.
      java.lang.String getType()
      Returns the file type (WHFTYP) of record format.
      DDMRecordFormat newCopy()
      Returns a new copy of this record format, which includes a new copy of each DDMField.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • newCopy

        public DDMRecordFormat newCopy()
        Returns a new copy of this record format, which includes a new copy of each DDMField. This is useful if multiple threads need to do field conversions on the same record format definition, since the DDMRecordFormat and DDMField classes are not thread-safe, each thread can be given its own copy of the record format, rather than using synchronization to share a single record format.
      • getName

        public java.lang.String getName()
        Returns the name (WHNAME) of this record format.
      • getLibrary

        public java.lang.String getLibrary()
        Returns the library (WHLIB) in which the file resides.
      • getFile

        public java.lang.String getFile()
        Returns the name of the file (WHFILE) for this record format.
      • getType

        public java.lang.String getType()
        Returns the file type (WHFTYP) of record format.
      • getText

        public java.lang.String getText()
        Returns the text description (WHTEXT) of this record format.
      • getLength

        public int getLength()
        Returns the total length in bytes of this record format.
      • getRecommendedBatchSize

        public int getRecommendedBatchSize()
        Returns the recommended batch size to use for reading or writing records with this record format.
      • getFieldCount

        public int getFieldCount()
        Returns the number of fields in this record format.
      • getField

        public DDMField getField(int index)
        Returns the field at the specified index, or null if the index is not valid.
      • getField

        public DDMField getField(java.lang.String fieldName)
        Returns the field with the specified name, or null if no such field exists in this record format.