Package org.apache.tika.mime

Class MimeTypesReader

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.apache.tika.mime.MimeTypesReader

All Implemented Interfaces:

MimeTypesReaderMetKeys, ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class MimeTypesReader
extends DefaultHandler
implements MimeTypesReaderMetKeys

A reader for XML files compliant with the freedesktop MIME-info DTD.

  <!DOCTYPE mime-info [
    <!ELEMENT mime-info (mime-type)+>
    <!ATTLIST mime-info xmlns CDATA #FIXED
    "http://www.freedesktop.org/standards/shared-mime-info">

    <!ELEMENT mime-type
     (comment|acronym|expanded-acronym|glob|magic|root-XML|alias|sub-class-of)*>
    <!ATTLIST mime-type type CDATA #REQUIRED>

    <!-- a comment describing a document with the respective MIME type. Example:
    "WMV video" -->
    <!ELEMENT _comment (#PCDATA)>
    <!ATTLIST _comment xml:lang CDATA #IMPLIED>

    <!-- a comment describing a the respective unexpanded MIME type acronym. Example:
    "WMV" -->
    <!ELEMENT acronym (#PCDATA)>
    <!ATTLIST acronym xml:lang CDATA #IMPLIED>

    <!-- a comment describing a the respective unexpanded MIME type acronym. Example:
    "Windows Media Video" -->
    <!ELEMENT expanded-acronym (#PCDATA)>
    <!ATTLIST expanded-acronym xml:lang CDATA #IMPLIED>

    <!ELEMENT glob EMPTY>
    <!ATTLIST glob pattern CDATA #REQUIRED>
    <!ATTLIST glob isregex CDATA #IMPLIED>

    <!ELEMENT magic (match)+>
    <!ATTLIST magic priority CDATA #IMPLIED>

    <!ELEMENT match (match)*>
    <!ATTLIST match offset CDATA #REQUIRED>
    <!ATTLIST match type
        (string|big16|big32|little16|little32|host16|host32|byte) #REQUIRED>
    <!ATTLIST match value CDATA #REQUIRED>
    <!ATTLIST match mask CDATA #IMPLIED>

    <!ELEMENT root-XML EMPTY>
    <!ATTLIST root-XML
          namespaceURI CDATA #REQUIRED
          localName CDATA #REQUIRED>

    <!ELEMENT alias EMPTY>
    <!ATTLIST alias
          type CDATA #REQUIRED>

   <!ELEMENT sub-class-of EMPTY>
   <!ATTLIST sub-class-of
         type CDATA #REQUIRED>
  ]>
 

In addition to the standard fields, this will also read two Tika specific fields: - link - uti

See Also:

• https://freedesktop.org/wiki/Specifications/shared-mime-info-spec/

Field Summary

Fields

Modifier and Type	Field	Description
protected StringBuilder	characters
protected int	priority
protected MimeType	type	Current type
protected final MimeTypes	types

Fields inherited from interface org.apache.tika.mime.MimeTypesReaderMetKeys

ACRONYM_TAG, ALIAS_TAG, ALIAS_TYPE_ATTR, COMMENT_TAG, GLOB_TAG, INTERPRETED_ATTR, ISREGEX_ATTR, LOCAL_NAME_ATTR, MAGIC_PRIORITY_ATTR, MAGIC_TAG, MATCH_MASK_ATTR, MATCH_MINSHOULDMATCH_ATTR, MATCH_OFFSET_ATTR, MATCH_TAG, MATCH_TYPE_ATTR, MATCH_VALUE_ATTR, MIME_INFO_TAG, MIME_TYPE_TAG, MIME_TYPE_TYPE_ATTR, NS_URI_ATTR, PATTERN_ATTR, ROOT_XML_TAG, SUB_CLASS_OF_TAG, SUB_CLASS_TYPE_ATTR, TIKA_LINK_TAG, TIKA_UTI_TAG

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MimeTypesReader(MimeTypes types)

Method Summary

Modifier and Type	Method	Description
void	characters(char[] ch, int start, int length)
void	endElement(String uri, String localName, String qName)
protected void	handleGlobError(MimeType type, String pattern, MimeTypeException ex, String qName, Attributes attributes)
protected void	handleMimeError(String input, MimeTypeException ex, String qName, Attributes attributes)
void	read(InputStream stream)
void	read(Document document)
InputSource	resolveEntity(String publicId, String systemId)
static void	setPoolSize(int poolSize)	Set the pool size for cached XML parsers.
void	startElement(String uri, String localName, String qName, Attributes attributes)

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

Methods inherited from interface org.xml.sax.ContentHandler

declaration

Field Details

types

protected final MimeTypes types

type

protected MimeType type

Current type

priority

protected int priority

characters

protected StringBuilder characters

Constructor Details

MimeTypesReader

protected MimeTypesReader(MimeTypes types)

Method Details

setPoolSize

public static void setPoolSize(int poolSize)
                        throws TikaException

Set the pool size for cached XML parsers.

Parameters:

poolSize -

Throws:

TikaException

read

public void read(InputStream stream)
          throws IOException,
MimeTypeException

Throws:

IOException

MimeTypeException

read

public void read(Document document)
          throws MimeTypeException

Throws:

MimeTypeException

resolveEntity

public InputSource resolveEntity(String publicId,
 String systemId)

Specified by:

resolveEntity in interface EntityResolver

Overrides:

resolveEntity in class DefaultHandler

startElement

public void startElement(String uri,
 String localName,
 String qName,
 Attributes attributes)
                  throws SAXException

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Throws:

SAXException

endElement

public void endElement(String uri,
 String localName,
 String qName)

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

characters

public void characters(char[] ch,
 int start,
 int length)

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultHandler

handleMimeError

protected void handleMimeError(String input,
 MimeTypeException ex,
 String qName,
 Attributes attributes)
                        throws SAXException

Throws:

SAXException

handleGlobError

protected void handleGlobError(MimeType type,
 String pattern,
 MimeTypeException ex,
 String qName,
 Attributes attributes)
                        throws SAXException

Throws:

SAXException