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 Summary
Constructors Constructor Description FieldDescription() -
Method Summary
Modifier and Type Method Description StringgetFieldFormat()intgetLength()Gets the field length, in bytes.DoublegetMaximum()intgetMaxLength()Gets the maximum field length, in bytes.DoublegetMinimum()StringgetName()Gets the field name.intgetOffset()Gets the field offset, the number of bytes past the beginning of the record where the field starts.intgetStartBit()Gets the start bit, for bit fields.intgetStopBit()Gets the stop bit, for bit fields.FieldTypegetType()Gets the field type.StringgetValidationFormat()voidsetFieldFormat(String format)voidsetLength(int length)Sets the field length, in bytes.voidsetMaximum(Double max)voidsetMaxLength(int length)Sets the maximum field length, in bytes.voidsetMinimum(Double min)voidsetName(String name)Sets the field name.voidsetOffset(int offset)Sets the field offset.voidsetStartBit(int startBit)Sets the start bit, for bit fields.voidsetStopBit(int stopBit)Sets the stop bit, for bit fields.voidsetType(FieldType type)Sets the field type.voidsetValidationFormat(String format)
-
Constructor Details
-
FieldDescription
public FieldDescription()
-
-
Method Details
-
getName
Gets the field name.- Returns:
- the field name
-
setName
Sets the field name.- Parameters:
name- the new field name
-
getType
Gets the field type.- Returns:
- the field type
-
setType
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
-
setFieldFormat
-
getValidationFormat
-
setValidationFormat
-
setMinimum
-
getMinimum
-
setMaximum
-
getMaximum
-