|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Public interface for Jhove output handlers. All output handlers must implement OutputHandler, and in normal cases should subclass HandlerBase.
Method Summary | |
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. |
java.util.Date |
getDate()
Returns the last modification date of this handler |
java.lang.String |
getEncoding()
Returns this handler's encoding. |
java.lang.String |
getName()
Returns the name of this handler |
java.lang.String |
getNote()
Returns this handler's note |
java.lang.String |
getRelease()
Returns release information for this handler |
java.lang.String |
getRights()
Returns this handler's copyright information |
java.util.List |
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(java.lang.String init)
Per-instantiation initialization. |
boolean |
okToProcess(java.lang.String filepath)
Callback to give the handler the opportunity to decide whether or not to process a file. |
void |
param(java.lang.String param)
Per-action initialization. |
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(java.util.List params)
Sets list of default parameters. |
void |
setEncoding(java.lang.String encoding)
Assigns the encoding to be used by this OutputHandler |
void |
setWriter(java.io.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(java.lang.String directory)
Callback indicating a new directory is being processed. |
Method Detail |
public void analyze(RepInfo info)
info
- Object representation informationpublic void endDirectory()
public java.lang.String getName()
public java.lang.String getRelease()
public java.util.Date getDate()
public java.util.List getSpecification()
Document
public Agent getVendor()
public java.lang.String getNote()
public java.lang.String getRights()
public java.lang.String getEncoding()
public void init(java.lang.String init) throws java.lang.Exception
init
- Initialization parameter. This is typically obtained
from the configuration file.
java.lang.Exception
public boolean okToProcess(java.lang.String filepath)
filepath
- File pathnamepublic void setDefaultParams(java.util.List params)
params
- A List whose elements are Strings.
May be empty.public void applyDefaultParams() throws java.lang.Exception
java.lang.Exception
public void resetParams() throws java.lang.Exception
java.lang.Exception
public void param(java.lang.String param) throws java.lang.Exception
param
- Initialization parameter.
java.lang.Exception
public void setApp(App app)
public void setBase(JhoveBase je)
public void setEncoding(java.lang.String encoding)
public void setWriter(java.io.PrintWriter output)
public void show(Module module)
public void show(RepInfo info)
public void show(OutputHandler handler)
public void show()
public void show(App app)
public void showHeader()
public void showFooter()
public void close()
public void startDirectory(java.lang.String directory)
directory
- Directory path
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |