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

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

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler
```
public class XMPHandler
extends org.xml.sax.helpers.DefaultHandler
```
This class encapsulates XMP metadata within a file. It makes use of an InputStream as a data source. This differs from normal XML handling in that it's necessary to process the xpacket processing instruction in order to determine the encoding of the XML. the processingInstruction function looks for xpacket, and throws a special SAXException if it's necessary to change encoding. We don't actually extract any information from the XMP, but simply check it for well-formedness. By convention, XMPHandler should be invoked on an XMPSource (TBW), which provides the ability to recapture the InputStream from which the XMP was obtained and put it into a property once it's verified here.

Constructor Summary

Constructors
Constructor and Description

XMPHandler()

Constructors
Constructor and Description
`XMPHandler()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`endElement(String namespaceURI, String localName, String rawName)` Catches the end of an element.
`void`	`fatalError(SAXParseException exception)` Catch a fatal error.
`boolean`	`isPdfaCompliant()` Returns true if no violations of PDF/A compliance have been found, false if a problem was detected.
`void`	`processingInstruction(String target, String data)`
`void`	`startElement(String namespaceURI, String localName, String rawName, Attributes atts)` Catches the start of an element and, if it's one we care about, sets state information.

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

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

- Constructor Detail
  - XMPHandler
```
public XMPHandler()
```
- Method Detail
  - isPdfaCompliant
```
public boolean isPdfaCompliant()
```
    Returns true if no violations of PDF/A compliance have been found, false if a problem was detected.
  - processingInstruction
```
public void processingInstruction(String target,
                                  String data)
                           throws SAXException
```
    Specified by:
    
    processingInstruction in interface ContentHandler
    
    Overrides:
    
    processingInstruction in class org.xml.sax.helpers.DefaultHandler
    
    Throws:
    
    SAXException
  - startElement
```
public void startElement(String namespaceURI,
                         String localName,
                         String rawName,
                         Attributes atts)
                  throws SAXException
```
    Catches the start of an element and, if it's one we care about, sets state information.
    
    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 rawName)
                throws SAXException
```
    Catches the end of an element.
    
    Specified by:
    
    endElement in interface ContentHandler
    
    Overrides:
    
    endElement in class org.xml.sax.helpers.DefaultHandler
    
    Throws:
    
    SAXException
  - fatalError
```
public void fatalError(SAXParseException exception)
                throws SAXException
```
    Catch a fatal error. This is put here because the default behavior is to report a "fatal error" to standard output, which is harmless but scary.
    
    Specified by:
    
    fatalError in interface ErrorHandler
    
    Overrides:
    
    fatalError in class org.xml.sax.helpers.DefaultHandler
    
    Throws:
    
    SAXException

Class XMPHandler

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

XMPHandler

Method Detail

isPdfaCompliant

processingInstruction

startElement

endElement

fatalError