Package gov.nasa.pds.label.object
Enum FieldType
- All Implemented Interfaces:
Serializable,Comparable<FieldType>,java.lang.constant.Constable
public enum FieldType extends Enum<FieldType>
Defines the set of field types that may appear in tables of
any of the table types. Indicates the type string that
will be found in XML label instances, the field justification
when displayed in fixed-width format, and the field adapter
for reading and writing the field.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum Constants Enum Constant Description ASCII_ANYURIAny URI.ASCII_BIBCODEBibcode data type.ASCII_BOOLEANBoolean true or false.ASCII_DATEA date using day-of-year.ASCII_DATE_DOYA date using day-of-year.ASCII_DATE_TIMEA date using day-of-year.ASCII_DATE_TIME_DOYA date-time using day-of-year.ASCII_DATE_TIME_DOY_UTCA date-time using day-of-year in UTC time zone.ASCII_DATE_TIME_UTCA date-time using year-month-day in UTC time zone.ASCII_DATE_TIME_YMDA date-time using year-month-day.ASCII_DATE_TIME_YMD_UTCA date-time using year-month-day in UTC time zone.ASCII_DATE_YMDA date using year-month-day.ASCII_DIRECTORY_PATH_NAMEA directory path.ASCII_DOIDigital object identifier.ASCII_FILE_NAMEA file name.ASCII_FILE_SPECIFICATION_NAMEA file spec name.ASCII_INTEGERAn integer.ASCII_LIDA logical identifier.ASCII_LIDVIDA logical identifier with version ID.ASCII_LIDVID_LIDA logical identifier with version ID (???).ASCII_MD5_CHECKSUMAn MD5 hash.ASCII_NONNEGATIVE_INTEGERA nonnegative integer.ASCII_NUMERIC_BASE16A hexadecimal integer.ASCII_NUMERIC_BASE2A base 2 integer.ASCII_NUMERIC_BASE8A base 8 integer.ASCII_REALA floating-point value.ASCII_STRINGAn ASCII string.ASCII_TIMEA time.ASCII_VIDA version ID.COMPLEXLSB16A complex, little-endian, 16-byte binary value.COMPLEXLSB8A complex, little-endian, 8-byte binary value.COMPLEXMSB16A complex, big-endian, 16-byte binary value.COMPLEXMSB8A complex, big-endian, 8-byte binary value.IEEE754LSBDOUBLEAn 8-byte, little-endian IEEE real.IEEE754LSBSINGLEA 4-byte, little-endian IEEE real.IEEE754MSBDOUBLEAn 8-byte, big-endian IEEE real.IEEE754MSBSINGLEA 4-byte, big-endian IEEE real.SIGNEDBITSTRINGA signed bit string in a packed field.SIGNEDBYTEA signed 1-byte integer.SIGNEDLSB2A signed, 2-byte, little-endian integer.SIGNEDLSB4A signed, 4-byte, little-endian integer.SIGNEDLSB8A signed, 8-byte, little-endian integer.SIGNEDMSB2A signed, 2-byte, big-endian integer.SIGNEDMSB4A signed, 4-byte, big-endian integer.SIGNEDMSB8A signed, 8-byte, big-endian integer.UNKNOWNUNSIGNEDBITSTRINGAn unsigned bit string in a packed field.UNSIGNEDBYTEAn unsigned, 1-byte integer.UNSIGNEDLSB2An unsigned, 2-byte, little-endian integer.UNSIGNEDLSB4An unsigned, 4-byte, little-endian integer.UNSIGNEDLSB8An unsigned, 8-byte, little-endian integer.UNSIGNEDMSB2An unsigned, 2-byte, big-endian integer.UNSIGNEDMSB4An unsigned, 4-byte, big-endian integer.UNSIGNEDMSB8An unsigned, 8-byte, big-endian integer.UTF8_STRINGA Unicode string encoded into bytes using UTF-8 encoding. -
Method Summary
Modifier and Type Method Description FieldAdaptergetAdapter()Gets a field adapter for this field type.static FieldTypegetFieldType(String xmlType)Gets the proper field type for an XML type string in a label instance.StringgetXMLType()Gets the type string that will occur in XML labels.booleanisRightJustified()Tests whether the field should be right justified on output.static FieldTypevalueOf(String name)Returns the enum constant of this type with the specified name.static FieldType[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
ASCII_ANYURI
Any URI. -
ASCII_BIBCODE
Bibcode data type. -
ASCII_BOOLEAN
Boolean true or false. -
ASCII_DOI
Digital object identifier. -
ASCII_DATE
A date using day-of-year. -
ASCII_DATE_DOY
A date using day-of-year. -
ASCII_DATE_TIME
A date using day-of-year. -
ASCII_DATE_TIME_DOY
A date-time using day-of-year. -
ASCII_DATE_TIME_DOY_UTC
A date-time using day-of-year in UTC time zone. -
ASCII_DATE_TIME_UTC
A date-time using year-month-day in UTC time zone. -
ASCII_DATE_TIME_YMD
A date-time using year-month-day. -
ASCII_DATE_TIME_YMD_UTC
A date-time using year-month-day in UTC time zone. -
ASCII_DATE_YMD
A date using year-month-day. -
ASCII_DIRECTORY_PATH_NAME
A directory path. -
ASCII_FILE_NAME
A file name. -
ASCII_FILE_SPECIFICATION_NAME
A file spec name. -
ASCII_INTEGER
An integer. -
ASCII_LID
A logical identifier. -
ASCII_LIDVID
A logical identifier with version ID. -
ASCII_LIDVID_LID
A logical identifier with version ID (???). -
ASCII_MD5_CHECKSUM
An MD5 hash. -
ASCII_NONNEGATIVE_INTEGER
A nonnegative integer. -
ASCII_NUMERIC_BASE16
A hexadecimal integer. -
ASCII_NUMERIC_BASE2
A base 2 integer. -
ASCII_NUMERIC_BASE8
A base 8 integer. -
ASCII_REAL
A floating-point value. -
ASCII_STRING
An ASCII string. -
ASCII_TIME
A time. -
ASCII_VID
A version ID. -
COMPLEXLSB16
A complex, little-endian, 16-byte binary value. (double real, double imaginary) -
COMPLEXLSB8
A complex, little-endian, 8-byte binary value. (float real, float imaginary) -
COMPLEXMSB16
A complex, big-endian, 16-byte binary value. (double real, double imaginary) -
COMPLEXMSB8
A complex, big-endian, 8-byte binary value. (float real, float imaginary) -
IEEE754LSBDOUBLE
An 8-byte, little-endian IEEE real. -
IEEE754LSBSINGLE
A 4-byte, little-endian IEEE real. -
IEEE754MSBDOUBLE
An 8-byte, big-endian IEEE real. -
IEEE754MSBSINGLE
A 4-byte, big-endian IEEE real. -
SIGNEDBYTE
A signed 1-byte integer. -
SIGNEDLSB2
A signed, 2-byte, little-endian integer. -
SIGNEDLSB4
A signed, 4-byte, little-endian integer. -
SIGNEDLSB8
A signed, 8-byte, little-endian integer. -
SIGNEDMSB2
A signed, 2-byte, big-endian integer. -
SIGNEDMSB4
A signed, 4-byte, big-endian integer. -
SIGNEDMSB8
A signed, 8-byte, big-endian integer. -
UTF8_STRING
A Unicode string encoded into bytes using UTF-8 encoding. -
UNSIGNEDBYTE
An unsigned, 1-byte integer. -
UNSIGNEDLSB2
An unsigned, 2-byte, little-endian integer. -
UNSIGNEDLSB4
An unsigned, 4-byte, little-endian integer. -
UNSIGNEDLSB8
An unsigned, 8-byte, little-endian integer. -
UNSIGNEDMSB2
An unsigned, 2-byte, big-endian integer. -
UNSIGNEDMSB4
An unsigned, 4-byte, big-endian integer. -
UNSIGNEDMSB8
An unsigned, 8-byte, big-endian integer. -
SIGNEDBITSTRING
A signed bit string in a packed field. -
UNSIGNEDBITSTRING
An unsigned bit string in a packed field. -
UNKNOWN
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-
getFieldType
Gets the proper field type for an XML type string in a label instance.- Parameters:
xmlType- the XML type string- Returns:
- the field type corresponding to the XML type
-
getXMLType
Gets the type string that will occur in XML labels.- Returns:
- the XML type string
-
getAdapter
Gets a field adapter for this field type.- Returns:
- the field adapter
-
isRightJustified
public boolean isRightJustified()Tests whether the field should be right justified on output.- Returns:
- true, if the field should be right justified, false otherwise
-