public interface OutputHandler
Modifier and Type | Method and Description |
---|---|
void |
analyze(RepInfo info)
Callback allowing post-parse, pre-show analysis of object
representation information.
|
void |
applyDefaultParams()
Applies the default parameters.
|
void |
close()
Do appropriate finalization after all output is complete.
|
void |
endDirectory()
Callback indicating a directory is finished being processed.
|
Date |
getDate()
Returns the last modification date of this handler
|
String |
getEncoding()
Returns this handler's encoding.
|
String |
getName()
Returns the name of this handler
|
String |
getNote()
Returns this handler's note
|
String |
getRelease()
Returns release information for this handler
|
String |
getRights()
Returns this handler's copyright information
|
List<Document> |
getSpecification()
Returns a List of Document objects giving the format
specification documentation
|
Agent |
getVendor()
Returns a List of Agent objects giving the vendor(s)
of this handler.
|
void |
init(String init)
Per-instantiation initialization.
|
boolean |
okToProcess(String filepath)
Callback to give the handler the opportunity to decide whether or
not to process a file.
|
void |
param(String param)
Per-action initialization.
|
void |
reset()
Reset the handler.
|
void |
resetParams()
Reset parameter settings.
|
void |
setApp(App app)
Assigns an application object to provide services to this handler
|
void |
setBase(JhoveBase je)
Assigns the JHOVE engine object to provide services to this handler
|
void |
setDefaultParams(List<String> params)
Sets list of default parameters.
|
void |
setEncoding(String encoding)
Assigns the encoding to be used by this OutputHandler
|
void |
setWriter(PrintWriter output)
Assigns a PrintWriter to do output for this OutputHandler
|
void |
show()
Outputs minimal information about the application
|
void |
show(App app)
Outputs detailed information about the application,
including configuration, available modules and handlers,
etc.
|
void |
show(Module module)
Outputs information about a Module
|
void |
show(OutputHandler handler)
Outputs information about the OutputHandler specified
in the parameter
|
void |
show(RepInfo info)
Outputs the information contained in a RepInfo object
|
void |
showFooter()
Do the final output.
|
void |
showHeader()
Do the initial output.
|
void |
startDirectory(String directory)
Callback indicating a new directory is being processed.
|
void reset()
void analyze(RepInfo info)
info
- Object representation informationvoid endDirectory()
String getName()
String getRelease()
Date getDate()
List<Document> getSpecification()
Document
Agent getVendor()
String getNote()
String getRights()
String getEncoding()
void init(String init) throws Exception
init
- Initialization parameter. This is typically obtained
from the configuration file.Exception
boolean okToProcess(String filepath)
filepath
- File pathnamevoid setDefaultParams(List<String> params)
params
- A List whose elements are Strings.
May be empty.void applyDefaultParams() throws Exception
Exception
void resetParams() throws Exception
Exception
void param(String param) throws Exception
param
- Initialization parameter.Exception
void setApp(App app)
void setBase(JhoveBase je)
void setEncoding(String encoding)
void setWriter(PrintWriter output)
void show(Module module)
void show(RepInfo info)
void show(OutputHandler handler)
void show()
void show(App app)
void showHeader()
void showFooter()
void close()
void startDirectory(String directory)
directory
- Directory pathCopyright © 2008–2017 The Open Preservation Foundation. All rights reserved.