edu.harvard.hul.ois.jhove
Interface OutputHandler

All Known Implementing Classes:
HandlerBase

public interface OutputHandler

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

analyze

public void analyze(RepInfo info)
Callback allowing post-parse, pre-show analysis of object representation information.

Parameters:
info - Object representation information

endDirectory

public void endDirectory()
Callback indicating a directory is finished being processed. Most handlers will do nothing.


getName

public java.lang.String getName()
Returns the name of this handler


getRelease

public java.lang.String getRelease()
Returns release information for this handler


getDate

public java.util.Date getDate()
Returns the last modification date of this handler


getSpecification

public java.util.List getSpecification()
Returns a List of Document objects giving the format specification documentation

See Also:
Document

getVendor

public Agent getVendor()
Returns a List of Agent objects giving the vendor(s) of this handler.


getNote

public java.lang.String getNote()
Returns this handler's note


getRights

public java.lang.String getRights()
Returns this handler's copyright information


getEncoding

public java.lang.String getEncoding()
Returns this handler's encoding.


init

public void init(java.lang.String init)
          throws java.lang.Exception
Per-instantiation initialization.

Parameters:
init - Initialization parameter. This is typically obtained from the configuration file.
java.lang.Exception

okToProcess

public boolean okToProcess(java.lang.String filepath)
Callback to give the handler the opportunity to decide whether or not to process a file. Most handlers will always return true.

Parameters:
filepath - File pathname

setDefaultParams

public void setDefaultParams(java.util.List params)
Sets list of default parameters.

Parameters:
params - A List whose elements are Strings. May be empty.

applyDefaultParams

public void applyDefaultParams()
                        throws java.lang.Exception
Applies the default parameters.

java.lang.Exception

resetParams

public void resetParams()
                 throws java.lang.Exception
Reset parameter settings. Returns to a default state without any parameters.

java.lang.Exception

param

public void param(java.lang.String param)
           throws java.lang.Exception
Per-action initialization.

Parameters:
param - Initialization parameter.
java.lang.Exception

setApp

public void setApp(App app)
Assigns an application object to provide services to this handler


setBase

public void setBase(JhoveBase je)
Assigns the JHOVE engine object to provide services to this handler


setEncoding

public void setEncoding(java.lang.String encoding)
Assigns the encoding to be used by this OutputHandler


setWriter

public void setWriter(java.io.PrintWriter output)
Assigns a PrintWriter to do output for this OutputHandler


show

public void show(Module module)
Outputs information about a Module


show

public void show(RepInfo info)
Outputs the information contained in a RepInfo object


show

public void show(OutputHandler handler)
Outputs information about the OutputHandler specified in the parameter


show

public void show()
Outputs minimal information about the application


show

public void show(App app)
Outputs detailed information about the application, including configuration, available modules and handlers, etc.


showHeader

public void showHeader()
Do the initial output. This should be in a suitable format for including multiple files between the header and the footer.


showFooter

public void showFooter()
Do the final output. This should be in a suitable format for including multiple files between the header and the footer.


close

public void close()
Do appropriate finalization after all output is complete.


startDirectory

public void startDirectory(java.lang.String directory)
Callback indicating a new directory is being processed. Most handlers will do nothing.

Parameters:
directory - Directory path