You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tika.apache.org by ma...@apache.org on 2007/11/18 23:21:13 UTC
svn commit: r596146 [29/36] - in /incubator/tika/site: ./ apidocs/
apidocs/org/ apidocs/org/apache/ apidocs/org/apache/tika/
apidocs/org/apache/tika/config/ apidocs/org/apache/tika/config/class-use/
apidocs/org/apache/tika/exception/ apidocs/org/apache...
Added: incubator/tika/site/xref/org/apache/tika/mime/MimeTypes.html
URL: http://svn.apache.org/viewvc/incubator/tika/site/xref/org/apache/tika/mime/MimeTypes.html?rev=596146&view=auto
==============================================================================
--- incubator/tika/site/xref/org/apache/tika/mime/MimeTypes.html (added)
+++ incubator/tika/site/xref/org/apache/tika/mime/MimeTypes.html Sun Nov 18 14:20:54 2007
@@ -0,0 +1,370 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+<title>MimeTypes xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../apidocs/org/apache/tika/mime/MimeTypes.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a> <em class="jxr_javadoccomment">/**</em>
+<a name="2" href="#2">2</a> <em class="jxr_javadoccomment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
+<a name="3" href="#3">3</a> <em class="jxr_javadoccomment"> * contributor license agreements. See the NOTICE file distributed with</em>
+<a name="4" href="#4">4</a> <em class="jxr_javadoccomment"> * this work for additional information regarding copyright ownership.</em>
+<a name="5" href="#5">5</a> <em class="jxr_javadoccomment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em>
+<a name="6" href="#6">6</a> <em class="jxr_javadoccomment"> * (the "License"); you may not use this file except in compliance with</em>
+<a name="7" href="#7">7</a> <em class="jxr_javadoccomment"> * the License. You may obtain a copy of the License at</em>
+<a name="8" href="#8">8</a> <em class="jxr_javadoccomment"> *</em>
+<a name="9" href="#9">9</a> <em class="jxr_javadoccomment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
+<a name="10" href="#10">10</a> <em class="jxr_javadoccomment"> *</em>
+<a name="11" href="#11">11</a> <em class="jxr_javadoccomment"> * Unless required by applicable law or agreed to in writing, software</em>
+<a name="12" href="#12">12</a> <em class="jxr_javadoccomment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
+<a name="13" href="#13">13</a> <em class="jxr_javadoccomment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
+<a name="14" href="#14">14</a> <em class="jxr_javadoccomment"> * See the License for the specific language governing permissions and</em>
+<a name="15" href="#15">15</a> <em class="jxr_javadoccomment"> * limitations under the License.</em>
+<a name="16" href="#16">16</a> <em class="jxr_javadoccomment"> */</em>
+<a name="17" href="#17">17</a> <strong class="jxr_keyword">package</strong> org.apache.tika.mime;
+<a name="18" href="#18">18</a>
+<a name="19" href="#19">19</a> <em class="jxr_comment">// JDK imports</em>
+<a name="20" href="#20">20</a> <strong class="jxr_keyword">import</strong> java.io.File;
+<a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
+<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.io.InputStream;
+<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.net.URL;
+<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.util.Arrays;
+<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.util.Map;
+<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.util.HashMap;
+<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.util.SortedSet;
+<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> java.util.TreeSet;
+<a name="29" href="#29">29</a>
+<a name="30" href="#30">30</a> <em class="jxr_javadoccomment">/**</em>
+<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * This class is a MimeType repository. It gathers a set of MimeTypes and</em>
+<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * enables to retrieves a content-type from its name, from a file name, or from</em>
+<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * a magic character sequence.</em>
+<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * <p></em>
+<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * The MIME type detection methods that take an {@link InputStream} as</em>
+<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * an argument will never reads more than {@link #getMinLength()} bytes</em>
+<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * from the stream. Also the given stream is never</em>
+<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * {@link InputStream#close() closed}, {@link InputStream#mark(int) marked},</em>
+<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * or {@link InputStream#reset() reset} by the methods. Thus a client can</em>
+<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * use the {@link InputStream#markSupported() mark feature} of the stream</em>
+<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * (if available) to restore the stream back to the state it was before type</em>
+<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * detection if it wants to process the stream based on the detected type.</em>
+<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> */</em>
+<a name="44" href="#44">44</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/tika/mime/MimeTypes.html">MimeTypes</a> {
+<a name="45" href="#45">45</a>
+<a name="46" href="#46">46</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The default <code>application/octet-stream</code> <a href="../../../../org/apache/tika/mime/MimeType.html">MimeType</a> */</em>
+<a name="47" href="#47">47</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">static</strong> String DEFAULT = <span class="jxr_string">"application/octet-stream"</span>;
+<a name="48" href="#48">48</a>
+<a name="49" href="#49">49</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../org/apache/tika/mime/MimeType.html">MimeType</a> root;
+<a name="50" href="#50">50</a>
+<a name="51" href="#51">51</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> All the registered <a href="../../../../org/apache/tika/mime/MimeTypes.html">MimeTypes</a> indexed on their name */</em>
+<a name="52" href="#52">52</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Map<String, MimeType> types = <strong class="jxr_keyword">new</strong> HashMap<String, MimeType>();
+<a name="53" href="#53">53</a>
+<a name="54" href="#54">54</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The patterns matcher */</em>
+<a name="55" href="#55">55</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/apache/tika/mime/Patterns.html">Patterns</a> patterns = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/tika/mime/Patterns.html">Patterns</a>();
+<a name="56" href="#56">56</a>
+<a name="57" href="#57">57</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> List of all registered magics */</em>
+<a name="58" href="#58">58</a> <strong class="jxr_keyword">private</strong> SortedSet<Magic> magics = <strong class="jxr_keyword">new</strong> TreeSet<Magic>();
+<a name="59" href="#59">59</a>
+<a name="60" href="#60">60</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> List of all registered rootXML */</em>
+<a name="61" href="#61">61</a> <strong class="jxr_keyword">private</strong> SortedSet<MimeType> xmls = <strong class="jxr_keyword">new</strong> TreeSet<MimeType>();
+<a name="62" href="#62">62</a>
+<a name="63" href="#63">63</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/tika/mime/MimeTypes.html">MimeTypes</a>() {
+<a name="64" href="#64">64</a> root = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/tika/mime/MimeType.html">MimeType</a>(<strong class="jxr_keyword">this</strong>, DEFAULT);
+<a name="65" href="#65">65</a> types.put(root.getName(), root);
+<a name="66" href="#66">66</a> }
+<a name="67" href="#67">67</a>
+<a name="68" href="#68">68</a> <em class="jxr_javadoccomment">/**</em>
+<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * Find the Mime Content Type of a file.</em>
+<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * </em>
+<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * @param file</em>
+<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * to analyze.</em>
+<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * @return the Mime Content Type of the specified file, or <code>null</code></em>
+<a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * if none is found.</em>
+<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> */</em>
+<a name="76" href="#76">76</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/tika/mime/MimeType.html">MimeType</a> getMimeType(File file) {
+<a name="77" href="#77">77</a> <strong class="jxr_keyword">return</strong> getMimeType(file.getName());
+<a name="78" href="#78">78</a> }
+<a name="79" href="#79">79</a>
+<a name="80" href="#80">80</a> <em class="jxr_javadoccomment">/**</em>
+<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * Find the Mime Content Type of a document from its URL.</em>
+<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * </em>
+<a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * @param url</em>
+<a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * of the document to analyze.</em>
+<a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * @return the Mime Content Type of the specified document URL, or</em>
+<a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * <code>null</code> if none is found.</em>
+<a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> */</em>
+<a name="88" href="#88">88</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/tika/mime/MimeType.html">MimeType</a> getMimeType(URL url) {
+<a name="89" href="#89">89</a> <strong class="jxr_keyword">return</strong> getMimeType(url.getPath());
+<a name="90" href="#90">90</a> }
+<a name="91" href="#91">91</a>
+<a name="92" href="#92">92</a> <em class="jxr_javadoccomment">/**</em>
+<a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * Find the Mime Content Type of a document from its name.</em>
+<a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * </em>
+<a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * @param name</em>
+<a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * of the document to analyze.</em>
+<a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * @return the Mime Content Type of the specified document name</em>
+<a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> */</em>
+<a name="99" href="#99">99</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/tika/mime/MimeType.html">MimeType</a> getMimeType(String name) {
+<a name="100" href="#100">100</a> <a href="../../../../org/apache/tika/mime/MimeType.html">MimeType</a> type = patterns.matches(name);
+<a name="101" href="#101">101</a> <strong class="jxr_keyword">if</strong> (type != <strong class="jxr_keyword">null</strong>) {
+<a name="102" href="#102">102</a> <strong class="jxr_keyword">return</strong> type;
+<a name="103" href="#103">103</a> }
+<a name="104" href="#104">104</a> type = patterns.matches(name.toLowerCase());
+<a name="105" href="#105">105</a> <strong class="jxr_keyword">if</strong> (type != <strong class="jxr_keyword">null</strong>) {
+<a name="106" href="#106">106</a> <strong class="jxr_keyword">return</strong> type;
+<a name="107" href="#107">107</a> } <strong class="jxr_keyword">else</strong> {
+<a name="108" href="#108">108</a> <strong class="jxr_keyword">return</strong> root;
+<a name="109" href="#109">109</a> }
+<a name="110" href="#110">110</a> }
+<a name="111" href="#111">111</a>
+<a name="112" href="#112">112</a> <em class="jxr_javadoccomment">/**</em>
+<a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * Returns the MIME type that best matches the given first few bytes</em>
+<a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * of a document stream.</em>
+<a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * <p></em>
+<a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * The given byte array is expected to be at least {@link #getMinLength()}</em>
+<a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * long, or shorter only if the document stream itself is shorter.</em>
+<a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> *</em>
+<a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * @param data first few bytes of a document stream</em>
+<a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * @return matching MIME type, or <code>null</code> if no match is found</em>
+<a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> */</em>
+<a name="122" href="#122">122</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/tika/mime/MimeType.html">MimeType</a> getMimeType(byte[] data) {
+<a name="123" href="#123">123</a> assert data != <strong class="jxr_keyword">null</strong>;
+<a name="124" href="#124">124</a>
+<a name="125" href="#125">125</a> <em class="jxr_comment">// First, check for XML descriptions (level by level)</em>
+<a name="126" href="#126">126</a> <strong class="jxr_keyword">for</strong> (MimeType type : xmls) {
+<a name="127" href="#127">127</a> <strong class="jxr_keyword">if</strong> (type.matchesXML(data)) {
+<a name="128" href="#128">128</a> <strong class="jxr_keyword">return</strong> type;
+<a name="129" href="#129">129</a> }
+<a name="130" href="#130">130</a> }
+<a name="131" href="#131">131</a>
+<a name="132" href="#132">132</a> <em class="jxr_comment">// Then, check for magic bytes</em>
+<a name="133" href="#133">133</a> <strong class="jxr_keyword">for</strong> (Magic magic : magics) {
+<a name="134" href="#134">134</a> <strong class="jxr_keyword">if</strong> (magic.eval(data)) {
+<a name="135" href="#135">135</a> <strong class="jxr_keyword">return</strong> magic.getType();
+<a name="136" href="#136">136</a> }
+<a name="137" href="#137">137</a> }
+<a name="138" href="#138">138</a>
+<a name="139" href="#139">139</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
+<a name="140" href="#140">140</a> }
+<a name="141" href="#141">141</a>
+<a name="142" href="#142">142</a> <em class="jxr_javadoccomment">/**</em>
+<a name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * Returns the MIME type that best matches the first few bytes of the</em>
+<a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * given document stream.</em>
+<a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> *</em>
+<a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * @see #getMimeType(byte[])</em>
+<a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> * @param stream document stream</em>
+<a name="148" href="#148">148</a> <em class="jxr_javadoccomment"> * @return matching MIME type, or <code>null</code> if no match is found</em>
+<a name="149" href="#149">149</a> <em class="jxr_javadoccomment"> * @throws IOException if the stream can be read</em>
+<a name="150" href="#150">150</a> <em class="jxr_javadoccomment"> */</em>
+<a name="151" href="#151">151</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/tika/mime/MimeType.html">MimeType</a> getMimeType(InputStream stream) <strong class="jxr_keyword">throws</strong> IOException {
+<a name="152" href="#152">152</a> <strong class="jxr_keyword">return</strong> getMimeType(readMagicHeader(stream));
+<a name="153" href="#153">153</a> }
+<a name="154" href="#154">154</a>
+<a name="155" href="#155">155</a> <em class="jxr_javadoccomment">/**</em>
+<a name="156" href="#156">156</a> <em class="jxr_javadoccomment"> * Reads the first {@link #getMinLength()} bytes from the given stream.</em>
+<a name="157" href="#157">157</a> <em class="jxr_javadoccomment"> * If the stream is shorter, then the entire content of the stream is</em>
+<a name="158" href="#158">158</a> <em class="jxr_javadoccomment"> * returned.</em>
+<a name="159" href="#159">159</a> <em class="jxr_javadoccomment"> * <p></em>
+<a name="160" href="#160">160</a> <em class="jxr_javadoccomment"> * The given stream is never {@link InputStream#close() closed},</em>
+<a name="161" href="#161">161</a> <em class="jxr_javadoccomment"> * {@link InputStream#mark(int) marked}, or</em>
+<a name="162" href="#162">162</a> <em class="jxr_javadoccomment"> * {@link InputStream#reset() reset} by this method.</em>
+<a name="163" href="#163">163</a> <em class="jxr_javadoccomment"> *</em>
+<a name="164" href="#164">164</a> <em class="jxr_javadoccomment"> * @param stream stream to be read</em>
+<a name="165" href="#165">165</a> <em class="jxr_javadoccomment"> * @return first {@link #getMinLength()} (or fewer) bytes of the stream</em>
+<a name="166" href="#166">166</a> <em class="jxr_javadoccomment"> * @throws IOException if the stream can not be read</em>
+<a name="167" href="#167">167</a> <em class="jxr_javadoccomment"> */</em>
+<a name="168" href="#168">168</a> <strong class="jxr_keyword">private</strong> byte[] readMagicHeader(InputStream stream) <strong class="jxr_keyword">throws</strong> IOException {
+<a name="169" href="#169">169</a> assert stream != <strong class="jxr_keyword">null</strong>;
+<a name="170" href="#170">170</a>
+<a name="171" href="#171">171</a> byte[] bytes = <strong class="jxr_keyword">new</strong> byte[getMinLength()];
+<a name="172" href="#172">172</a> <strong class="jxr_keyword">int</strong> totalRead = 0;
+<a name="173" href="#173">173</a>
+<a name="174" href="#174">174</a> <strong class="jxr_keyword">int</strong> lastRead = stream.read(bytes);
+<a name="175" href="#175">175</a> <strong class="jxr_keyword">while</strong> (lastRead != -1) {
+<a name="176" href="#176">176</a> totalRead += lastRead;
+<a name="177" href="#177">177</a> <strong class="jxr_keyword">if</strong> (totalRead == bytes.length) {
+<a name="178" href="#178">178</a> <strong class="jxr_keyword">return</strong> bytes;
+<a name="179" href="#179">179</a> }
+<a name="180" href="#180">180</a> lastRead = stream.read(bytes, totalRead, bytes.length - totalRead);
+<a name="181" href="#181">181</a> }
+<a name="182" href="#182">182</a>
+<a name="183" href="#183">183</a> byte[] shorter = <strong class="jxr_keyword">new</strong> byte[totalRead];
+<a name="184" href="#184">184</a> System.arraycopy(bytes, 0, shorter, 0, totalRead);
+<a name="185" href="#185">185</a> <strong class="jxr_keyword">return</strong> shorter;
+<a name="186" href="#186">186</a> }
+<a name="187" href="#187">187</a>
+<a name="188" href="#188">188</a> <strong class="jxr_keyword">public</strong> String getType(String typeName, String url, byte[] data) {
+<a name="189" href="#189">189</a> <a href="../../../../org/apache/tika/mime/MimeType.html">MimeType</a> type = getMimeType(url, data);
+<a name="190" href="#190">190</a>
+<a name="191" href="#191">191</a> <strong class="jxr_keyword">if</strong> (type == <strong class="jxr_keyword">null</strong> && typeName != <strong class="jxr_keyword">null</strong>) {
+<a name="192" href="#192">192</a> <strong class="jxr_keyword">try</strong> {
+<a name="193" href="#193">193</a> type = forName(typeName);
+<a name="194" href="#194">194</a> } <strong class="jxr_keyword">catch</strong> (MimeTypeException e) {
+<a name="195" href="#195">195</a> <em class="jxr_comment">// Invalid type name hint</em>
+<a name="196" href="#196">196</a> }
+<a name="197" href="#197">197</a> }
+<a name="198" href="#198">198</a>
+<a name="199" href="#199">199</a> <strong class="jxr_keyword">if</strong> (type == <strong class="jxr_keyword">null</strong>) {
+<a name="200" href="#200">200</a> type = root;
+<a name="201" href="#201">201</a> }
+<a name="202" href="#202">202</a>
+<a name="203" href="#203">203</a> <strong class="jxr_keyword">return</strong> type.getName();
+<a name="204" href="#204">204</a> }
+<a name="205" href="#205">205</a>
+<a name="206" href="#206">206</a> <em class="jxr_javadoccomment">/**</em>
+<a name="207" href="#207">207</a> <em class="jxr_javadoccomment"> * Determines the MIME type of the resource pointed to by the specified URL.</em>
+<a name="208" href="#208">208</a> <em class="jxr_javadoccomment"> * Examines the file's header, and if it cannot determine the MIME type</em>
+<a name="209" href="#209">209</a> <em class="jxr_javadoccomment"> * from the header, guesses the MIME type from the URL extension</em>
+<a name="210" href="#210">210</a> <em class="jxr_javadoccomment"> * (e.g. "pdf).</em>
+<a name="211" href="#211">211</a> <em class="jxr_javadoccomment"> *</em>
+<a name="212" href="#212">212</a> <em class="jxr_javadoccomment"> * @param url</em>
+<a name="213" href="#213">213</a> <em class="jxr_javadoccomment"> * @return</em>
+<a name="214" href="#214">214</a> <em class="jxr_javadoccomment"> * @throws IOException</em>
+<a name="215" href="#215">215</a> <em class="jxr_javadoccomment"> */</em>
+<a name="216" href="#216">216</a> <strong class="jxr_keyword">public</strong> String getType(URL url) <strong class="jxr_keyword">throws</strong> IOException {
+<a name="217" href="#217">217</a> InputStream stream = url.openStream();
+<a name="218" href="#218">218</a> <strong class="jxr_keyword">try</strong> {
+<a name="219" href="#219">219</a> <strong class="jxr_keyword">return</strong> getType(<strong class="jxr_keyword">null</strong>, url.toString(), readMagicHeader(stream));
+<a name="220" href="#220">220</a> } <strong class="jxr_keyword">finally</strong> {
+<a name="221" href="#221">221</a> stream.close();
+<a name="222" href="#222">222</a> }
+<a name="223" href="#223">223</a> }
+<a name="224" href="#224">224</a>
+<a name="225" href="#225">225</a> <em class="jxr_javadoccomment">/**</em>
+<a name="226" href="#226">226</a> <em class="jxr_javadoccomment"> * Find the Mime Content Type of a document from its name and its content.</em>
+<a name="227" href="#227">227</a> <em class="jxr_javadoccomment"> * The policy used to guess the Mime Content Type is:</em>
+<a name="228" href="#228">228</a> <em class="jxr_javadoccomment"> * <ol></em>
+<a name="229" href="#229">229</a> <em class="jxr_javadoccomment"> * <li>Try to find the type based on the provided data.</li></em>
+<a name="230" href="#230">230</a> <em class="jxr_javadoccomment"> * <li>If a type is found, then return it, otherwise try to find the type</em>
+<a name="231" href="#231">231</a> <em class="jxr_javadoccomment"> * based on the file name</li></em>
+<a name="232" href="#232">232</a> <em class="jxr_javadoccomment"> * </ol></em>
+<a name="233" href="#233">233</a> <em class="jxr_javadoccomment"> * </em>
+<a name="234" href="#234">234</a> <em class="jxr_javadoccomment"> * @param name</em>
+<a name="235" href="#235">235</a> <em class="jxr_javadoccomment"> * of the document to analyze.</em>
+<a name="236" href="#236">236</a> <em class="jxr_javadoccomment"> * @param data</em>
+<a name="237" href="#237">237</a> <em class="jxr_javadoccomment"> * are the first bytes of the document's content.</em>
+<a name="238" href="#238">238</a> <em class="jxr_javadoccomment"> * @return the Mime Content Type of the specified document, or</em>
+<a name="239" href="#239">239</a> <em class="jxr_javadoccomment"> * <code>null</code> if none is found.</em>
+<a name="240" href="#240">240</a> <em class="jxr_javadoccomment"> * @see #getMinLength()</em>
+<a name="241" href="#241">241</a> <em class="jxr_javadoccomment"> */</em>
+<a name="242" href="#242">242</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/tika/mime/MimeType.html">MimeType</a> getMimeType(String name, byte[] data) {
+<a name="243" href="#243">243</a> <em class="jxr_comment">// First, try to get the mime-type from the content</em>
+<a name="244" href="#244">244</a> <a href="../../../../org/apache/tika/mime/MimeType.html">MimeType</a> mimeType = getMimeType(data);
+<a name="245" href="#245">245</a>
+<a name="246" href="#246">246</a> <em class="jxr_comment">// If no mime-type found, then try to get the mime-type from</em>
+<a name="247" href="#247">247</a> <em class="jxr_comment">// the document name</em>
+<a name="248" href="#248">248</a> <strong class="jxr_keyword">if</strong> (mimeType == <strong class="jxr_keyword">null</strong>) {
+<a name="249" href="#249">249</a> mimeType = getMimeType(name);
+<a name="250" href="#250">250</a> }
+<a name="251" href="#251">251</a>
+<a name="252" href="#252">252</a> <strong class="jxr_keyword">return</strong> mimeType;
+<a name="253" href="#253">253</a> }
+<a name="254" href="#254">254</a>
+<a name="255" href="#255">255</a> <em class="jxr_javadoccomment">/**</em>
+<a name="256" href="#256">256</a> <em class="jxr_javadoccomment"> * Returns the MIME type that best matches the given document name and</em>
+<a name="257" href="#257">257</a> <em class="jxr_javadoccomment"> * the first few bytes of the given document stream.</em>
+<a name="258" href="#258">258</a> <em class="jxr_javadoccomment"> *</em>
+<a name="259" href="#259">259</a> <em class="jxr_javadoccomment"> * @see #getMimeType(String, byte[])</em>
+<a name="260" href="#260">260</a> <em class="jxr_javadoccomment"> * @param name document name</em>
+<a name="261" href="#261">261</a> <em class="jxr_javadoccomment"> * @param stream document stream</em>
+<a name="262" href="#262">262</a> <em class="jxr_javadoccomment"> * @return matching MIME type, or <code>null</code> if no match is found</em>
+<a name="263" href="#263">263</a> <em class="jxr_javadoccomment"> * @throws IOException if the stream can not be read</em>
+<a name="264" href="#264">264</a> <em class="jxr_javadoccomment"> */</em>
+<a name="265" href="#265">265</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/tika/mime/MimeType.html">MimeType</a> getMimeType(String name, InputStream stream)
+<a name="266" href="#266">266</a> <strong class="jxr_keyword">throws</strong> IOException {
+<a name="267" href="#267">267</a> <strong class="jxr_keyword">return</strong> getMimeType(name, readMagicHeader(stream));
+<a name="268" href="#268">268</a> }
+<a name="269" href="#269">269</a>
+<a name="270" href="#270">270</a> <em class="jxr_javadoccomment">/**</em>
+<a name="271" href="#271">271</a> <em class="jxr_javadoccomment"> * Returns the registered media type with the given name (or alias).</em>
+<a name="272" href="#272">272</a> <em class="jxr_javadoccomment"> * The named media type is automatically registered (and returned) if</em>
+<a name="273" href="#273">273</a> <em class="jxr_javadoccomment"> * it doesn't already exist.</em>
+<a name="274" href="#274">274</a> <em class="jxr_javadoccomment"> *</em>
+<a name="275" href="#275">275</a> <em class="jxr_javadoccomment"> * @param name media type name (case-insensitive)</em>
+<a name="276" href="#276">276</a> <em class="jxr_javadoccomment"> * @return the registered media type with the given name or alias</em>
+<a name="277" href="#277">277</a> <em class="jxr_javadoccomment"> * @throws MimeTypeException if the given media type name is invalid</em>
+<a name="278" href="#278">278</a> <em class="jxr_javadoccomment"> */</em>
+<a name="279" href="#279">279</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">synchronized</strong> <a href="../../../../org/apache/tika/mime/MimeType.html">MimeType</a> forName(String name)
+<a name="280" href="#280">280</a> <strong class="jxr_keyword">throws</strong> <a href="../../../../org/apache/tika/mime/MimeTypeException.html">MimeTypeException</a> {
+<a name="281" href="#281">281</a> <strong class="jxr_keyword">if</strong> (MimeType.isValid(name)) {
+<a name="282" href="#282">282</a> name = name.toLowerCase();
+<a name="283" href="#283">283</a> <a href="../../../../org/apache/tika/mime/MimeType.html">MimeType</a> type = types.get(name);
+<a name="284" href="#284">284</a> <strong class="jxr_keyword">if</strong> (type == <strong class="jxr_keyword">null</strong>) {
+<a name="285" href="#285">285</a> type = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/tika/mime/MimeType.html">MimeType</a>(<strong class="jxr_keyword">this</strong>, name);
+<a name="286" href="#286">286</a> type.setSuperType(root);
+<a name="287" href="#287">287</a> types.put(name, type);
+<a name="288" href="#288">288</a> }
+<a name="289" href="#289">289</a> <strong class="jxr_keyword">return</strong> type;
+<a name="290" href="#290">290</a> } <strong class="jxr_keyword">else</strong> {
+<a name="291" href="#291">291</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/tika/mime/MimeTypeException.html">MimeTypeException</a>(<span class="jxr_string">"Invalid media type name: "</span> + name);
+<a name="292" href="#292">292</a> }
+<a name="293" href="#293">293</a> }
+<a name="294" href="#294">294</a>
+<a name="295" href="#295">295</a> <em class="jxr_javadoccomment">/**</em>
+<a name="296" href="#296">296</a> <em class="jxr_javadoccomment"> * Adds an alias for the given media type. This method should only</em>
+<a name="297" href="#297">297</a> <em class="jxr_javadoccomment"> * be called from {@link MimeType#addAlias(String)}.</em>
+<a name="298" href="#298">298</a> <em class="jxr_javadoccomment"> *</em>
+<a name="299" href="#299">299</a> <em class="jxr_javadoccomment"> * @param type media type</em>
+<a name="300" href="#300">300</a> <em class="jxr_javadoccomment"> * @param alias media type alias (normalized to lower case)</em>
+<a name="301" href="#301">301</a> <em class="jxr_javadoccomment"> * @throws MimeTypeException if the alias already exists</em>
+<a name="302" href="#302">302</a> <em class="jxr_javadoccomment"> */</em>
+<a name="303" href="#303">303</a> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">void</strong> addAlias(<a href="../../../../org/apache/tika/mime/MimeType.html">MimeType</a> type, String alias)
+<a name="304" href="#304">304</a> <strong class="jxr_keyword">throws</strong> <a href="../../../../org/apache/tika/mime/MimeTypeException.html">MimeTypeException</a> {
+<a name="305" href="#305">305</a> <strong class="jxr_keyword">if</strong> (!types.containsKey(alias)) {
+<a name="306" href="#306">306</a> types.put(alias, type);
+<a name="307" href="#307">307</a> } <strong class="jxr_keyword">else</strong> {
+<a name="308" href="#308">308</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/tika/mime/MimeTypeException.html">MimeTypeException</a>(
+<a name="309" href="#309">309</a> <span class="jxr_string">"Media type alias already exists: "</span> + alias);
+<a name="310" href="#310">310</a> }
+<a name="311" href="#311">311</a> }
+<a name="312" href="#312">312</a>
+<a name="313" href="#313">313</a> <em class="jxr_javadoccomment">/**</em>
+<a name="314" href="#314">314</a> <em class="jxr_javadoccomment"> * Adds a file name pattern for the given media type.</em>
+<a name="315" href="#315">315</a> <em class="jxr_javadoccomment"> *</em>
+<a name="316" href="#316">316</a> <em class="jxr_javadoccomment"> * @param type media type</em>
+<a name="317" href="#317">317</a> <em class="jxr_javadoccomment"> * @param pattern file name pattern</em>
+<a name="318" href="#318">318</a> <em class="jxr_javadoccomment"> * @throws MimeTypeException if the pattern conflicts with existing ones</em>
+<a name="319" href="#319">319</a> <em class="jxr_javadoccomment"> */</em>
+<a name="320" href="#320">320</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> addPattern(<a href="../../../../org/apache/tika/mime/MimeType.html">MimeType</a> type, String pattern)
+<a name="321" href="#321">321</a> <strong class="jxr_keyword">throws</strong> <a href="../../../../org/apache/tika/mime/MimeTypeException.html">MimeTypeException</a> {
+<a name="322" href="#322">322</a> patterns.add(pattern, type);
+<a name="323" href="#323">323</a> }
+<a name="324" href="#324">324</a>
+<a name="325" href="#325">325</a> <em class="jxr_javadoccomment">/**</em>
+<a name="326" href="#326">326</a> <em class="jxr_javadoccomment"> * Return the minimum length of data to provide to analyzing methods based</em>
+<a name="327" href="#327">327</a> <em class="jxr_javadoccomment"> * on the document's content in order to check all the known MimeTypes.</em>
+<a name="328" href="#328">328</a> <em class="jxr_javadoccomment"> * </em>
+<a name="329" href="#329">329</a> <em class="jxr_javadoccomment"> * @return the minimum length of data to provide.</em>
+<a name="330" href="#330">330</a> <em class="jxr_javadoccomment"> * @see #getMimeType(byte[])</em>
+<a name="331" href="#331">331</a> <em class="jxr_javadoccomment"> * @see #getMimeType(String, byte[])</em>
+<a name="332" href="#332">332</a> <em class="jxr_javadoccomment"> */</em>
+<a name="333" href="#333">333</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getMinLength() {
+<a name="334" href="#334">334</a> <strong class="jxr_keyword">return</strong> 1024;
+<a name="335" href="#335">335</a> <em class="jxr_comment">// return minLength;</em>
+<a name="336" href="#336">336</a> }
+<a name="337" href="#337">337</a>
+<a name="338" href="#338">338</a> <em class="jxr_javadoccomment">/**</em>
+<a name="339" href="#339">339</a> <em class="jxr_javadoccomment"> * Add the specified mime-type in the repository.</em>
+<a name="340" href="#340">340</a> <em class="jxr_javadoccomment"> * </em>
+<a name="341" href="#341">341</a> <em class="jxr_javadoccomment"> * @param type</em>
+<a name="342" href="#342">342</a> <em class="jxr_javadoccomment"> * is the mime-type to add.</em>
+<a name="343" href="#343">343</a> <em class="jxr_javadoccomment"> */</em>
+<a name="344" href="#344">344</a> <strong class="jxr_keyword">void</strong> add(<a href="../../../../org/apache/tika/mime/MimeType.html">MimeType</a> type) {
+<a name="345" href="#345">345</a> <em class="jxr_comment">// Update the magics index...</em>
+<a name="346" href="#346">346</a> <strong class="jxr_keyword">if</strong> (type.hasMagic()) {
+<a name="347" href="#347">347</a> magics.addAll(Arrays.asList(type.getMagics()));
+<a name="348" href="#348">348</a> }
+<a name="349" href="#349">349</a>
+<a name="350" href="#350">350</a> <em class="jxr_comment">// Update the xml (xmlRoot) index...</em>
+<a name="351" href="#351">351</a> <strong class="jxr_keyword">if</strong> (type.hasRootXML()) {
+<a name="352" href="#352">352</a> xmls.add(type);
+<a name="353" href="#353">353</a> }
+<a name="354" href="#354">354</a> }
+<a name="355" href="#355">355</a>
+<a name="356" href="#356">356</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+
Added: incubator/tika/site/xref/org/apache/tika/mime/MimeTypesFactory.html
URL: http://svn.apache.org/viewvc/incubator/tika/site/xref/org/apache/tika/mime/MimeTypesFactory.html?rev=596146&view=auto
==============================================================================
--- incubator/tika/site/xref/org/apache/tika/mime/MimeTypesFactory.html (added)
+++ incubator/tika/site/xref/org/apache/tika/mime/MimeTypesFactory.html Sun Nov 18 14:20:54 2007
@@ -0,0 +1,99 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+<title>MimeTypesFactory xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../apidocs/org/apache/tika/mime/MimeTypesFactory.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a> <em class="jxr_javadoccomment">/**</em>
+<a name="2" href="#2">2</a> <em class="jxr_javadoccomment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
+<a name="3" href="#3">3</a> <em class="jxr_javadoccomment"> * contributor license agreements. See the NOTICE file distributed with</em>
+<a name="4" href="#4">4</a> <em class="jxr_javadoccomment"> * this work for additional information regarding copyright ownership.</em>
+<a name="5" href="#5">5</a> <em class="jxr_javadoccomment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em>
+<a name="6" href="#6">6</a> <em class="jxr_javadoccomment"> * (the "License"); you may not use this file except in compliance with</em>
+<a name="7" href="#7">7</a> <em class="jxr_javadoccomment"> * the License. You may obtain a copy of the License at</em>
+<a name="8" href="#8">8</a> <em class="jxr_javadoccomment"> *</em>
+<a name="9" href="#9">9</a> <em class="jxr_javadoccomment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
+<a name="10" href="#10">10</a> <em class="jxr_javadoccomment"> *</em>
+<a name="11" href="#11">11</a> <em class="jxr_javadoccomment"> * Unless required by applicable law or agreed to in writing, software</em>
+<a name="12" href="#12">12</a> <em class="jxr_javadoccomment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
+<a name="13" href="#13">13</a> <em class="jxr_javadoccomment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
+<a name="14" href="#14">14</a> <em class="jxr_javadoccomment"> * See the License for the specific language governing permissions and</em>
+<a name="15" href="#15">15</a> <em class="jxr_javadoccomment"> * limitations under the License.</em>
+<a name="16" href="#16">16</a> <em class="jxr_javadoccomment"> */</em>
+<a name="17" href="#17">17</a> <strong class="jxr_keyword">package</strong> org.apache.tika.mime;
+<a name="18" href="#18">18</a>
+<a name="19" href="#19">19</a> <strong class="jxr_keyword">import</strong> java.io.InputStream;
+<a name="20" href="#20">20</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
+<a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> java.net.URL;
+<a name="22" href="#22">22</a>
+<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Document;
+<a name="24" href="#24">24</a>
+<a name="25" href="#25">25</a>
+<a name="26" href="#26">26</a> <em class="jxr_javadoccomment">/**</em>
+<a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * Creates instances of MimeTypes.</em>
+<a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> */</em>
+<a name="29" href="#29">29</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/tika/mime/MimeTypesFactory.html">MimeTypesFactory</a> {
+<a name="30" href="#30">30</a>
+<a name="31" href="#31">31</a>
+<a name="32" href="#32">32</a> <em class="jxr_javadoccomment">/**</em>
+<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * Creates an empty instance; same as calling new MimeTypes().</em>
+<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> *</em>
+<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * @return an empty instance</em>
+<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> */</em>
+<a name="37" href="#37">37</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../org/apache/tika/mime/MimeTypes.html">MimeTypes</a> create() {
+<a name="38" href="#38">38</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/tika/mime/MimeTypes.html">MimeTypes</a>();
+<a name="39" href="#39">39</a> }
+<a name="40" href="#40">40</a>
+<a name="41" href="#41">41</a> <em class="jxr_javadoccomment">/**</em>
+<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * Creates and returns a MimeTypes instance from the specified document.</em>
+<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> */</em>
+<a name="44" href="#44">44</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../org/apache/tika/mime/MimeTypes.html">MimeTypes</a> create(Document document) {
+<a name="45" href="#45">45</a> <a href="../../../../org/apache/tika/mime/MimeTypes.html">MimeTypes</a> mimeTypes = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/tika/mime/MimeTypes.html">MimeTypes</a>();
+<a name="46" href="#46">46</a> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/tika/mime/MimeTypesReader.html">MimeTypesReader</a>(mimeTypes).read(document);
+<a name="47" href="#47">47</a> <strong class="jxr_keyword">return</strong> mimeTypes;
+<a name="48" href="#48">48</a> }
+<a name="49" href="#49">49</a>
+<a name="50" href="#50">50</a> <em class="jxr_javadoccomment">/**</em>
+<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * Creates and returns a MimeTypes instance from the specified input stream.</em>
+<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * Does not close the input stream.</em>
+<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> */</em>
+<a name="54" href="#54">54</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../org/apache/tika/mime/MimeTypes.html">MimeTypes</a> create(InputStream inputStream) {
+<a name="55" href="#55">55</a> <a href="../../../../org/apache/tika/mime/MimeTypes.html">MimeTypes</a> mimeTypes = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/tika/mime/MimeTypes.html">MimeTypes</a>();
+<a name="56" href="#56">56</a> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/tika/mime/MimeTypesReader.html">MimeTypesReader</a>(mimeTypes).read(inputStream);
+<a name="57" href="#57">57</a> <strong class="jxr_keyword">return</strong> mimeTypes;
+<a name="58" href="#58">58</a> }
+<a name="59" href="#59">59</a>
+<a name="60" href="#60">60</a> <em class="jxr_javadoccomment">/**</em>
+<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * Creates and returns a MimeTypes instance from the resource</em>
+<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * at the location specified by the URL. Opens and closes the</em>
+<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * InputStream from the URL.</em>
+<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> */</em>
+<a name="65" href="#65">65</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../org/apache/tika/mime/MimeTypes.html">MimeTypes</a> create(URL url) <strong class="jxr_keyword">throws</strong> IOException {
+<a name="66" href="#66">66</a> InputStream inputStream = <strong class="jxr_keyword">null</strong>;
+<a name="67" href="#67">67</a>
+<a name="68" href="#68">68</a> <strong class="jxr_keyword">try</strong> {
+<a name="69" href="#69">69</a> inputStream = url.openStream();
+<a name="70" href="#70">70</a> <strong class="jxr_keyword">return</strong> create(inputStream);
+<a name="71" href="#71">71</a> } <strong class="jxr_keyword">finally</strong> {
+<a name="72" href="#72">72</a> <strong class="jxr_keyword">if</strong> (inputStream != <strong class="jxr_keyword">null</strong>) {
+<a name="73" href="#73">73</a> inputStream.close();
+<a name="74" href="#74">74</a> }
+<a name="75" href="#75">75</a> }
+<a name="76" href="#76">76</a> }
+<a name="77" href="#77">77</a>
+<a name="78" href="#78">78</a> <em class="jxr_javadoccomment">/**</em>
+<a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * Creates and returns a MimeTypes instance from the specified file path,</em>
+<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * as interpreted by the class loader in getResource().</em>
+<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> */</em>
+<a name="82" href="#82">82</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../org/apache/tika/mime/MimeTypes.html">MimeTypes</a> create(String filePath) <strong class="jxr_keyword">throws</strong> IOException {
+<a name="83" href="#83">83</a> <strong class="jxr_keyword">return</strong> create(MimeTypesReader.<strong class="jxr_keyword">class</strong>.getResource(filePath));
+<a name="84" href="#84">84</a> }
+<a name="85" href="#85">85</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+
Added: incubator/tika/site/xref/org/apache/tika/mime/MimeTypesReader.html
URL: http://svn.apache.org/viewvc/incubator/tika/site/xref/org/apache/tika/mime/MimeTypesReader.html?rev=596146&view=auto
==============================================================================
--- incubator/tika/site/xref/org/apache/tika/mime/MimeTypesReader.html (added)
+++ incubator/tika/site/xref/org/apache/tika/mime/MimeTypesReader.html Sun Nov 18 14:20:54 2007
@@ -0,0 +1,295 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+<title>MimeTypesReader xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../apidocs/org/apache/tika/mime/MimeTypesReader.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a> <em class="jxr_javadoccomment">/**</em>
+<a name="2" href="#2">2</a> <em class="jxr_javadoccomment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
+<a name="3" href="#3">3</a> <em class="jxr_javadoccomment"> * contributor license agreements. See the NOTICE file distributed with</em>
+<a name="4" href="#4">4</a> <em class="jxr_javadoccomment"> * this work for additional information regarding copyright ownership.</em>
+<a name="5" href="#5">5</a> <em class="jxr_javadoccomment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em>
+<a name="6" href="#6">6</a> <em class="jxr_javadoccomment"> * (the "License"); you may not use this file except in compliance with</em>
+<a name="7" href="#7">7</a> <em class="jxr_javadoccomment"> * the License. You may obtain a copy of the License at</em>
+<a name="8" href="#8">8</a> <em class="jxr_javadoccomment"> *</em>
+<a name="9" href="#9">9</a> <em class="jxr_javadoccomment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
+<a name="10" href="#10">10</a> <em class="jxr_javadoccomment"> *</em>
+<a name="11" href="#11">11</a> <em class="jxr_javadoccomment"> * Unless required by applicable law or agreed to in writing, software</em>
+<a name="12" href="#12">12</a> <em class="jxr_javadoccomment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
+<a name="13" href="#13">13</a> <em class="jxr_javadoccomment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
+<a name="14" href="#14">14</a> <em class="jxr_javadoccomment"> * See the License for the specific language governing permissions and</em>
+<a name="15" href="#15">15</a> <em class="jxr_javadoccomment"> * limitations under the License.</em>
+<a name="16" href="#16">16</a> <em class="jxr_javadoccomment"> */</em>
+<a name="17" href="#17">17</a> <strong class="jxr_keyword">package</strong> org.apache.tika.mime;
+<a name="18" href="#18">18</a>
+<a name="19" href="#19">19</a> <em class="jxr_comment">// Commons Logging imports</em>
+<a name="20" href="#20">20</a> <strong class="jxr_keyword">import</strong> org.apache.commons.logging.Log;
+<a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.commons.logging.LogFactory;
+<a name="22" href="#22">22</a>
+<a name="23" href="#23">23</a> <em class="jxr_comment">// DOM imports</em>
+<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Attr;
+<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Node;
+<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Element;
+<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Document;
+<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.NodeList;
+<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.NamedNodeMap;
+<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.xml.sax.InputSource;
+<a name="31" href="#31">31</a>
+<a name="32" href="#32">32</a> <em class="jxr_comment">// JDK imports</em>
+<a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> java.io.InputStream;
+<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> javax.xml.parsers.DocumentBuilder;
+<a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> javax.xml.parsers.DocumentBuilderFactory;
+<a name="36" href="#36">36</a>
+<a name="37" href="#37">37</a> <em class="jxr_javadoccomment">/**</em>
+<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * A reader for XML files compliant with the freedesktop MIME-info DTD.</em>
+<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * </em>
+<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * <pre></em>
+<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * &lt;!DOCTYPE mime-info [</em>
+<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * &lt;!ELEMENT mime-info (mime-type)+&gt;</em>
+<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * &lt;!ATTLIST mime-info xmlns CDATA #FIXED &quot;<a href="http://www.freedesktop.org/standards/shared-mime-info&quot;&gt;" target="alexandria_uri">http://www.freedesktop.org/standards/shared-mime-info&quot;&gt;</a></em>
+<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * </em>
+<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * &lt;!ELEMENT mime-type (comment|acronym|expanded-acronym|glob|magic|root-XML|alias|sub-class-of)*&gt;</em>
+<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * &lt;!ATTLIST mime-type type CDATA #REQUIRED&gt;</em>
+<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * </em>
+<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * &lt;!-- a comment describing a document with the respective MIME type. Example: &quot;WMV video&quot; --&gt;</em>
+<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * &lt;!ELEMENT comment (#PCDATA)&gt;</em>
+<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * &lt;!ATTLIST comment xml:lang CDATA #IMPLIED&gt;</em>
+<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * </em>
+<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * &lt;!-- a comment describing a the respective unexpanded MIME type acronym. Example: &quot;WMV&quot; --&gt;</em>
+<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * &lt;!ELEMENT acronym (#PCDATA)&gt;</em>
+<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * &lt;!ATTLIST acronym xml:lang CDATA #IMPLIED&gt;</em>
+<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * </em>
+<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * &lt;!-- a comment describing a the respective unexpanded MIME type acronym. Example: &quot;Windows Media Video&quot; --&gt;</em>
+<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * &lt;!ELEMENT expanded-acronym (#PCDATA)&gt;</em>
+<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * &lt;!ATTLIST expanded-acronym xml:lang CDATA #IMPLIED&gt;</em>
+<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * </em>
+<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * &lt;!ELEMENT glob EMPTY&gt;</em>
+<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * &lt;!ATTLIST glob pattern CDATA #REQUIRED&gt;</em>
+<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * </em>
+<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * &lt;!ELEMENT magic (match)+&gt;</em>
+<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * &lt;!ATTLIST magic priority CDATA #IMPLIED&gt;</em>
+<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * </em>
+<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * &lt;!ELEMENT match (match)*&gt;</em>
+<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * &lt;!ATTLIST match offset CDATA #REQUIRED&gt;</em>
+<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * &lt;!ATTLIST match type (string|big16|big32|little16|little32|host16|host32|byte) #REQUIRED&gt;</em>
+<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * &lt;!ATTLIST match value CDATA #REQUIRED&gt;</em>
+<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * &lt;!ATTLIST match mask CDATA #IMPLIED&gt;</em>
+<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * </em>
+<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * &lt;!ELEMENT root-XML EMPTY&gt;</em>
+<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * &lt;!ATTLIST root-XML</em>
+<a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * namespaceURI CDATA #REQUIRED</em>
+<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * localName CDATA #REQUIRED&gt;</em>
+<a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * </em>
+<a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * &lt;!ELEMENT alias EMPTY&gt;</em>
+<a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * &lt;!ATTLIST alias</em>
+<a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * type CDATA #REQUIRED&gt;</em>
+<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * </em>
+<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * &lt;!ELEMENT sub-class-of EMPTY&gt;</em>
+<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * &lt;!ATTLIST sub-class-of</em>
+<a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * type CDATA #REQUIRED&gt;</em>
+<a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * ]&gt;</em>
+<a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * </pre></em>
+<a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * </em>
+<a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * </em>
+<a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * @see <a href="http://freedesktop.org/wiki/Standards_2fshared_2dmime_2dinfo_2dspec" target="alexandria_uri">http://freedesktop.org/wiki/Standards_2fshared_2dmime_2dinfo_2dspec</a></em>
+<a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * </em>
+<a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> */</em>
+<a name="91" href="#91">91</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/tika/mime/MimeTypesReader.html">MimeTypesReader</a> {
+<a name="92" href="#92">92</a>
+<a name="93" href="#93">93</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The logger to use */</em>
+<a name="94" href="#94">94</a> <strong class="jxr_keyword">private</strong> Log logger = <strong class="jxr_keyword">null</strong>;
+<a name="95" href="#95">95</a>
+<a name="96" href="#96">96</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../org/apache/tika/mime/MimeTypes.html">MimeTypes</a> types;
+<a name="97" href="#97">97</a>
+<a name="98" href="#98">98</a> <a href="../../../../org/apache/tika/mime/MimeTypesReader.html">MimeTypesReader</a>(<a href="../../../../org/apache/tika/mime/MimeTypes.html">MimeTypes</a> types) {
+<a name="99" href="#99">99</a> <strong class="jxr_keyword">this</strong>(types, <strong class="jxr_keyword">null</strong>);
+<a name="100" href="#100">100</a> }
+<a name="101" href="#101">101</a>
+<a name="102" href="#102">102</a> <a href="../../../../org/apache/tika/mime/MimeTypesReader.html">MimeTypesReader</a>(<a href="../../../../org/apache/tika/mime/MimeTypes.html">MimeTypes</a> types, Log logger) {
+<a name="103" href="#103">103</a> <strong class="jxr_keyword">this</strong>.types = types;
+<a name="104" href="#104">104</a> <strong class="jxr_keyword">if</strong> (logger == <strong class="jxr_keyword">null</strong>) {
+<a name="105" href="#105">105</a> <strong class="jxr_keyword">this</strong>.logger = LogFactory.getLog(<strong class="jxr_keyword">this</strong>.getClass());
+<a name="106" href="#106">106</a> } <strong class="jxr_keyword">else</strong> {
+<a name="107" href="#107">107</a> <strong class="jxr_keyword">this</strong>.logger = logger;
+<a name="108" href="#108">108</a> }
+<a name="109" href="#109">109</a> }
+<a name="110" href="#110">110</a>
+<a name="111" href="#111">111</a> <strong class="jxr_keyword">void</strong> read(String filepath) {
+<a name="112" href="#112">112</a> read(MimeTypesReader.<strong class="jxr_keyword">class</strong>.getClassLoader().getResourceAsStream(filepath));
+<a name="113" href="#113">113</a> }
+<a name="114" href="#114">114</a>
+<a name="115" href="#115">115</a> <strong class="jxr_keyword">void</strong> read(InputStream stream) {
+<a name="116" href="#116">116</a> <strong class="jxr_keyword">try</strong> {
+<a name="117" href="#117">117</a> DocumentBuilderFactory factory = DocumentBuilderFactory
+<a name="118" href="#118">118</a> .newInstance();
+<a name="119" href="#119">119</a> DocumentBuilder builder = factory.newDocumentBuilder();
+<a name="120" href="#120">120</a> Document document = builder.parse(<strong class="jxr_keyword">new</strong> InputSource(stream));
+<a name="121" href="#121">121</a> read(document);
+<a name="122" href="#122">122</a> } <strong class="jxr_keyword">catch</strong> (Exception e) {
+<a name="123" href="#123">123</a> <strong class="jxr_keyword">if</strong> (logger.isWarnEnabled()) {
+<a name="124" href="#124">124</a> logger.warn(e.toString() + <span class="jxr_string">" while loading mime-types"</span>);
+<a name="125" href="#125">125</a> }
+<a name="126" href="#126">126</a> }
+<a name="127" href="#127">127</a> }
+<a name="128" href="#128">128</a>
+<a name="129" href="#129">129</a> <strong class="jxr_keyword">void</strong> read(Document document) {
+<a name="130" href="#130">130</a> Element element = document.getDocumentElement();
+<a name="131" href="#131">131</a> <strong class="jxr_keyword">if</strong> (element != <strong class="jxr_keyword">null</strong> && element.getTagName().equals(<span class="jxr_string">"mime-info"</span>)) {
+<a name="132" href="#132">132</a> NodeList nodes = element.getChildNodes();
+<a name="133" href="#133">133</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < nodes.getLength(); i++) {
+<a name="134" href="#134">134</a> Node node = nodes.item(i);
+<a name="135" href="#135">135</a> <strong class="jxr_keyword">if</strong> (node.getNodeType() == Node.ELEMENT_NODE) {
+<a name="136" href="#136">136</a> Element child = (Element) node;
+<a name="137" href="#137">137</a> <strong class="jxr_keyword">if</strong> (child.getTagName().equals(<span class="jxr_string">"mime-type"</span>)) {
+<a name="138" href="#138">138</a> readMimeType(child);
+<a name="139" href="#139">139</a> }
+<a name="140" href="#140">140</a> }
+<a name="141" href="#141">141</a> }
+<a name="142" href="#142">142</a> } <strong class="jxr_keyword">else</strong> {
+<a name="143" href="#143">143</a> logger.warn(<span class="jxr_string">"Not a <mime-info/> configuration document"</span>);
+<a name="144" href="#144">144</a> }
+<a name="145" href="#145">145</a> }
+<a name="146" href="#146">146</a>
+<a name="147" href="#147">147</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Read Element named mime-type. */</em>
+<a name="148" href="#148">148</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> readMimeType(Element element) {
+<a name="149" href="#149">149</a> String name = element.getAttribute(<span class="jxr_string">"type"</span>);
+<a name="150" href="#150">150</a> <strong class="jxr_keyword">try</strong> {
+<a name="151" href="#151">151</a> <a href="../../../../org/apache/tika/mime/MimeType.html">MimeType</a> type = types.forName(name);
+<a name="152" href="#152">152</a>
+<a name="153" href="#153">153</a> NodeList nodes = element.getChildNodes();
+<a name="154" href="#154">154</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < nodes.getLength(); i++) {
+<a name="155" href="#155">155</a> Node node = nodes.item(i);
+<a name="156" href="#156">156</a> <strong class="jxr_keyword">if</strong> (node.getNodeType() == Node.ELEMENT_NODE) {
+<a name="157" href="#157">157</a> Element nodeElement = (Element) node;
+<a name="158" href="#158">158</a> <strong class="jxr_keyword">if</strong> (nodeElement.getTagName().equals(<span class="jxr_string">"_comment"</span>)) {
+<a name="159" href="#159">159</a> type.setDescription(
+<a name="160" href="#160">160</a> nodeElement.getFirstChild().getNodeValue());
+<a name="161" href="#161">161</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (nodeElement.getTagName().equals(<span class="jxr_string">"glob"</span>)) {
+<a name="162" href="#162">162</a> types.addPattern(type, nodeElement.getAttribute(<span class="jxr_string">"pattern"</span>));
+<a name="163" href="#163">163</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (nodeElement.getTagName().equals(<span class="jxr_string">"magic"</span>)) {
+<a name="164" href="#164">164</a> readMagic(nodeElement, type);
+<a name="165" href="#165">165</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (nodeElement.getTagName().equals(<span class="jxr_string">"alias"</span>)) {
+<a name="166" href="#166">166</a> String alias = nodeElement.getAttribute(<span class="jxr_string">"type"</span>);
+<a name="167" href="#167">167</a> <strong class="jxr_keyword">try</strong> {
+<a name="168" href="#168">168</a> type.addAlias(alias);
+<a name="169" href="#169">169</a> } <strong class="jxr_keyword">catch</strong> (MimeTypeException e) {
+<a name="170" href="#170">170</a> logger.warn(<span class="jxr_string">"Invalid media type alias: "</span> + alias, e);
+<a name="171" href="#171">171</a> }
+<a name="172" href="#172">172</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (nodeElement.getTagName().equals(<span class="jxr_string">"root-XML"</span>)) {
+<a name="173" href="#173">173</a> readRootXML(nodeElement, type);
+<a name="174" href="#174">174</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (nodeElement.getTagName().equals(<span class="jxr_string">"sub-class-of"</span>)) {
+<a name="175" href="#175">175</a> String parent = nodeElement.getAttribute(<span class="jxr_string">"type"</span>);
+<a name="176" href="#176">176</a> <strong class="jxr_keyword">try</strong> {
+<a name="177" href="#177">177</a> type.setSuperType(types.forName(parent));
+<a name="178" href="#178">178</a> } <strong class="jxr_keyword">catch</strong> (MimeTypeException e) {
+<a name="179" href="#179">179</a> logger.warn(<span class="jxr_string">"Invalid parent type: "</span> + parent, e);
+<a name="180" href="#180">180</a> }
+<a name="181" href="#181">181</a> }
+<a name="182" href="#182">182</a> }
+<a name="183" href="#183">183</a> }
+<a name="184" href="#184">184</a>
+<a name="185" href="#185">185</a> types.add(type);
+<a name="186" href="#186">186</a> } <strong class="jxr_keyword">catch</strong> (MimeTypeException e) {
+<a name="187" href="#187">187</a> logger.warn(<span class="jxr_string">"Invalid media type configuration entry: "</span> + name, e);
+<a name="188" href="#188">188</a> }
+<a name="189" href="#189">189</a> }
+<a name="190" href="#190">190</a>
+<a name="191" href="#191">191</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Read Element named magic. */</em>
+<a name="192" href="#192">192</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> readMagic(Element element, <a href="../../../../org/apache/tika/mime/MimeType.html">MimeType</a> mimeType) {
+<a name="193" href="#193">193</a> <a href="../../../../org/apache/tika/mime/Magic.html">Magic</a> magic = <strong class="jxr_keyword">null</strong>;
+<a name="194" href="#194">194</a> <strong class="jxr_keyword">try</strong> {
+<a name="195" href="#195">195</a> magic = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/tika/mime/Magic.html">Magic</a>(Integer
+<a name="196" href="#196">196</a> .parseInt(element.getAttribute(<span class="jxr_string">"priority"</span>)));
+<a name="197" href="#197">197</a> } <strong class="jxr_keyword">catch</strong> (Exception e) {
+<a name="198" href="#198">198</a> magic = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/tika/mime/Magic.html">Magic</a>();
+<a name="199" href="#199">199</a> }
+<a name="200" href="#200">200</a> magic.setType(mimeType);
+<a name="201" href="#201">201</a> magic.setClause(readMatches(element));
+<a name="202" href="#202">202</a> mimeType.addMagic(magic);
+<a name="203" href="#203">203</a> }
+<a name="204" href="#204">204</a>
+<a name="205" href="#205">205</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/apache/tika/mime/Clause.html">Clause</a> readMatches(Element element) {
+<a name="206" href="#206">206</a> <a href="../../../../org/apache/tika/mime/Clause.html">Clause</a> sub = <strong class="jxr_keyword">null</strong>;
+<a name="207" href="#207">207</a> <a href="../../../../org/apache/tika/mime/Clause.html">Clause</a> prev = Clause.FALSE;
+<a name="208" href="#208">208</a> <a href="../../../../org/apache/tika/mime/Clause.html">Clause</a> clause = <strong class="jxr_keyword">null</strong>;
+<a name="209" href="#209">209</a> NodeList nodes = element.getChildNodes();
+<a name="210" href="#210">210</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < nodes.getLength(); i++) {
+<a name="211" href="#211">211</a> Node node = nodes.item(i);
+<a name="212" href="#212">212</a> <strong class="jxr_keyword">if</strong> (node.getNodeType() == Node.ELEMENT_NODE) {
+<a name="213" href="#213">213</a> Element nodeElement = (Element) node;
+<a name="214" href="#214">214</a> <strong class="jxr_keyword">if</strong> (nodeElement.getTagName().equals(<span class="jxr_string">"match"</span>)) {
+<a name="215" href="#215">215</a> sub = readMatches(nodeElement);
+<a name="216" href="#216">216</a> <strong class="jxr_keyword">try</strong> {
+<a name="217" href="#217">217</a> <strong class="jxr_keyword">if</strong> (sub != <strong class="jxr_keyword">null</strong>) {
+<a name="218" href="#218">218</a> clause = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/tika/mime/MagicClause.html">MagicClause</a>(Operator.AND,
+<a name="219" href="#219">219</a> readMatch(nodeElement), sub);
+<a name="220" href="#220">220</a> } <strong class="jxr_keyword">else</strong> {
+<a name="221" href="#221">221</a> clause = readMatch(nodeElement);
+<a name="222" href="#222">222</a> }
+<a name="223" href="#223">223</a> clause = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/tika/mime/MagicClause.html">MagicClause</a>(Operator.OR, prev, clause);
+<a name="224" href="#224">224</a> prev = clause;
+<a name="225" href="#225">225</a> } <strong class="jxr_keyword">catch</strong> (MimeTypeException mte) {
+<a name="226" href="#226">226</a> logger.warn(mte + <span class="jxr_string">" while reading magic-match ["</span>
+<a name="227" href="#227">227</a> + nodeElement + <span class="jxr_string">"], Ignoring!"</span>);
+<a name="228" href="#228">228</a> }
+<a name="229" href="#229">229</a> }
+<a name="230" href="#230">230</a> }
+<a name="231" href="#231">231</a> }
+<a name="232" href="#232">232</a> <strong class="jxr_keyword">return</strong> clause;
+<a name="233" href="#233">233</a> }
+<a name="234" href="#234">234</a>
+<a name="235" href="#235">235</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Read Element named match. */</em>
+<a name="236" href="#236">236</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/apache/tika/mime/MagicMatch.html">MagicMatch</a> readMatch(Element element) <strong class="jxr_keyword">throws</strong> MimeTypeException {
+<a name="237" href="#237">237</a>
+<a name="238" href="#238">238</a> String offset = <strong class="jxr_keyword">null</strong>;
+<a name="239" href="#239">239</a> String value = <strong class="jxr_keyword">null</strong>;
+<a name="240" href="#240">240</a> String mask = <strong class="jxr_keyword">null</strong>;
+<a name="241" href="#241">241</a> String type = <strong class="jxr_keyword">null</strong>;
+<a name="242" href="#242">242</a>
+<a name="243" href="#243">243</a> NamedNodeMap attrs = element.getAttributes();
+<a name="244" href="#244">244</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < attrs.getLength(); i++) {
+<a name="245" href="#245">245</a> Attr attr = (Attr) attrs.item(i);
+<a name="246" href="#246">246</a> <strong class="jxr_keyword">if</strong> (attr.getName().equals(<span class="jxr_string">"offset"</span>)) {
+<a name="247" href="#247">247</a> offset = attr.getValue();
+<a name="248" href="#248">248</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (attr.getName().equals(<span class="jxr_string">"type"</span>)) {
+<a name="249" href="#249">249</a> type = attr.getValue();
+<a name="250" href="#250">250</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (attr.getName().equals(<span class="jxr_string">"value"</span>)) {
+<a name="251" href="#251">251</a> value = attr.getValue();
+<a name="252" href="#252">252</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (attr.getName().equals(<span class="jxr_string">"mask"</span>)) {
+<a name="253" href="#253">253</a> mask = attr.getValue();
+<a name="254" href="#254">254</a> }
+<a name="255" href="#255">255</a> }
+<a name="256" href="#256">256</a> <em class="jxr_comment">// Parse OffSet</em>
+<a name="257" href="#257">257</a> String[] offsets = offset.split(<span class="jxr_string">":"</span>);
+<a name="258" href="#258">258</a> <strong class="jxr_keyword">int</strong> offStart = 0;
+<a name="259" href="#259">259</a> <strong class="jxr_keyword">int</strong> offEnd = 0;
+<a name="260" href="#260">260</a> <strong class="jxr_keyword">try</strong> {
+<a name="261" href="#261">261</a> offStart = Integer.parseInt(offsets[0]);
+<a name="262" href="#262">262</a> } <strong class="jxr_keyword">catch</strong> (Exception e) {
+<a name="263" href="#263">263</a> <em class="jxr_comment">// WARN log + avoid loading</em>
+<a name="264" href="#264">264</a> }
+<a name="265" href="#265">265</a> <strong class="jxr_keyword">try</strong> {
+<a name="266" href="#266">266</a> offEnd = Integer.parseInt(offsets[1]);
+<a name="267" href="#267">267</a> } <strong class="jxr_keyword">catch</strong> (Exception e) {
+<a name="268" href="#268">268</a> <em class="jxr_comment">// WARN log</em>
+<a name="269" href="#269">269</a> }
+<a name="270" href="#270">270</a> offEnd = Math.max(offStart, offEnd);
+<a name="271" href="#271">271</a>
+<a name="272" href="#272">272</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/tika/mime/MagicMatch.html">MagicMatch</a>(offStart, offEnd, type, mask, value);
+<a name="273" href="#273">273</a> }
+<a name="274" href="#274">274</a>
+<a name="275" href="#275">275</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Read Element named root-XML. */</em>
+<a name="276" href="#276">276</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> readRootXML(Element element, <a href="../../../../org/apache/tika/mime/MimeType.html">MimeType</a> mimeType) {
+<a name="277" href="#277">277</a> mimeType.addRootXML(element.getAttribute(<span class="jxr_string">"namespaceURI"</span>), element
+<a name="278" href="#278">278</a> .getAttribute(<span class="jxr_string">"localName"</span>));
+<a name="279" href="#279">279</a> }
+<a name="280" href="#280">280</a>
+<a name="281" href="#281">281</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+
Added: incubator/tika/site/xref/org/apache/tika/mime/Operator.html
URL: http://svn.apache.org/viewvc/incubator/tika/site/xref/org/apache/tika/mime/Operator.html?rev=596146&view=auto
==============================================================================
--- incubator/tika/site/xref/org/apache/tika/mime/Operator.html (added)
+++ incubator/tika/site/xref/org/apache/tika/mime/Operator.html Sun Nov 18 14:20:54 2007
@@ -0,0 +1,83 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+<title>Operator xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../apidocs/org/apache/tika/mime/Operator.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a> <em class="jxr_javadoccomment">/**</em>
+<a name="2" href="#2">2</a> <em class="jxr_javadoccomment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
+<a name="3" href="#3">3</a> <em class="jxr_javadoccomment"> * contributor license agreements. See the NOTICE file distributed with</em>
+<a name="4" href="#4">4</a> <em class="jxr_javadoccomment"> * this work for additional information regarding copyright ownership.</em>
+<a name="5" href="#5">5</a> <em class="jxr_javadoccomment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em>
+<a name="6" href="#6">6</a> <em class="jxr_javadoccomment"> * (the "License"); you may not use this file except in compliance with</em>
+<a name="7" href="#7">7</a> <em class="jxr_javadoccomment"> * the License. You may obtain a copy of the License at</em>
+<a name="8" href="#8">8</a> <em class="jxr_javadoccomment"> *</em>
+<a name="9" href="#9">9</a> <em class="jxr_javadoccomment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
+<a name="10" href="#10">10</a> <em class="jxr_javadoccomment"> *</em>
+<a name="11" href="#11">11</a> <em class="jxr_javadoccomment"> * Unless required by applicable law or agreed to in writing, software</em>
+<a name="12" href="#12">12</a> <em class="jxr_javadoccomment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
+<a name="13" href="#13">13</a> <em class="jxr_javadoccomment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
+<a name="14" href="#14">14</a> <em class="jxr_javadoccomment"> * See the License for the specific language governing permissions and</em>
+<a name="15" href="#15">15</a> <em class="jxr_javadoccomment"> * limitations under the License.</em>
+<a name="16" href="#16">16</a> <em class="jxr_javadoccomment"> */</em>
+<a name="17" href="#17">17</a> <strong class="jxr_keyword">package</strong> org.apache.tika.mime;
+<a name="18" href="#18">18</a>
+<a name="19" href="#19">19</a> <em class="jxr_javadoccomment">/**</em>
+<a name="20" href="#20">20</a> <em class="jxr_javadoccomment"> * Defines a Boolean Binary Operator.</em>
+<a name="21" href="#21">21</a> <em class="jxr_javadoccomment"> * </em>
+<a name="22" href="#22">22</a> <em class="jxr_javadoccomment"> * </em>
+<a name="23" href="#23">23</a> <em class="jxr_javadoccomment"> */</em>
+<a name="24" href="#24">24</a> <strong class="jxr_keyword">interface</strong> <a href="../../../../org/apache/tika/mime/Operator.html">Operator</a> {
+<a name="25" href="#25">25</a>
+<a name="26" href="#26">26</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The OR Boolean operator */</em>
+<a name="27" href="#27">27</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../org/apache/tika/mime/Operator.html">Operator</a> OR = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/tika/mime/Operator.html">Or</a>();
+<a name="28" href="#28">28</a>
+<a name="29" href="#29">29</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The AND Boolean operator */</em>
+<a name="30" href="#30">30</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../org/apache/tika/mime/Operator.html">Operator</a> AND = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/tika/mime/Operator.html">And</a>();
+<a name="31" href="#31">31</a>
+<a name="32" href="#32">32</a> <em class="jxr_javadoccomment">/**</em>
+<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * Evaluates the specified bolean operands.</em>
+<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * </em>
+<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * @param o1</em>
+<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * is the first boolean operand.</em>
+<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * @param o2</em>
+<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * is the second boolean operand.</em>
+<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * @return the value of this boolean operator applied on the specified</em>
+<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * boolean operands.</em>
+<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> */</em>
+<a name="42" href="#42">42</a> <strong class="jxr_keyword">boolean</strong> eval(<strong class="jxr_keyword">boolean</strong> o1, <strong class="jxr_keyword">boolean</strong> o2);
+<a name="43" href="#43">43</a>
+<a name="44" href="#44">44</a> <em class="jxr_javadoccomment">/**</em>
+<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * Defines the Boolean Binary Operator AND.</em>
+<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> */</em>
+<a name="47" href="#47">47</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/tika/mime/Operator.html">And</a> implements <a href="../../../../org/apache/tika/mime/Operator.html">Operator</a> {
+<a name="48" href="#48">48</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> eval(<strong class="jxr_keyword">boolean</strong> o1, <strong class="jxr_keyword">boolean</strong> o2) {
+<a name="49" href="#49">49</a> <strong class="jxr_keyword">return</strong> o1 && o2;
+<a name="50" href="#50">50</a> }
+<a name="51" href="#51">51</a>
+<a name="52" href="#52">52</a> <strong class="jxr_keyword">public</strong> String toString() {
+<a name="53" href="#53">53</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"AND"</span>;
+<a name="54" href="#54">54</a> }
+<a name="55" href="#55">55</a> }
+<a name="56" href="#56">56</a>
+<a name="57" href="#57">57</a> <em class="jxr_javadoccomment">/**</em>
+<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * Defines the Boolean Binary Operator OR.</em>
+<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> */</em>
+<a name="60" href="#60">60</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/tika/mime/Operator.html">Or</a> implements <a href="../../../../org/apache/tika/mime/Operator.html">Operator</a> {
+<a name="61" href="#61">61</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> eval(<strong class="jxr_keyword">boolean</strong> o1, <strong class="jxr_keyword">boolean</strong> o2) {
+<a name="62" href="#62">62</a> <strong class="jxr_keyword">return</strong> o1 || o2;
+<a name="63" href="#63">63</a> }
+<a name="64" href="#64">64</a>
+<a name="65" href="#65">65</a> <strong class="jxr_keyword">public</strong> String toString() {
+<a name="66" href="#66">66</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"OR"</span>;
+<a name="67" href="#67">67</a> }
+<a name="68" href="#68">68</a> }
+<a name="69" href="#69">69</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+