Package gov.nasa.pds.imaging.generate.label

Class PDS3Label

java.lang.Object

gov.nasa.pds.imaging.generate.label.PDS3Label

All Implemented Interfaces:

PDSContext, PDSObjectContext, PDSObject

public class PDS3Label
extends Object
implements PDSObject

Represents PDS3 Label object to provide the necessary functionality to

Author:

jpadams, srlevoe

Field Summary

Fields

Modifier and Type	Field	Description
static String	CONTEXT
ContextUtil	ctxtUtil

Constructor Summary

Constructors

Constructor	Description
PDS3Label()	Empty Constructor, set everything later on
PDS3Label(String filePath)	Constructor
PDS3Label(Document document)	Constructor Construct the PDS3label using a DOM object from somewhere else

Method Summary

Modifier and Type	Method	Description
Object	get(String key)	Retrieves the value for the specified key
String	getContext()	Returns the variable to be used in the Velocity Template Engine to map to this object.
String	getFilePath()
ImageInputStream	getImageInputStream()
Long	getImageStartByte()
List	getList(String key)
List<String>	getPDSObjectNames()	Added per request from mcayanan in order to be able to loop through the PDS Objects that can be found in the label
String	getReaderFormat()
String	getUnits(String key)
void	setFilePath(String filePath)
void	setImageInputStream(ImageInputStream iis)
void	setImageStartByte(Long x)
void	setIncludePaths(List<String> i)	Set the paths to search for files referenced by pointers.
void	setMappings()
void	setParameters(PDSObject pdsObject)
void	setParserType(ParserType type)
void	setReaderFormat(String format)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

CONTEXT

public static final String CONTEXT

See Also:

Constant Field Values

ctxtUtil

public ContextUtil ctxtUtil

Constructor Detail

PDS3Label

public PDS3Label()

Empty Constructor, set everything later on

PDS3Label

public PDS3Label(Document document)

Constructor Construct the PDS3label using a DOM object from somewhere else

Parameters:

document -

PDS3Label

public PDS3Label(String filePath)

Constructor

Parameters:

filePath -

Method Detail

get

public final Object get(String key)

Retrieves the value for the specified key

Specified by:

get in interface PDSObjectContext

Parameters:

key -

Returns:

value for key

getContext

public final String getContext()

Returns the variable to be used in the Velocity Template Engine to map to this object.

Specified by:

getContext in interface PDSContext

getFilePath

public final String getFilePath()

Specified by:

getFilePath in interface PDSObject

setFilePath

public void setFilePath(String filePath)

Specified by:

setFilePath in interface PDSObject

getList

public final List getList(String key)
                   throws TemplateException

Specified by:

getList in interface PDSObject

Throws:

TemplateException

getUnits

public final String getUnits(String key)

Specified by:

getUnits in interface PDSObjectContext

setParameters

public final void setParameters(PDSObject pdsObject)

Specified by:

setParameters in interface PDSObjectContext

setImageInputStream

public void setImageInputStream(ImageInputStream iis)

getImageInputStream

public ImageInputStream getImageInputStream()

Specified by:

getImageInputStream in interface PDSObject

setReaderFormat

public void setReaderFormat(String format)

Specified by:

setReaderFormat in interface PDSObject

getReaderFormat

public String getReaderFormat()

Specified by:

getReaderFormat in interface PDSObject

setImageStartByte

public void setImageStartByte(Long x)

getImageStartByte

public Long getImageStartByte()

Specified by:

getImageStartByte in interface PDSObject

setMappings

public void setMappings()
                 throws TemplateException,
                        gov.nasa.pds.tools.LabelParserException

Specified by:

setMappings in interface PDSObjectContext

Throws:

TemplateException

gov.nasa.pds.tools.LabelParserException

getPDSObjectNames

public final List<String> getPDSObjectNames()

Added per request from mcayanan in order to be able to loop through the PDS Objects that can be found in the label

Returns:

toString

public final String toString()

Overrides:

toString in class Object

setParserType

public void setParserType(ParserType type)

setIncludePaths

public void setIncludePaths(List<String> i)

Set the paths to search for files referenced by pointers.

Default is to always look first in the same directory as the label, then search specified directories.

Parameters:

i - List of paths