gov.nasa.pds.imaging.generate

Class Generator

java.lang.Object

gov.nasa.pds.imaging.generate.Generator

public class Generator
extends Object

Constructor Summary

Constructors

Constructor and Description
Generator()
Generator(PDSObject pdsObject, File templateFile, File outputFile)

Method Summary

Methods

Modifier and Type	Method and Description
void	generate(boolean toStdOut) Functionality to generate the PDS4 Label from the Velocity Template
void	generate(ImageOutputStream ios) Functionality to generate the PDS4 Label from the Velocity Template
void	generate(OutputStream os) Functionality to generate the PDS4 Label from the Velocity Template
org.apache.velocity.VelocityContext	getContext()
ContextMappings	getContextMappings()
File	getOutputFile()
PDSObject	getPdsObject()
org.apache.velocity.Template	getTemplate()
File	getTemplateFile()
String	getTemplatePath()
void	initTemplate() Initializes and reads in the Velocity Template into the Velocity Engine.
void	setContext() Sets the Velocity Template contexts specified by the PDSObject API and ContextMappings object.
void	setContext(org.apache.velocity.VelocityContext context)
void	setContextMappings(ContextMappings ctxMappings)
void	setOutputFile(File outputFile)
void	setPDSObject(PDSObject pdsObject)
void	setTemplate(org.apache.velocity.Template template)
void	setTemplateFile(File templateFile)
void	setTemplatePath(String templatePath)

Methods inherited from class java.lang.Object

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

Constructor Detail

Generator

public Generator()
          throws Exception

Throws:

Exception

Generator

public Generator(PDSObject pdsObject,
         File templateFile,
         File outputFile)
          throws Exception

Throws:

Exception

Method Detail

generate

public void generate(ImageOutputStream ios)
              throws Exception

Functionality to generate the PDS4 Label from the Velocity Template

Parameters:

ImageOutputStream - - ImageOutputStream write to ImageOutputStream and OutputStream are NOT related so we must use one or the other no casting allowed

Throws:

Exception - - when output file does not exist, or error close String writer

TemplateException - - when output is null - reason needs to be found * may be able to merge the 2 generate()s together since we actually write to a PrintWriter which can wrap a File or OutputStream

generate

public void generate(OutputStream os)
              throws Exception

Functionality to generate the PDS4 Label from the Velocity Template

Parameters:

OutputStream - - OutputStream write to

Throws:

Exception - - when output file does not exist, or error close String writer

TemplateException - - when output is null - reason needs to be found * may be able to merge the 2 generate()s together since we actually write to a PrintWriter which can wrap a File or OutputStream

generate

public void generate(boolean toStdOut)
              throws Exception

Functionality to generate the PDS4 Label from the Velocity Template

Parameters:

toStdOut - - Determines whether the output should be to a file or System.out

Throws:

Exception - - when output file does not exist, or error close String writer

TemplateException - - when output is null - reason needs to be found

initTemplate

public void initTemplate()
                  throws TemplateException

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

Throws:

TemplateException

IOException

setContext

public void setContext()
                throws TemplateException,
                       Exception

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

Throws:

TemplateException

Exception

getContext

public org.apache.velocity.VelocityContext getContext()

getContextMappings

public ContextMappings getContextMappings()

getOutputFile

public File getOutputFile()

getPdsObject

public PDSObject getPdsObject()

getTemplate

public org.apache.velocity.Template getTemplate()

getTemplateFile

public File getTemplateFile()

getTemplatePath

public String getTemplatePath()

setContext

public void setContext(org.apache.velocity.VelocityContext context)

setContextMappings

public void setContextMappings(ContextMappings ctxMappings)

setOutputFile

public void setOutputFile(File outputFile)

setPDSObject

public void setPDSObject(PDSObject pdsObject)

setTemplate

public void setTemplate(org.apache.velocity.Template template)

setTemplateFile

public void setTemplateFile(File templateFile)
                     throws TemplateException

Throws:

TemplateException

setTemplatePath

public void setTemplatePath(String templatePath)