ConfigHandler (JHOVE - JSTOR/Harvard Object Validation Environment 1.16.0 API)

java.lang.Object
- org.xml.sax.helpers.DefaultHandler
- - edu.harvard.hul.ois.jhove.ConfigHandler

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler
```
public class ConfigHandler
extends org.xml.sax.helpers.DefaultHandler
```
SAX Parser for the configuration file.

Field Summary

Fields
Modifier and Type	Field and Description
`protected StringBuffer`	`_content`
`protected List<List<String>>`	`_handlerParams` The list of handler parameters.
`protected boolean`	`_isHandler`
`protected boolean`	`_isModule`
`protected List<List<String>>`	`_modParams` The list of module parameters.
`protected List<ModuleInfo>`	`_module` The list of modules.

Constructor Summary

Constructors
Constructor and Description

ConfigHandler()
Creates a ConfigHandler.

Constructors
Constructor and Description
`ConfigHandler()` Creates a ConfigHandler.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`characters(char[] ch, int start, int length)` SAX parser callback method.
`void`	`endElement(String namespaceURI, String localName, String rawName)` SAX parser callback method.
`int`	`getBufferSize()` Returns the buffer size specified in the config file.
`String`	`getEncoding()` Returns the character encoding specified by the config file.
`Map<String,String>`	`getExtensions()` Return an associative map of configuration extensions.
`List<String[]>`	`getHandler()` Returns the List of OutputHandlers specified by the config file.
`List<List<String>>`	`getHandlerParams()` Returns the List of handler parameters specified by the config file.
`String`	`getJhoveHome()` Returns the path to the application's home directory, with final path separator.
`String`	`getLogLevel()` Returns the name of the desired log level.
`String`	`getMixVsn()` Returns the MIX schema version specified by the config file.
`List<ModuleInfo>`	`getModule()` Returns the List of Modules specified by the config file.
`List<List<String>>`	`getModuleParams()` Returns the List of module parameters specified by the config file.
`int`	`getSigBytes()` Returns the number of bytes to examine when looking for an indefinitely positioned signature, or checking the first sigBytes bytes of a file in lieu of a signature.
`String`	`getTempDir()` Returns the temporary directory path specified by the config file, with final path separator.
`InputSource`	`resolveEntity(String publicId, String systemId)` EntityResolver designed to locate the config schema.
`void`	`startElement(String namespaceURI, String localName, String rawName, Attributes atts)` SAX parser callback method.

Methods inherited from class org.xml.sax.helpers.DefaultHandler
endDocument, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _content
```
protected StringBuffer _content
```
  - _handlerParams
```
protected List<List<String>> _handlerParams
```
    The list of handler parameters. Each element in the List is a List of Strings (which may be empty but not null) representing parameters to be passed to the module. List elements are in one-to-one correspondence with _handler.
  - _isHandler
```
protected boolean _isHandler
```
  - _isModule
```
protected boolean _isModule
```
  - _module
```
protected List<ModuleInfo> _module
```
    The list of modules. Each element in the List is an array of two Strings representing the class and the initialization string.
  - _modParams
```
protected List<List<String>> _modParams
```
    The list of module parameters. Each element in the List is a List of Strings (which may be empty but not null) representing parameters to be passed to the module. List elements are in one-to-one correspondence with _module.
- Constructor Detail
  - ConfigHandler
```
public ConfigHandler()
```
    Creates a ConfigHandler.
- Method Detail
  - getModule
```
public List<ModuleInfo> getModule()
```
    Returns the List of Modules specified by the config file. Each element of the List is a String[2] whose elements are the module class name and initialization value.
    
    See Also:
    
    Module
  - getModuleParams
```
public List<List<String>> getModuleParams()
```
    Returns the List of module parameters specified by the config file. Each element of the List is a List (possibly empty) of Strings whose elements are parameters to pass to the module. The values returned by getModuleParams() are in one-to-one correspondence with those return by getModule().
  - getHandlerParams
```
public List<List<String>> getHandlerParams()
```
    Returns the List of handler parameters specified by the config file. Each element of the List is a List (possibly empty) of Strings whose elements are parameters to pass to the output handler. The values returned by getHandlerParams() are in one-to-one correspondence with those return by getHandler().
  - getHandler
```
public List<String[]> getHandler()
```
    Returns the List of OutputHandlers specified by the config file.
    
    See Also:
    
    OutputHandler
  - getTempDir
```
public String getTempDir()
```
    Returns the temporary directory path specified by the config file, with final path separator.
  - getMixVsn
```
public String getMixVsn()
```
    Returns the MIX schema version specified by the config file. Acceptable values are "0.2" and "1.0" and "2.0".
  - getSigBytes
```
public int getSigBytes()
```
    Returns the number of bytes to examine when looking for an indefinitely positioned signature, or checking the first sigBytes bytes of a file in lieu of a signature.
  - getEncoding
```
public String getEncoding()
```
    Returns the character encoding specified by the config file.
  - getBufferSize
```
public int getBufferSize()
```
    Returns the buffer size specified in the config file.
    
    Returns:
    
    the buffer size, or -1 if none specified
  - getExtensions
```
public Map<String,String> getExtensions()
```
    Return an associative map of configuration extensions.
  - getJhoveHome
```
public String getJhoveHome()
```
    Returns the path to the application's home directory, with final path separator.
  - getLogLevel
```
public String getLogLevel()
```
    Returns the name of the desired log level. This should be the name of one of the predefined values of java.util.logging.Level, e.g., "WARNING", "INFO", "ALL". The default level is SEVERE.
  - startElement
```
public void startElement(String namespaceURI,
                         String localName,
                         String rawName,
                         Attributes atts)
                  throws SAXException
```
    SAX parser callback method.
    
    Specified by:
    
    startElement in interface ContentHandler
    
    Overrides:
    
    startElement in class org.xml.sax.helpers.DefaultHandler
    
    Throws:
    
    SAXException
  - characters
```
public void characters(char[] ch,
                       int start,
                       int length)
                throws SAXException
```
    SAX parser callback method.
    
    Specified by:
    
    characters in interface ContentHandler
    
    Overrides:
    
    characters in class org.xml.sax.helpers.DefaultHandler
    
    Throws:
    
    SAXException
  - endElement
```
public void endElement(String namespaceURI,
                       String localName,
                       String rawName)
                throws SAXException
```
    SAX parser callback method.
    
    Specified by:
    
    endElement in interface ContentHandler
    
    Overrides:
    
    endElement in class org.xml.sax.helpers.DefaultHandler
    
    Throws:
    
    SAXException
  - resolveEntity
```
public InputSource resolveEntity(String publicId,
                                 String systemId)
                          throws SAXException,
                                 IOException
```
    EntityResolver designed to locate the config schema. It tries to find it as a local resource. It appears that not all SAX implementations will actually call this function for schema resolution, so this isn't a guarantee that the schema in the config file won't be called directly. But hopefully it will cut down on the burden on the server with the official schema copy.
    
    Specified by:
    
    resolveEntity in interface EntityResolver
    
    Overrides:
    
    resolveEntity in class org.xml.sax.helpers.DefaultHandler
    
    Throws:
    
    SAXException
    
    IOException

Class ConfigHandler

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.xml.sax.helpers.DefaultHandler

Methods inherited from class java.lang.Object

Field Detail

_content

_handlerParams

_isHandler

_isModule

_module

_modParams

Constructor Detail

ConfigHandler

Method Detail

getModule

getModuleParams

getHandlerParams

getHandler

getTempDir

getMixVsn

getSigBytes

getEncoding

getBufferSize

getExtensions

getJhoveHome

getLogLevel

startElement

characters

endElement

resolveEntity