|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectgov.nasa.pds.imaging.generate.Generator
public class Generator
Constructor Summary | |
---|---|
Generator()
|
|
Generator(PDSObject pdsObject,
File templateFile,
File outputFile)
|
Method Summary | |
---|---|
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 |
---|
public Generator() throws Exception
Exception
public Generator(PDSObject pdsObject, File templateFile, File outputFile) throws Exception
Exception
Method Detail |
---|
public void generate(ImageOutputStream ios) throws Exception
ImageOutputStream
- - ImageOutputStream write to
ImageOutputStream and OutputStream are NOT related so we must use one or the other
no casting allowed
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 OutputStreampublic void generate(OutputStream os) throws Exception
OutputStream
- - OutputStream write to
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 OutputStreampublic void generate(boolean toStdOut) throws Exception
toStdOut
- - Determines whether the output should be to a file or System.out
Exception
- - when output file does not exist, or error close String writer
TemplateException
- - when output is null - reason needs to be foundpublic void initTemplate() throws TemplateException
TemplateException
IOException
public void setContext() throws TemplateException, Exception
TemplateException
Exception
public org.apache.velocity.VelocityContext getContext()
public ContextMappings getContextMappings()
public File getOutputFile()
public PDSObject getPdsObject()
public org.apache.velocity.Template getTemplate()
public File getTemplateFile()
public String getTemplatePath()
public void setContext(org.apache.velocity.VelocityContext context)
public void setContextMappings(ContextMappings ctxMappings)
public void setOutputFile(File outputFile)
public void setPDSObject(PDSObject pdsObject)
public void setTemplate(org.apache.velocity.Template template)
public void setTemplateFile(File templateFile) throws TemplateException
TemplateException
public void setTemplatePath(String templatePath)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |