Package gov.nasa.pds.label.object

Class FieldDescription

java.lang.Object
gov.nasa.pds.label.object.FieldDescription
public class FieldDescription extends Object
Implements a description of a table field.

  • Constructor Details

    • FieldDescription

      public FieldDescription()

  • Method Details

    • getName

      public String getName()
      Gets the field name.
      Returns:
      the field name

    • setName

      public void setName(String name)
      Sets the field name.
      Parameters:
      name - the new field name

    • getType

      public FieldType getType()
      Gets the field type.
      Returns:
      the field type

    • setType

      public void setType(FieldType type)
      Sets the field type.
      Parameters:
      type - the new field type

    • getOffset

      public int getOffset()
      Gets the field offset, the number of bytes past the beginning of the record where the field starts. The offset is not used for delimited tables.
      Returns:
      the field offset

    • setOffset

      public void setOffset(int offset)
      Sets the field offset.
      Parameters:
      offset - the field offset

    • getLength

      public int getLength()
      Gets the field length, in bytes. The field length is not used for fields of delimited tables.
      Returns:
      the field length

    • setLength

      public void setLength(int length)
      Sets the field length, in bytes.
      Parameters:
      length - the new field length

    • getMaxLength

      public int getMaxLength()
      Gets the maximum field length, in bytes. This is only used for fields of delimited tables.
      Returns:
      the max field length

    • setMaxLength

      public void setMaxLength(int length)
      Sets the maximum field length, in bytes.
      Parameters:
      length - the new maximum field length

    • getStartBit

      public int getStartBit()
      Gets the start bit, for bit fields. Bits are counted from left to right, where zero is the leftmost bit.
      Returns:
      the start bit

    • setStartBit

      public void setStartBit(int startBit)
      Sets the start bit, for bit fields.
      Parameters:
      startBit - the new start bit

    • getStopBit

      public int getStopBit()
      Gets the stop bit, for bit fields.
      Returns:
      the stop bit

    • setStopBit

      public void setStopBit(int stopBit)
      Sets the stop bit, for bit fields.
      Parameters:
      stopBit - the new stop bit

    • getFieldFormat

      public String getFieldFormat()

    • setFieldFormat

      public void setFieldFormat(String format)

    • getValidationFormat

      public String getValidationFormat()

    • setValidationFormat

      public void setValidationFormat(String format)

    • setMinimum

      public void setMinimum(Double min)

    • getMinimum

      public Double getMinimum()

    • setMaximum

      public void setMaximum(Double max)

    • getMaximum

      public Double getMaximum()

    • getSpecialConstants

      public SpecialConstants getSpecialConstants()

    • setSpecialConstants

      public void setSpecialConstants(SpecialConstants specialConstants)