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 StringCONTEXTContextUtilctxtUtil
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Objectget(String key)Retrieves the value for the specified keyStringgetContext()Returns the variable to be used in the Velocity Template Engine to map to this object.StringgetFilePath()ImageInputStreamgetImageInputStream()LonggetImageStartByte()ListgetList(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 labelStringgetReaderFormat()StringgetUnits(String key)voidsetFilePath(String filePath)voidsetImageInputStream(ImageInputStream iis)voidsetImageStartByte(Long x)voidsetIncludePaths(List<String> i)Set the paths to search for files referenced by pointers.voidsetMappings()voidsetParameters(PDSObject pdsObject)voidsetParserType(ParserType type)voidsetReaderFormat(String format)StringtoString()
-
-
-
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:
getin interfacePDSObjectContext- 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:
getContextin interfacePDSContext
-
getFilePath
public final String getFilePath()
- Specified by:
getFilePathin interfacePDSObject
-
setFilePath
public void setFilePath(String filePath)
- Specified by:
setFilePathin interfacePDSObject
-
getList
public final List getList(String key) throws TemplateException
- Specified by:
getListin interfacePDSObject- Throws:
TemplateException
-
getUnits
public final String getUnits(String key)
- Specified by:
getUnitsin interfacePDSObjectContext
-
setParameters
public final void setParameters(PDSObject pdsObject)
- Specified by:
setParametersin interfacePDSObjectContext
-
setImageInputStream
public void setImageInputStream(ImageInputStream iis)
-
getImageInputStream
public ImageInputStream getImageInputStream()
- Specified by:
getImageInputStreamin interfacePDSObject
-
setReaderFormat
public void setReaderFormat(String format)
- Specified by:
setReaderFormatin interfacePDSObject
-
getReaderFormat
public String getReaderFormat()
- Specified by:
getReaderFormatin interfacePDSObject
-
setImageStartByte
public void setImageStartByte(Long x)
-
getImageStartByte
public Long getImageStartByte()
- Specified by:
getImageStartBytein interfacePDSObject
-
setMappings
public void setMappings()
- Specified by:
setMappingsin interfacePDSObjectContext
-
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:
-
setParserType
public void setParserType(ParserType type)
-
-