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 SummaryConstructors Constructor Description FieldDescription()
- 
Method SummaryModifier 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- 
FieldDescriptionpublic FieldDescription()
 
- 
- 
Method Details- 
getNameGets the field name.- Returns:
- the field name
 
- 
setNameSets the field name.- Parameters:
- name- the new field name
 
- 
getTypeGets the field type.- Returns:
- the field type
 
- 
setTypeSets the field type.- Parameters:
- type- the new field type
 
- 
getOffsetpublic 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
 
- 
setOffsetpublic void setOffset(int offset)Sets the field offset.- Parameters:
- offset- the field offset
 
- 
getLengthpublic int getLength()Gets the field length, in bytes. The field length is not used for fields of delimited tables.- Returns:
- the field length
 
- 
setLengthpublic void setLength(int length)Sets the field length, in bytes.- Parameters:
- length- the new field length
 
- 
getMaxLengthpublic int getMaxLength()Gets the maximum field length, in bytes. This is only used for fields of delimited tables.- Returns:
- the max field length
 
- 
setMaxLengthpublic void setMaxLength(int length)Sets the maximum field length, in bytes.- Parameters:
- length- the new maximum field length
 
- 
getStartBitpublic 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
 
- 
setStartBitpublic void setStartBit(int startBit)Sets the start bit, for bit fields.- Parameters:
- startBit- the new start bit
 
- 
getStopBitpublic int getStopBit()Gets the stop bit, for bit fields.- Returns:
- the stop bit
 
- 
setStopBitpublic 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
 
-