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

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

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler
```
public class XmlModuleHandler
extends org.xml.sax.helpers.DefaultHandler
```
This handler does the parsing work of the XML module.

Author:

Gary McGath

Constructor Summary

Constructors
Constructor and Description

XmlModuleHandler()
Constructor.

Constructors
Constructor and Description
`XmlModuleHandler()` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`characters(char[] ch, int start, int length)` Processes PCData characters.
`void`	`endElement(String namespaceURI, String localName, String qName)` The only action taken here is some bookkeeping in connection with the HTML metadata.
`void`	`error(SAXParseException e)` Processes a parsing exception.
`Set<String>`	`getAttributeValues()` Returns the set of attribute values.
`String`	`getDTDURI()` Returns the DTD URI.
`HtmlMetadata`	`getHtmlMetadata()` Returns the HTML metadata object.
`List<Message>`	`getMessages()` Returns the List of messages generated during the parse.
`Map<String,String>`	`getNamespaces()` Returns the map of prefixes to namespaces.
`List<String[]>`	`getNotations()` Returns the list of notations.
`List<ProcessingInstructionInfo>`	`getProcessingInstructions()` Returns the List of processing instructions.
`String`	`getRoot()` Returns the qualified name of the root element.
`List<SchemaInfo>`	`getSchemas()` Returns the list of schemas.
`boolean`	`getSigFlag()` Returns `true` if we have seen an element or a processing instruction, which implies that we've seen an XML declaration.
`List<String[]>`	`getUnparsedEntities()` Returns the list of unparsed entities.
`boolean`	`hasSchemaURI(SchemaInfo newinfo)`
`boolean`	`isValid()` Returns the validity state.
`void`	`notationDecl(String name, String publicID, String systemID)` Puts all notations into the notation list.
`void`	`processingInstruction(String target, String data)` Handles a processing instruction.
`InputSource`	`resolveEntity(String publicId, String systemId)` Overrides standard resolveEntity.
`void`	`setLocalSchemas(Map<String,File> schemas)` Sets a map of schema URIs to local files.
`void`	`setXhtmlFlag(boolean flag)` Sets the value of the XHTML flag.
`void`	`startElement(String namespaceURI, String localName, String qualifiedName, Attributes atts)` Looks for the first element encountered.
`void`	`startPrefixMapping(String prefix, String uri)` Begin the scope of a prefix-URI Namespace mapping.
`void`	`unparsedEntityDecl(String name, String publicId, String systemId, String notationName)` Picks up unparsed entity declarations, after calling the superclass's unparsedEntityDecl, and puts their information into the unparsed entity declaration list as an array of four strings: [ name, publicId, systemId, notationName].
`void`	`warning(SAXParseException e)` Processes a warning.

Methods inherited from class org.xml.sax.helpers.DefaultHandler
endDocument, endPrefixMapping, fatalError, ignorableWhitespace, setDocumentLocator, skippedEntity, startDocument

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

- Constructor Detail
  - XmlModuleHandler
```
public XmlModuleHandler()
```
    Constructor.
- Method Detail
  - setXhtmlFlag
```
public void setXhtmlFlag(boolean flag)
```
    Sets the value of the XHTML flag. Special properties are extracted if this is an XHTML document.
  - setLocalSchemas
```
public void setLocalSchemas(Map<String,File> schemas)
```
    Sets a map of schema URIs to local files. This information comes from jhove.conf parameters.
  - getHtmlMetadata
```
public HtmlMetadata getHtmlMetadata()
```
    Returns the HTML metadata object. Will be non-null only for a document recognized as XHTML.
  - startElement
```
public void startElement(String namespaceURI,
                         String localName,
                         String qualifiedName,
                         Attributes atts)
                  throws SAXException
```
    Looks for the first element encountered. Stores its name as the value to be returned by getRoot, qualified name by preference, local name if the qualified name isn't available.
    
    Specified by:
    
    startElement in interface ContentHandler
    
    Overrides:
    
    startElement in class org.xml.sax.helpers.DefaultHandler
    
    Throws:
    
    SAXException
  - endElement
```
public void endElement(String namespaceURI,
                       String localName,
                       String qName)
```
    The only action taken here is some bookkeeping in connection with the HTML metadata.
    
    Specified by:
    
    endElement in interface ContentHandler
    
    Overrides:
    
    endElement in class org.xml.sax.helpers.DefaultHandler
  - characters
```
public void characters(char[] ch,
                       int start,
                       int length)
```
    Processes PCData characters. This does things only in connection with properties under construction in HTML metadata.
    
    Specified by:
    
    characters in interface ContentHandler
    
    Overrides:
    
    characters in class org.xml.sax.helpers.DefaultHandler
  - startPrefixMapping
```
public void startPrefixMapping(String prefix,
                               String uri)
                        throws SAXException
```
    Begin the scope of a prefix-URI Namespace mapping. Prefixes mappings are stored in _namespaces.
    
    Specified by:
    
    startPrefixMapping in interface ContentHandler
    
    Overrides:
    
    startPrefixMapping in class org.xml.sax.helpers.DefaultHandler
    
    Throws:
    
    SAXException
  - processingInstruction
```
public void processingInstruction(String target,
                                  String data)
                           throws SAXException
```
    Handles a processing instruction. Adds it to the list that will be returned by getProcessingInstructions. Each element of the list is an array of two Strings. Element 0 of the array is the target, and element 1 is the data.
    
    Specified by:
    
    processingInstruction in interface ContentHandler
    
    Overrides:
    
    processingInstruction in class org.xml.sax.helpers.DefaultHandler
    
    Throws:
    
    SAXException
  - notationDecl
```
public void notationDecl(String name,
                         String publicID,
                         String systemID)
                  throws SAXException
```
    Puts all notations into the notation list. A list entry is a String[3], consisting of name, public ID, and system ID.
    
    Specified by:
    
    notationDecl in interface DTDHandler
    
    Overrides:
    
    notationDecl in class org.xml.sax.helpers.DefaultHandler
    
    Throws:
    
    SAXException
  - resolveEntity
```
public InputSource resolveEntity(String publicId,
                                 String systemId)
                          throws SAXException
```
    Overrides standard resolveEntity. First looks for DTD and entity files that are stored as resources, and uses those if available. (Faster and more reliable than grabbing them over the Net.) If that fails, calls the superclass's resolveEntity. Regardless, it then looks for anything that appears to be a DTD and puts it in the DTD URI field. If the superclass's attempt to resolve the entity results in an IOException, we just ignore it.
    
    Specified by:
    
    resolveEntity in interface EntityResolver
    
    Overrides:
    
    resolveEntity in class org.xml.sax.helpers.DefaultHandler
    
    Throws:
    
    SAXException
  - unparsedEntityDecl
```
public void unparsedEntityDecl(String name,
                               String publicId,
                               String systemId,
                               String notationName)
                        throws SAXException
```
    Picks up unparsed entity declarations, after calling the superclass's unparsedEntityDecl, and puts their information into the unparsed entity declaration list as an array of four strings: [ name, publicId, systemId, notationName]. Null values are converted into empty strings.
    
    Specified by:
    
    unparsedEntityDecl in interface DTDHandler
    
    Overrides:
    
    unparsedEntityDecl in class org.xml.sax.helpers.DefaultHandler
    
    Throws:
    
    SAXException
  - warning
```
public void warning(SAXParseException e)
```
    Processes a warning. We just add an InfoMessage.
    
    Specified by:
    
    warning in interface ErrorHandler
    
    Overrides:
    
    warning in class org.xml.sax.helpers.DefaultHandler
  - error
```
public void error(SAXParseException e)
```
    Processes a parsing exception. An ill-formed piece of XML will get a fatalError (I think), so we can assume that any error here indicates only invalidity.
    
    Specified by:
    
    error in interface ErrorHandler
    
    Overrides:
    
    error in class org.xml.sax.helpers.DefaultHandler
  - getAttributeValues
```
public Set<String> getAttributeValues()
```
    Returns the set of attribute values.
  - getSchemas
```
public List<SchemaInfo> getSchemas()
```
    Returns the list of schemas. The elements of the list are Strings, giving the URI's for the schemas.
  - getUnparsedEntities
```
public List<String[]> getUnparsedEntities()
```
    Returns the list of unparsed entities. The elements of the list are arrays of four Strings, giving the name, public ID, system ID and notation name respectively.
  - getNamespaces
```
public Map<String,String> getNamespaces()
```
    Returns the map of prefixes to namespaces. The keys and values are Strings.
  - getDTDURI
```
public String getDTDURI()
```
    Returns the DTD URI. May be null.
  - getProcessingInstructions
```
public List<ProcessingInstructionInfo> getProcessingInstructions()
```
    Returns the List of processing instructions. Each element is an array of two strings, giving the target and data respectively.
  - getNotations
```
public List<String[]> getNotations()
```
    Returns the list of notations. Each is an array String[3]: name, public ID, and system ID.
  - getRoot
```
public String getRoot()
```
    Returns the qualified name of the root element.
  - getMessages
```
public List<Message> getMessages()
```
    Returns the List of messages generated during the parse.
  - isValid
```
public boolean isValid()
```
    Returns the validity state. If error has been called, the return value will be false.
  - getSigFlag
```
public boolean getSigFlag()
```
    Returns true if we have seen an element or a processing instruction, which implies that we've seen an XML declaration.
  - hasSchemaURI
```
public boolean hasSchemaURI(SchemaInfo newinfo)
```

Class XmlModuleHandler

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

XmlModuleHandler

Method Detail

setXhtmlFlag

setLocalSchemas

getHtmlMetadata

startElement

endElement

characters

startPrefixMapping

processingInstruction

notationDecl

resolveEntity

unparsedEntityDecl

warning

error

getAttributeValues

getSchemas

getUnparsedEntities

getNamespaces

getDTDURI

getProcessingInstructions

getNotations

getRoot

getMessages

isValid

getSigFlag

hasSchemaURI