A C D E F G H I L M N O P Q R S T U V X

A

addDictionaryElement(String, List<String>) - Method in class gov.nasa.pds.imaging.generate.context.ContextUtil

addMapping(String, Class<?>) - Method in class gov.nasa.pds.imaging.generate.automatic.AutoGeneratedElements

addMapping(String, PDSContext) - Method in class gov.nasa.pds.imaging.generate.context.ContextMappings

addValue(String) - Method in class gov.nasa.pds.imaging.generate.label.ItemNode

allowsMultipleArgs() - Method in enum gov.nasa.pds.imaging.generate.cli.options.Flag

Find out if the flag can handle multiple arguments.

AutoGeneratedElements - Class in gov.nasa.pds.imaging.generate.automatic

AutoGeneratedElements() - Constructor for class gov.nasa.pds.imaging.generate.automatic.AutoGeneratedElements

C

capitalize(String) - Static method in class gov.nasa.pds.imaging.generate.util.TextUtil

Utility method used to transform the str into the applicable PDS title-case format for enumerated values.

Constants - Class in gov.nasa.pds.imaging.generate.constants

Constants() - Constructor for class gov.nasa.pds.imaging.generate.constants.Constants

CONTEXT - Static variable in class gov.nasa.pds.imaging.generate.automatic.AutoGeneratedElements

Specifies the CONTEXT to be mapped to the Velocity Templates.

CONTEXT - Static variable in class gov.nasa.pds.imaging.generate.label.PDS3Label

CONTEXT - Static variable in class gov.nasa.pds.imaging.generate.util.TextUtil

contextMap - Variable in class gov.nasa.pds.imaging.generate.context.ContextMappings

ContextMappings - Class in gov.nasa.pds.imaging.generate.context

ContextMappings() - Constructor for class gov.nasa.pds.imaging.generate.context.ContextMappings

ContextMappings(PDSObject) - Constructor for class gov.nasa.pds.imaging.generate.context.ContextMappings

Populates the contextMap with those classes specified in the context mappings XML file.

ContextUtil - Class in gov.nasa.pds.imaging.generate.context

ContextUtil() - Constructor for class gov.nasa.pds.imaging.generate.context.ContextUtil

COPYRIGHT - Static variable in class gov.nasa.pds.imaging.generate.util.ToolInfo

createChecksum() - Method in class gov.nasa.pds.imaging.generate.automatic.elements.Md5Checksum

createChecksum

ctxtUtil - Variable in class gov.nasa.pds.imaging.generate.label.PDS3Label

CurrentDateUTC - Class in gov.nasa.pds.imaging.generate.automatic.elements

Deprecated.

CurrentDateUTC() - Constructor for class gov.nasa.pds.imaging.generate.automatic.elements.CurrentDateUTC

Deprecated.

D

debug(String) - Static method in class gov.nasa.pds.imaging.generate.util.Debugger

Simple output method

debugFlag - Static variable in class gov.nasa.pds.imaging.generate.util.Debugger

Debugger - Class in gov.nasa.pds.imaging.generate.util

Debug class that shows a ton of debug messages.

Debugger() - Constructor for class gov.nasa.pds.imaging.generate.util.Debugger

displayHelp() - Method in class gov.nasa.pds.imaging.generate.GenerateLauncher

Displays tool usage.

displayVersion() - Method in class gov.nasa.pds.imaging.generate.GenerateLauncher

Displays the current version and disclaimer notice.

E

Element - Interface in gov.nasa.pds.imaging.generate.automatic.elements

F

file - Variable in class gov.nasa.pds.imaging.generate.automatic.elements.Md5Checksum

FILE - Static variable in class gov.nasa.pds.imaging.generate.util.ToolInfo

FileName - Class in gov.nasa.pds.imaging.generate.automatic.elements

FileName() - Constructor for class gov.nasa.pds.imaging.generate.automatic.elements.FileName

FileSize - Class in gov.nasa.pds.imaging.generate.automatic.elements

FileSize() - Constructor for class gov.nasa.pds.imaging.generate.automatic.elements.FileSize

Flag - Enum in gov.nasa.pds.imaging.generate.cli.options

FlatLabel - Class in gov.nasa.pds.imaging.generate.label

FlatLabel(String, String) - Constructor for class gov.nasa.pds.imaging.generate.label.FlatLabel

G

generate() - Method in class gov.nasa.pds.imaging.generate.GenerateLauncher

generate(ImageOutputStream) - Method in class gov.nasa.pds.imaging.generate.Generator

Functionality to generate the PDS4 Label from the Velocity Template

generate(OutputStream) - Method in class gov.nasa.pds.imaging.generate.Generator

Functionality to generate the PDS4 Label from the Velocity Template

generate(boolean) - Method in class gov.nasa.pds.imaging.generate.Generator

Functionality to generate the PDS4 Label from the Velocity Template

GenerateLauncher - Class in gov.nasa.pds.imaging.generate

Class used as Command-line interface endpoint.

GenerateLauncher() - Constructor for class gov.nasa.pds.imaging.generate.GenerateLauncher

Generator - Class in gov.nasa.pds.imaging.generate

Generator() - Constructor for class gov.nasa.pds.imaging.generate.Generator

Generator(PDSObject, File, File) - Constructor for class gov.nasa.pds.imaging.generate.Generator

Generator(PDSObject, File, File, Boolean) - Constructor for class gov.nasa.pds.imaging.generate.Generator

Generator constructor class.

genValsMap - Variable in class gov.nasa.pds.imaging.generate.automatic.AutoGeneratedElements

Map that will hole the String -> Class mappings specified in the XML

get(String) - Method in class gov.nasa.pds.imaging.generate.automatic.AutoGeneratedElements

get(String) - Method in interface gov.nasa.pds.imaging.generate.context.PDSObjectContext

get(String) - Method in class gov.nasa.pds.imaging.generate.label.FlatLabel

get(int) - Method in class gov.nasa.pds.imaging.generate.label.ItemNode

get(String) - Method in interface gov.nasa.pds.imaging.generate.label.LabelObject

Retrieves the value of this object's element as identified by key.

get(String) - Method in class gov.nasa.pds.imaging.generate.label.PDS3Label

Retrieves the value for the specified key

getAbsolutePath(String) - Static method in class gov.nasa.pds.imaging.generate.util.Utility

getArgName() - Method in enum gov.nasa.pds.imaging.generate.cli.options.Flag

Get the argument name of the flag.

getArgType() - Method in enum gov.nasa.pds.imaging.generate.cli.options.Flag

Get the argument type of the flag.

getClassList(InputStream, String) - Static method in class gov.nasa.pds.imaging.generate.util.XMLUtil

Static method that returns a list of Classes that will be extracted from the XML file for context mappings.

getContext() - Method in class gov.nasa.pds.imaging.generate.automatic.AutoGeneratedElements

getContext() - Method in interface gov.nasa.pds.imaging.generate.context.PDSContext

getContext() - Method in class gov.nasa.pds.imaging.generate.Generator

getContext() - Method in class gov.nasa.pds.imaging.generate.label.PDS3Label

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

getContext() - Method in class gov.nasa.pds.imaging.generate.util.TextUtil

getContextMappings() - Method in class gov.nasa.pds.imaging.generate.Generator

getCopyright() - Static method in class gov.nasa.pds.imaging.generate.util.ToolInfo

Get copyright information.

getDescription() - Method in enum gov.nasa.pds.imaging.generate.cli.options.Flag

Get the flag description.

getDictionary() - Method in class gov.nasa.pds.imaging.generate.context.ContextUtil

getFilePath() - Method in class gov.nasa.pds.imaging.generate.label.PDS3Label

getFilePath() - Method in interface gov.nasa.pds.imaging.generate.label.PDSObject

getGeneratedMappings(InputStream, String, String) - Static method in class gov.nasa.pds.imaging.generate.util.XMLUtil

A static method that returns the mapping of String to Class for Generated Values found in the Velocity Template.

getImageInputStream() - Method in class gov.nasa.pds.imaging.generate.label.PDS3Label

getImageInputStream() - Method in interface gov.nasa.pds.imaging.generate.label.PDSObject

getImageStartByte() - Method in class gov.nasa.pds.imaging.generate.label.PDS3Label

getImageStartByte() - Method in interface gov.nasa.pds.imaging.generate.label.PDSObject

getIsXML() - Method in class gov.nasa.pds.imaging.generate.Generator

getList(String) - Method in class gov.nasa.pds.imaging.generate.label.PDS3Label

getList(String) - Method in interface gov.nasa.pds.imaging.generate.label.PDSObject

getLongName() - Method in enum gov.nasa.pds.imaging.generate.cli.options.Flag

Get the long name of the flag.

getName() - Method in class gov.nasa.pds.imaging.generate.label.ItemNode

getName() - Static method in class gov.nasa.pds.imaging.generate.util.ToolInfo

Get the name of the tool.

getNode() - Method in interface gov.nasa.pds.imaging.generate.node.NodeContext

getOptions() - Static method in enum gov.nasa.pds.imaging.generate.cli.options.Flag

Get the command-line options.

getOutputFile() - Method in class gov.nasa.pds.imaging.generate.Generator

getPdsObject() - Method in class gov.nasa.pds.imaging.generate.Generator

getPDSObjectNames() - Method in class gov.nasa.pds.imaging.generate.label.PDS3Label

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

getPDSObjectNames() - Method in class gov.nasa.pds.imaging.generate.readers.PDS3LabelReader

getReleaseDate() - Static method in class gov.nasa.pds.imaging.generate.util.ToolInfo

Get the release date.

getShortName() - Method in enum gov.nasa.pds.imaging.generate.cli.options.Flag

Get the short name of the flag.

getTaskNames() - Method in class gov.nasa.pds.imaging.generate.readers.PDS3LabelReader

getTemplate() - Method in class gov.nasa.pds.imaging.generate.Generator

getTemplateFile() - Method in class gov.nasa.pds.imaging.generate.Generator

getTemplatePath() - Method in class gov.nasa.pds.imaging.generate.Generator

getUnits(String) - Method in class gov.nasa.pds.imaging.generate.automatic.AutoGeneratedElements

getUnits() - Method in class gov.nasa.pds.imaging.generate.automatic.elements.CurrentDateUTC

Deprecated.

getUnits() - Method in interface gov.nasa.pds.imaging.generate.automatic.elements.Element

getUnits() - Method in class gov.nasa.pds.imaging.generate.automatic.elements.FileName

getUnits() - Method in class gov.nasa.pds.imaging.generate.automatic.elements.FileSize

getUnits() - Method in class gov.nasa.pds.imaging.generate.automatic.elements.LabelLength

getUnits() - Method in class gov.nasa.pds.imaging.generate.automatic.elements.Md5Checksum

getUnits() - Method in class gov.nasa.pds.imaging.generate.automatic.elements.ObjectMd5Checksum

getUnits(String) - Method in interface gov.nasa.pds.imaging.generate.context.PDSObjectContext

getUnits() - Method in class gov.nasa.pds.imaging.generate.label.ItemNode

getUnits(String) - Method in class gov.nasa.pds.imaging.generate.label.PDS3Label

getValue() - Method in class gov.nasa.pds.imaging.generate.automatic.elements.CurrentDateUTC

Deprecated.

getValue() - Method in interface gov.nasa.pds.imaging.generate.automatic.elements.Element

getValue() - Method in class gov.nasa.pds.imaging.generate.automatic.elements.FileName

getValue() - Method in class gov.nasa.pds.imaging.generate.automatic.elements.FileSize

getValue() - Method in class gov.nasa.pds.imaging.generate.automatic.elements.LabelLength

getValue() - Method in class gov.nasa.pds.imaging.generate.automatic.elements.Md5Checksum

getValue() - Method in class gov.nasa.pds.imaging.generate.automatic.elements.ObjectMd5Checksum

getValue() - Method in class gov.nasa.pds.imaging.generate.label.ItemNode

getValues() - Method in class gov.nasa.pds.imaging.generate.label.ItemNode

getVersion() - Static method in class gov.nasa.pds.imaging.generate.util.ToolInfo

Get the version.

gov.nasa.pds.imaging.generate - package gov.nasa.pds.imaging.generate

gov.nasa.pds.imaging.generate.automatic - package gov.nasa.pds.imaging.generate.automatic

gov.nasa.pds.imaging.generate.automatic.elements - package gov.nasa.pds.imaging.generate.automatic.elements

gov.nasa.pds.imaging.generate.cli.options - package gov.nasa.pds.imaging.generate.cli.options

gov.nasa.pds.imaging.generate.collections - package gov.nasa.pds.imaging.generate.collections

gov.nasa.pds.imaging.generate.constants - package gov.nasa.pds.imaging.generate.constants

gov.nasa.pds.imaging.generate.context - package gov.nasa.pds.imaging.generate.context

gov.nasa.pds.imaging.generate.label - package gov.nasa.pds.imaging.generate.label

gov.nasa.pds.imaging.generate.node - package gov.nasa.pds.imaging.generate.node

gov.nasa.pds.imaging.generate.readers - package gov.nasa.pds.imaging.generate.readers

gov.nasa.pds.imaging.generate.util - package gov.nasa.pds.imaging.generate.util

GROUP_TYPE - Static variable in class gov.nasa.pds.imaging.generate.label.FlatLabel

H

hasArg(String, Object) - Method in class gov.nasa.pds.imaging.generate.cli.options.ToolsOption

Requires a single argument to follow the option.

hasArg(String, Object, boolean) - Method in class gov.nasa.pds.imaging.generate.cli.options.ToolsOption

Allows a single argument to be passed into the option.

hasArgs(int, String, Object, char, boolean) - Method in class gov.nasa.pds.imaging.generate.cli.options.ToolsOption

Defines an argument's "properties" for an option.

hasArgs(String, Object) - Method in class gov.nasa.pds.imaging.generate.cli.options.ToolsOption

Requires an argument to follow the option.

hasArgs(String, Object, char) - Method in class gov.nasa.pds.imaging.generate.cli.options.ToolsOption

Requires an argument to follow the option.

hasArgs(String, Object, char, boolean) - Method in class gov.nasa.pds.imaging.generate.cli.options.ToolsOption

Allows multiple arguments to be passed in to the option.

I

initTemplate() - Method in class gov.nasa.pds.imaging.generate.Generator

Initializes and reads in the Velocity Template into the Velocity Engine.

InvalidOptionException - Exception in gov.nasa.pds.imaging.generate.cli.options

Exception class that is called upon errors found during command-line option processing.

InvalidOptionException(String) - Constructor for exception gov.nasa.pds.imaging.generate.cli.options.InvalidOptionException

Constructor.

ItemNode - Class in gov.nasa.pds.imaging.generate.label

ItemNode(String, String) - Constructor for class gov.nasa.pds.imaging.generate.label.ItemNode

L

LabelLength - Class in gov.nasa.pds.imaging.generate.automatic.elements

LabelLength() - Constructor for class gov.nasa.pds.imaging.generate.automatic.elements.LabelLength

LabelObject - Interface in gov.nasa.pds.imaging.generate.label

M

main(String[]) - Static method in class gov.nasa.pds.imaging.generate.GenerateLauncher

Md5Checksum - Class in gov.nasa.pds.imaging.generate.automatic.elements

Md5Checksum() - Constructor for class gov.nasa.pds.imaging.generate.automatic.elements.Md5Checksum

Md5Checksum(PDSObject, long) - Constructor for class gov.nasa.pds.imaging.generate.automatic.elements.Md5Checksum

N

NAME - Static variable in class gov.nasa.pds.imaging.generate.util.ToolInfo

NodeContext - Interface in gov.nasa.pds.imaging.generate.node

Extension point for node-specific contexts

O

OBJECT_TYPE - Static variable in class gov.nasa.pds.imaging.generate.label.FlatLabel

ObjectMd5Checksum - Class in gov.nasa.pds.imaging.generate.automatic.elements

Generated value class that will generate an MD5 checksum for an object within a file.

ObjectMd5Checksum() - Constructor for class gov.nasa.pds.imaging.generate.automatic.elements.ObjectMd5Checksum

offset - Variable in class gov.nasa.pds.imaging.generate.automatic.elements.ObjectMd5Checksum

P

parse(String[]) - Method in class gov.nasa.pds.imaging.generate.GenerateLauncher

A method to parse the command-line arguments.

parseLabel(String) - Method in class gov.nasa.pds.imaging.generate.readers.PDS3LabelReader

Parse the label and create a XML DOM representation.

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

Represents PDS3 Label object to provide the necessary functionality to

PDS3Label() - Constructor for class gov.nasa.pds.imaging.generate.label.PDS3Label

Empty Constructor, set everything later on

PDS3Label(Document) - Constructor for class gov.nasa.pds.imaging.generate.label.PDS3Label

Constructor Construct the PDS3label using a DOM object from somewhere else

PDS3Label(String) - Constructor for class gov.nasa.pds.imaging.generate.label.PDS3Label

Constructor

PDS3LabelReader - Class in gov.nasa.pds.imaging.generate.readers

PDS3LabelReader() - Constructor for class gov.nasa.pds.imaging.generate.readers.PDS3LabelReader

PDS_NAMESPACE - Static variable in class gov.nasa.pds.imaging.generate.constants.Constants

PDS_NS_PREFIX - Static variable in class gov.nasa.pds.imaging.generate.constants.Constants

PDSContext - Interface in gov.nasa.pds.imaging.generate.context

Interface for the PDS Context to be used for extracting values for the Velocity Templates.

PDSObject - Interface in gov.nasa.pds.imaging.generate.label

Specific PDSContext applying to those contexts that contain PDS Data in DOM object form.

PDSObjectContext - Interface in gov.nasa.pds.imaging.generate.context

Interface for the PDS Context to be used for extracting values for the Velocity Templates.

PDSTreeMap - Class in gov.nasa.pds.imaging.generate.collections

PDSTreeMap() - Constructor for class gov.nasa.pds.imaging.generate.collections.PDSTreeMap

PROPERTY_TYPE - Static variable in class gov.nasa.pds.imaging.generate.label.FlatLabel

put(Object, Object) - Method in class gov.nasa.pds.imaging.generate.collections.PDSTreeMap

Q

query(CommandLine) - Method in class gov.nasa.pds.imaging.generate.GenerateLauncher

Examines the command-line arguments passed into the Harvest Tool and takes the appropriate action based on what flags were set.

R

RELEASE_DATE - Static variable in class gov.nasa.pds.imaging.generate.util.ToolInfo

S

setContext() - Method in class gov.nasa.pds.imaging.generate.Generator

Sets the Velocity Template contexts specified by the PDSObject API and ContextMappings object.

setContext(VelocityContext) - Method in class gov.nasa.pds.imaging.generate.Generator

setContextMappings(ContextMappings) - Method in class gov.nasa.pds.imaging.generate.Generator

setElements(Map) - Method in class gov.nasa.pds.imaging.generate.label.FlatLabel

setElements(Map) - Method in interface gov.nasa.pds.imaging.generate.label.LabelObject

Set the elements of this object

setImageInputStream(ImageInputStream) - Method in class gov.nasa.pds.imaging.generate.label.PDS3Label

setImageStartByte(Long) - Method in class gov.nasa.pds.imaging.generate.label.PDS3Label

setIsXML(boolean) - Method in class gov.nasa.pds.imaging.generate.Generator

setMappings() - Method in class gov.nasa.pds.imaging.generate.automatic.AutoGeneratedElements

setMappings() - Method in interface gov.nasa.pds.imaging.generate.context.PDSObjectContext

setMappings() - Method in class gov.nasa.pds.imaging.generate.label.PDS3Label

setName(String) - Method in class gov.nasa.pds.imaging.generate.label.ItemNode

setOutputFile(File) - Method in class gov.nasa.pds.imaging.generate.Generator

setParameters(PDSObject) - Method in class gov.nasa.pds.imaging.generate.automatic.AutoGeneratedElements

setParameters(PDSObject) - Method in class gov.nasa.pds.imaging.generate.automatic.elements.CurrentDateUTC

Deprecated.

setParameters(PDSObject) - Method in interface gov.nasa.pds.imaging.generate.automatic.elements.Element

setParameters(PDSObject) - Method in class gov.nasa.pds.imaging.generate.automatic.elements.FileName

setParameters(PDSObject) - Method in class gov.nasa.pds.imaging.generate.automatic.elements.FileSize

setParameters(PDSObject) - Method in class gov.nasa.pds.imaging.generate.automatic.elements.LabelLength

setParameters(PDSObject) - Method in class gov.nasa.pds.imaging.generate.automatic.elements.Md5Checksum

setParameters(PDSObject) - Method in class gov.nasa.pds.imaging.generate.automatic.elements.ObjectMd5Checksum

setParameters(PDSObject) - Method in interface gov.nasa.pds.imaging.generate.context.PDSObjectContext

setParameters(PDSObject) - Method in class gov.nasa.pds.imaging.generate.label.PDS3Label

setPDSObject(PDSObject) - Method in class gov.nasa.pds.imaging.generate.Generator

setTemplate(Template) - Method in class gov.nasa.pds.imaging.generate.Generator

setTemplateFile(File) - Method in class gov.nasa.pds.imaging.generate.Generator

setTemplatePath(String) - Method in class gov.nasa.pds.imaging.generate.Generator

setUnits(String) - Method in class gov.nasa.pds.imaging.generate.label.ItemNode

setValues(List<String>) - Method in class gov.nasa.pds.imaging.generate.label.ItemNode

SYSTEM_TYPE - Static variable in class gov.nasa.pds.imaging.generate.label.FlatLabel

T

TASK_TYPE - Static variable in class gov.nasa.pds.imaging.generate.label.FlatLabel

TemplateException - Exception in gov.nasa.pds.imaging.generate

TemplateException(String) - Constructor for exception gov.nasa.pds.imaging.generate.TemplateException

TextUtil - Class in gov.nasa.pds.imaging.generate.util

TextUtil() - Constructor for class gov.nasa.pds.imaging.generate.util.TextUtil

ToolInfo - Class in gov.nasa.pds.imaging.generate.util

Class to get tool release information.

ToolInfo() - Constructor for class gov.nasa.pds.imaging.generate.util.ToolInfo

ToolsOption - Class in gov.nasa.pds.imaging.generate.cli.options

Class that extends Apache's Option class.

ToolsOption(Flag) - Constructor for class gov.nasa.pds.imaging.generate.cli.options.ToolsOption

Constructor.

ToolsOption(String, String, String) - Constructor for class gov.nasa.pds.imaging.generate.cli.options.ToolsOption

Constructor.

toString() - Method in class gov.nasa.pds.imaging.generate.label.FlatLabel

toString() - Method in class gov.nasa.pds.imaging.generate.label.ItemNode

toString() - Method in class gov.nasa.pds.imaging.generate.label.PDS3Label

traverseDOM(Node) - Method in class gov.nasa.pds.imaging.generate.readers.PDS3LabelReader

Traverses the DOM returned by the PDSLabelToDom object.

U

units - Variable in class gov.nasa.pds.imaging.generate.label.ItemNode

Utility - Class in gov.nasa.pds.imaging.generate.util

Utility() - Constructor for class gov.nasa.pds.imaging.generate.util.Utility

V

valueOf(String) - Static method in enum gov.nasa.pds.imaging.generate.cli.options.Flag

Returns the enum constant of this type with the specified name.

values() - Static method in enum gov.nasa.pds.imaging.generate.cli.options.Flag

Returns an array containing the constants of this enum type, in the order they are declared.

VERSION - Static variable in class gov.nasa.pds.imaging.generate.util.ToolInfo

X

XML_FILENAME - Static variable in class gov.nasa.pds.imaging.generate.automatic.AutoGeneratedElements

The XML File Path for the file with the generated value mappings

XML_FILENAME - Static variable in class gov.nasa.pds.imaging.generate.context.ContextMappings

XML_KEY - Static variable in class gov.nasa.pds.imaging.generate.automatic.AutoGeneratedElements

XML element name holding the key value

XML_TAG - Static variable in class gov.nasa.pds.imaging.generate.context.ContextMappings

XML element name holding the key value

XML_VALUE - Static variable in class gov.nasa.pds.imaging.generate.automatic.AutoGeneratedElements

XML element name holding the mapped value

XMLUtil - Class in gov.nasa.pds.imaging.generate.util

Utility class for reading XML files

XMLUtil() - Constructor for class gov.nasa.pds.imaging.generate.util.XMLUtil

A C D E F G H I L M N O P Q R S T U V X