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

java.lang.Object
  extended by gov.nasa.pds.imaging.generate.label.PDS3Label
All Implemented Interfaces:
PDSContext, PDSObject

public class PDS3Label
extends Object
implements PDSObject

Represents PDS3 Label object to provide the necessary functionality to

Author:
jpadams, srlevoe

Field Summary
static String CONTEXT
           
 ContextUtil ctxtUtil
           
 
Constructor Summary
PDS3Label()
          Empty Constructor, set everything later on
PDS3Label(Document document)
          Constructor Construct the PDS3label using a DOM object from somewhere else
PDS3Label(String filePath)
          Constructor
 
Method Summary
 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()
           
 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 getUnits(String key)
           
 void setMappings()
           
 void setParameters(PDSObject pdsObject)
           
 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 PDSContext
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

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 PDSContext

setParameters

public final void setParameters(PDSObject pdsObject)
Specified by:
setParameters in interface PDSContext

setMappings

public void setMappings()
Specified by:
setMappings in interface PDSContext

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


Copyright © 2010–2015 Planetary Data System. All rights reserved.