Package edu.wisc.ssec.mcidasv.data

Class HeaderInfo

java.lang.Object

edu.wisc.ssec.mcidasv.data.HeaderInfo

Direct Known Subclasses:

AxformInfo, EnviInfo

public class HeaderInfo
extends Object

"Base" class that represents several different types of header files.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BANDFILES
static final String	BANDNAMES
static final String	BIGENDIAN
static final String	BYTEORDER
static final String	DATATYPE
static final String	DESCRIPTION
static final String	ELEMENTS
private String	headerFile	Path to header file.
static final String	INTERLEAVE
static final int	kFormat1ByteUInt
static final int	kFormat2ByteSInt
static final int	kFormat2ByteUInt
static final int	kFormat2x8Byte
static final int	kFormat4ByteFloat
static final int	kFormat4ByteSInt
static final int	kFormat8ByteDouble
static final int	kFormatASCII
static final int	kFormatImage
static final int	kFormatUnknown
static final String	kInterleaveByLine
static final String	kInterleaveByPixel
static final String	kInterleaveSequential
static final int	kNavigationBounds
static final int	kNavigationFiles
static final int	kNavigationUnknown
static final String	LINES
static final String	MISSINGVALUE
static final String	NAVBOUNDS
static final String	NAVFILES
static final String	OFFSET
private Hashtable	parameters	Map containing relevant parameters and values in headerFile.
static final String	UNIT

Constructor Summary

Constructors

Constructor	Description
HeaderInfo()	Ctor for xml encoding
HeaderInfo(File thisFile)	CTOR
HeaderInfo(String filename)	CTOR

Method Summary

Modifier and Type	Method	Description
boolean	doesExist()	Does the file we are pointing to even exist?
int	getBandCount()	Get the current header's band count.
String	getFilename()	Get the file being used.
Boolean	getParameter(String parameter, Boolean defaultValue)	Return Boolean value associated with parameter.
Float	getParameter(String parameter, Float defaultValue)	Return Float value associated with parameter.
Integer	getParameter(String parameter, Integer defaultValue)	Return Integer value associated with parameter.
String	getParameter(String parameter, String defaultValue)	Return String value associated with parameter.
List	getParameter(String parameter, List defaultValue)	Return List associated with parameter.
boolean	haveParsed()	Have we already parsed once?
protected void	parseHeader()	Override this when extending for a specific header type
void	setFilename(String filename)	Set the file name to be used.
void	setParameter(String parameter, Object value)	Set a parsed parameter value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

kFormatUnknown

public static final int kFormatUnknown

See Also:

• Constant Field Values

kFormatASCII

public static final int kFormatASCII

See Also:

• Constant Field Values

kFormat1ByteUInt

public static final int kFormat1ByteUInt

See Also:

• Constant Field Values

kFormat2ByteSInt

public static final int kFormat2ByteSInt

See Also:

• Constant Field Values

kFormat4ByteSInt

public static final int kFormat4ByteSInt

See Also:

• Constant Field Values

kFormat4ByteFloat

public static final int kFormat4ByteFloat

See Also:

• Constant Field Values

kFormat8ByteDouble

public static final int kFormat8ByteDouble

See Also:

• Constant Field Values

kFormat2x8Byte

public static final int kFormat2x8Byte

See Also:

• Constant Field Values

kFormat2ByteUInt

public static final int kFormat2ByteUInt

See Also:

• Constant Field Values

kFormatImage

public static final int kFormatImage

See Also:

• Constant Field Values

kNavigationUnknown

public static final int kNavigationUnknown

See Also:

• Constant Field Values

kNavigationBounds

public static final int kNavigationBounds

See Also:

• Constant Field Values

kNavigationFiles

public static final int kNavigationFiles

See Also:

• Constant Field Values

kInterleaveSequential

public static final String kInterleaveSequential

See Also:

• Constant Field Values

kInterleaveByLine

public static final String kInterleaveByLine

See Also:

• Constant Field Values

kInterleaveByPixel

public static final String kInterleaveByPixel

See Also:

• Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

See Also:

• Constant Field Values

ELEMENTS

public static final String ELEMENTS

See Also:

• Constant Field Values

LINES

public static final String LINES

See Also:

• Constant Field Values

UNIT

public static final String UNIT

See Also:

• Constant Field Values

OFFSET

public static final String OFFSET

See Also:

• Constant Field Values

DATATYPE

public static final String DATATYPE

See Also:

• Constant Field Values

MISSINGVALUE

public static final String MISSINGVALUE

See Also:

• Constant Field Values

BANDNAMES

public static final String BANDNAMES

See Also:

• Constant Field Values

BANDFILES

public static final String BANDFILES

See Also:

• Constant Field Values

INTERLEAVE

public static final String INTERLEAVE

See Also:

• Constant Field Values

BYTEORDER

public static final String BYTEORDER

See Also:

• Constant Field Values

BIGENDIAN

public static final String BIGENDIAN

See Also:

• Constant Field Values

NAVBOUNDS

public static final String NAVBOUNDS

See Also:

• Constant Field Values

NAVFILES

public static final String NAVFILES

See Also:

• Constant Field Values

headerFile

private String headerFile

Path to header file.

parameters

private Hashtable parameters

Map containing relevant parameters and values in headerFile.

Constructor Details

HeaderInfo

public HeaderInfo()

Ctor for xml encoding

HeaderInfo

public HeaderInfo(File thisFile)

CTOR

Parameters:

thisFile - File to use. Cannot be null.

HeaderInfo

public HeaderInfo(String filename)

CTOR

Parameters:

filename - File containing header information.

Method Details

setFilename

public void setFilename(String filename)

Set the file name to be used.

Parameters:

filename - File containing header information.

getFilename

public String getFilename()

Get the file being used.

Returns:

File in use.

getBandCount

public int getBandCount()

Get the current header's band count.

Returns:

Number of bands.

getParameter

public String getParameter(String parameter,
 String defaultValue)

Return String value associated with parameter.

Parameters:

parameter - Parameter name.

defaultValue - Value to return if parameter does not exist.

Returns:

Either the List associated with parameter, or defaultValue.

getParameter

public Integer getParameter(String parameter,
 Integer defaultValue)

Return Integer value associated with parameter.

Parameters:

parameter - Parameter name.

defaultValue - Value to return if parameter does not exist.

Returns:

Either the Integer associated with parameter, or defaultValue.

getParameter

public Float getParameter(String parameter,
 Float defaultValue)

Return Float value associated with parameter.

Parameters:

parameter - Parameter name.

defaultValue - Value to return if parameter does not exist.

Returns:

Either the Float associated with parameter, or defaultValue.

getParameter

public Boolean getParameter(String parameter,
 Boolean defaultValue)

Return Boolean value associated with parameter.

Parameters:

parameter - Parameter name.

defaultValue - Value to return if parameter does not exist.

Returns:

Either the Boolean associated with parameter, or defaultValue.

getParameter

public List getParameter(String parameter,
 List defaultValue)

Return List associated with parameter.

Parameters:

parameter - Parameter name.

defaultValue - Value to return if parameter does not exist.

Returns:

Either the List associated with parameter, or defaultValue.

setParameter

public void setParameter(String parameter,
 Object value)

Set a parsed parameter value.

Parameters:

parameter - Parameter name.

value - Value associated with parameter.

haveParsed

public boolean haveParsed()

Have we already parsed once?

Returns:

true if parameters has at least entry.

doesExist

public boolean doesExist()

Does the file we are pointing to even exist?

Returns:

Whether or not headerFile exists.

parseHeader

protected void parseHeader()

Override this when extending for a specific header type