Package gov.nasa.pds.objectAccess.table
Interface FieldAdapter
- All Known Implementing Classes:
BitFieldAdapter,DefaultFieldAdapter,DoubleBinaryFieldAdapter,FloatBinaryFieldAdapter,IntegerBinaryFieldAdapter,NumericTextFieldAdapter
public interface FieldAdapter
Defines an adapter object for table fields that can
read the field value from a byte array or write the
field value into a byte array. Also has methods for
formatting the value into an output writer for either
delimited or fixed-width output. Methods not appropriate
for the field type will throw
UnsupportedOperationException.-
Method Summary
Modifier and Type Method Description BigIntegergetBigInteger(byte[] buf, int offset, int length, int startBit, int stopBit)Gets the field value as a Java BigInteger.bytegetByte(byte[] buf, int offset, int length, int startBit, int stopBit)Gets the field value as a Java byte.doublegetDouble(byte[] buf, int offset, int length, int startBit, int stopBit)Gets the field value as a Java double.floatgetFloat(byte[] buf, int offset, int length, int startBit, int stopBit)Gets the field value as a Java float.intgetInt(byte[] buf, int offset, int length, int startBit, int stopBit)Gets the field value as a Java int.longgetLong(byte[] buf, int offset, int length, int startBit, int stopBit)Gets the field value as a Java long.shortgetShort(byte[] buf, int offset, int length, int startBit, int stopBit)Gets the field value as a Java short.StringgetString(byte[] buf, int offset, int length, int startBit, int stopBit)Gets the field value as a Java string, using the US-ASCII character set to convert from bytes to characters.StringgetString(byte[] buf, int offset, int length, int startBit, int stopBit, Charset charset)Gets the field value as a Java string, using a specified character set to convert from bytes to characters.voidsetBigInteger(BigInteger value, int offset, int length, ByteBuffer buffer, boolean isRightJustified)Sets the field value as a Java BigInteger.voidsetByte(byte value, int offset, int length, ByteBuffer buffer, boolean isRightJustified)Sets the field value as a Java byte.voidsetDouble(double value, int offset, int length, ByteBuffer buffer, boolean isRightJustified)Sets the field value as a Java double.voidsetFloat(float value, int offset, int length, ByteBuffer buffer, boolean isRightJustified)Sets the field value as a Java float.voidsetInt(int value, int offset, int length, ByteBuffer buffer, boolean isRightJustified)Sets the field value as a Java int.voidsetLong(long value, int offset, int length, ByteBuffer buffer, boolean isRightJustified)Sets the field value as a Java long.voidsetShort(short value, int offset, int length, ByteBuffer buffer, boolean isRightJustified)Sets the field value as a Java short.voidsetString(String value, int offset, int length, ByteBuffer buffer, boolean isRightJustified)Sets the field value as a Java string.voidsetString(String value, int offset, int length, ByteBuffer buffer, boolean isRightJustified, Charset charset)Sets the field value as a Java string, using a specified character set to convert from characters to bytes.
-
Method Details
-
getByte
byte getByte(byte[] buf, int offset, int length, int startBit, int stopBit)Gets the field value as a Java byte.- Parameters:
buf- the byte array containing the fieldoffset- the field offsetlength- the length of the field datastartBit- the start bit, for bit fieldsstopBit- the stop bit, for bit fields- Returns:
- the field value, as a short
-
getShort
short getShort(byte[] buf, int offset, int length, int startBit, int stopBit)Gets the field value as a Java short.- Parameters:
buf- the byte array containing the fieldoffset- the field offsetlength- the length of the field datastartBit- the start bit, for bit fieldsstopBit- the stop bit, for bit fields- Returns:
- the field value, as a short
-
getInt
int getInt(byte[] buf, int offset, int length, int startBit, int stopBit)Gets the field value as a Java int.- Parameters:
buf- the byte array containing the fieldoffset- the field offsetlength- the length of the field datastartBit- the start bit, for bit fieldsstopBit- the stop bit, for bit fields- Returns:
- the field value, as an int
-
getLong
long getLong(byte[] buf, int offset, int length, int startBit, int stopBit)Gets the field value as a Java long.- Parameters:
buf- the byte array containing the fieldoffset- the field offsetlength- the length of the field datastartBit- the start bit, for bit fieldsstopBit- the stop bit, for bit fields- Returns:
- the field value, as a long
-
getBigInteger
Gets the field value as a Java BigInteger.- Parameters:
buf- the byte array containing the fieldoffset- the field offsetlength- the length of the field datastartBit- the start bit, for bit fieldsstopBit- the stop bit, for bit fields- Returns:
- the field value, as a
BigInteger
-
getFloat
float getFloat(byte[] buf, int offset, int length, int startBit, int stopBit)Gets the field value as a Java float.- Parameters:
buf- the byte array containing the fieldoffset- the field offsetlength- the length of the field datastartBit- the start bit, for bit fieldsstopBit- the stop bit, for bit fields- Returns:
- the field value, as a float
-
getDouble
double getDouble(byte[] buf, int offset, int length, int startBit, int stopBit)Gets the field value as a Java double.- Parameters:
buf- the byte array containing the fieldoffset- the field offsetlength- the length of the field datastartBit- the start bit, for bit fieldsstopBit- the stop bit, for bit fields- Returns:
- the field value, as a double
-
getString
Gets the field value as a Java string, using the US-ASCII character set to convert from bytes to characters.- Parameters:
buf- the byte array containing the fieldoffset- the field offsetlength- the length of the field datastartBit- the start bit, for bit fieldsstopBit- the stop bit, for bit fields- Returns:
- the field value, as a string
-
getString
Gets the field value as a Java string, using a specified character set to convert from bytes to characters.- Parameters:
buf- the byte array containing the fieldoffset- the field offsetlength- the length of the field datastartBit- the start bit, for bit fieldsstopBit- the stop bit, for bit fieldscharset- the character set to use when converting bytes to characters- Returns:
- the field value, as a string
-
setString
Sets the field value as a Java string.- Parameters:
value- the field valueoffset- the field offsetlength- the length of the valuebuffer- the byte buffer into which to set the valueisRightJustified- true, if the string value should be right-justified
-
setString
void setString(String value, int offset, int length, ByteBuffer buffer, boolean isRightJustified, Charset charset)Sets the field value as a Java string, using a specified character set to convert from characters to bytes.- Parameters:
value- the field valueoffset- the field offsetlength- the length of the valuebuffer- the byte buffer into which to set the valueisRightJustified- true, if the string value should be right-justifiedcharset- the character set to use when converting the string to bytes
-
setInt
Sets the field value as a Java int.- Parameters:
value- the field valueoffset- the field offsetlength- the length of the valuebuffer- the byte buffer into which to set the valueisRightJustified- true, if the string value should be right-justified
-
setDouble
Sets the field value as a Java double.- Parameters:
value- the field valueoffset- the field offsetlength- the length of the valuebuffer- the byte buffer into which to set the valueisRightJustified- true, if the string value should be right-justified
-
setFloat
Sets the field value as a Java float.- Parameters:
value- the field valueoffset- the field offsetlength- the length of the valuebuffer- the byte buffer into which to set the valueisRightJustified- true, if the string value should be right-justified
-
setShort
Sets the field value as a Java short.- Parameters:
value- the field valueoffset- the field offsetlength- the length of the valuebuffer- the byte buffer into which to set the valueisRightJustified- true, if the string value should be right-justified
-
setByte
Sets the field value as a Java byte.- Parameters:
value- the field valueoffset- the field offsetlength- the length of the valuebuffer- the byte buffer into which to set the valueisRightJustified- true, if the string value should be right-justified
-
setLong
Sets the field value as a Java long.- Parameters:
value- the field valueoffset- the field offsetlength- the length of the valuebuffer- the byte buffer into which to set the valueisRightJustified- true, if the string value should be right-justified
-
setBigInteger
void setBigInteger(BigInteger value, int offset, int length, ByteBuffer buffer, boolean isRightJustified)Sets the field value as a Java BigInteger.- Parameters:
value- the field valueoffset- the field offsetlength- the length of the valuebuffer- the byte buffer into which to set the valueisRightJustified- true, if the string value should be right-justified
-