1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski package com.sun.star.help; 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski import java.io.File; 27*b1cdbd2cSJim Jagielski import java.io.Reader; 28*b1cdbd2cSJim Jagielski import java.io.FileInputStream; 29*b1cdbd2cSJim Jagielski import java.io.InputStreamReader; 30*b1cdbd2cSJim Jagielski //import java.io.FileReader; 31*b1cdbd2cSJim Jagielski import java.io.StringReader; 32*b1cdbd2cSJim Jagielski 33*b1cdbd2cSJim Jagielski import org.apache.lucene.document.Document; 34*b1cdbd2cSJim Jagielski import org.apache.lucene.document.Field; 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski /** Lucene Document for help files */ 37*b1cdbd2cSJim Jagielski public class HelpFileDocument 38*b1cdbd2cSJim Jagielski { 39*b1cdbd2cSJim Jagielski /** Creates reader for UTF-8 files 40*b1cdbd2cSJim Jagielski */ getReaderForFile( File aFile )41*b1cdbd2cSJim Jagielski private static Reader getReaderForFile( File aFile ) 42*b1cdbd2cSJim Jagielski throws java.io.FileNotFoundException, java.io.UnsupportedEncodingException { 43*b1cdbd2cSJim Jagielski Reader aReader; 44*b1cdbd2cSJim Jagielski if( aFile != null ) { 45*b1cdbd2cSJim Jagielski FileInputStream fis = new FileInputStream( aFile ); 46*b1cdbd2cSJim Jagielski aReader = new InputStreamReader( fis, "UTF-8" ); 47*b1cdbd2cSJim Jagielski } 48*b1cdbd2cSJim Jagielski else { 49*b1cdbd2cSJim Jagielski aReader = new StringReader( "" ); 50*b1cdbd2cSJim Jagielski } 51*b1cdbd2cSJim Jagielski return aReader; 52*b1cdbd2cSJim Jagielski } 53*b1cdbd2cSJim Jagielski 54*b1cdbd2cSJim Jagielski /** Makes a document for a File. 55*b1cdbd2cSJim Jagielski */ Document( String aModule, File aCaptionFile, File aContentFile )56*b1cdbd2cSJim Jagielski public static Document Document( String aModule, File aCaptionFile, File aContentFile ) 57*b1cdbd2cSJim Jagielski throws java.io.FileNotFoundException, java.io.UnsupportedEncodingException { 58*b1cdbd2cSJim Jagielski Document doc = new Document(); 59*b1cdbd2cSJim Jagielski 60*b1cdbd2cSJim Jagielski // Add the path of the file as a field named "path". Use a field that is 61*b1cdbd2cSJim Jagielski // indexed (i.e. searchable), but don't tokenize the field into words. 62*b1cdbd2cSJim Jagielski File aFile = aCaptionFile != null ? aCaptionFile : aContentFile; 63*b1cdbd2cSJim Jagielski if( aFile != null ) 64*b1cdbd2cSJim Jagielski { 65*b1cdbd2cSJim Jagielski String aPath = "#HLP#" + aModule + "/" + aFile.getName(); 66*b1cdbd2cSJim Jagielski doc.add(new Field("path", aPath, Field.Store.YES, Field.Index.NOT_ANALYZED)); 67*b1cdbd2cSJim Jagielski } 68*b1cdbd2cSJim Jagielski 69*b1cdbd2cSJim Jagielski // Add the caption of the file to a field named "caption". Specify a Reader, 70*b1cdbd2cSJim Jagielski // so that the text of the file is tokenized and indexed, but not stored. 71*b1cdbd2cSJim Jagielski doc.add( new Field( "caption", getReaderForFile( aCaptionFile ) ) ); 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski // Add the contents of the file to a field named "content". Specify a Reader, 74*b1cdbd2cSJim Jagielski // so that the text of the file is tokenized and indexed, but not stored. 75*b1cdbd2cSJim Jagielski doc.add( new Field( "content", getReaderForFile( aContentFile ) ) ); 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski // return the document 78*b1cdbd2cSJim Jagielski return doc; 79*b1cdbd2cSJim Jagielski } 80*b1cdbd2cSJim Jagielski HelpFileDocument()81*b1cdbd2cSJim Jagielski private HelpFileDocument() {} 82*b1cdbd2cSJim Jagielski } 83