From 59779c7455edd5e40a2423be31fb454a45617542 Mon Sep 17 00:00:00 2001 From: Otis Gospodnetic Date: Mon, 13 Oct 2003 14:18:04 +0000 Subject: [PATCH] - Added ASL and removed trailing spaces. git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@150094 13f79535-47bb-0310-9956-ffa450edef68 --- .../lucene/index/CompoundFileReader.java | 170 +++++++++++------ .../lucene/index/CompoundFileWriter.java | 177 ++++++++++++------ 2 files changed, 227 insertions(+), 120 deletions(-) diff --git a/src/java/org/apache/lucene/index/CompoundFileReader.java b/src/java/org/apache/lucene/index/CompoundFileReader.java index 4558676f8e6..3ce45265fc1 100644 --- a/src/java/org/apache/lucene/index/CompoundFileReader.java +++ b/src/java/org/apache/lucene/index/CompoundFileReader.java @@ -1,4 +1,59 @@ package org.apache.lucene.index; + +/* ==================================================================== + * The Apache Software License, Version 1.1 + * + * Copyright (c) 2001 The Apache Software Foundation. All rights + * reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. The end-user documentation included with the redistribution, + * if any, must include the following acknowledgment: + * "This product includes software developed by the + * Apache Software Foundation (http://www.apache.org/)." + * Alternately, this acknowledgment may appear in the software itself, + * if and wherever such third-party acknowledgments normally appear. + * + * 4. The names "Apache" and "Apache Software Foundation" and + * "Apache Lucene" must not be used to endorse or promote products + * derived from this software without prior written permission. For + * written permission, please contact apache@apache.org. + * + * 5. Products derived from this software may not be called "Apache", + * "Apache Lucene", nor may "Apache" appear in their name, without + * prior written permission of the Apache Software Foundation. + * + * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED + * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF + * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT + * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * . + */ + import org.apache.lucene.store.Directory; import org.apache.lucene.store.InputStream; import org.apache.lucene.store.OutputStream; @@ -9,133 +64,134 @@ import java.util.Iterator; import java.io.IOException; -/** Class for accessing a compound stream. - * This class implements a directory, but is limited to only read operations. - * Directory methods that would normally modify data throw an exception. +/** + * Class for accessing a compound stream. + * This class implements a directory, but is limited to only read operations. + * Directory methods that would normally modify data throw an exception. + * + * @author Dmitry Serebrennikov + * @version $Id$ */ public class CompoundFileReader extends Directory { private static final class FileEntry { long offset; long length; - }; + } + - // Base info private Directory directory; private String fileName; - + // Reference count private boolean open; - + private InputStream stream; private HashMap entries = new HashMap(); - - public CompoundFileReader(Directory dir, String name) + + public CompoundFileReader(Directory dir, String name) throws IOException { directory = dir; fileName = name; - + boolean success = false; - + try { stream = dir.openFile(name); - + // read the directory and init files int count = stream.readVInt(); FileEntry entry = null; for (int i=0; i 0 && pos >= length) throw new IOException("Seek past the end of file"); - + if (pos < 0) throw new IOException("Seek to a negative offset"); - + base.seek(fileOffset + pos); } @@ -225,8 +278,7 @@ public class CompoundFileReader extends Directory { { base.close(); } - - + /** Returns a clone of this stream. * *

Clones of a stream access the same data, and are positioned at the same @@ -240,8 +292,6 @@ public class CompoundFileReader extends Directory { CSInputStream other = (CSInputStream) super.clone(); other.base = (InputStream) base.clone(); return other; - } + } } - - -} \ No newline at end of file +} diff --git a/src/java/org/apache/lucene/index/CompoundFileWriter.java b/src/java/org/apache/lucene/index/CompoundFileWriter.java index a48e90f81c6..e6d5828f871 100644 --- a/src/java/org/apache/lucene/index/CompoundFileWriter.java +++ b/src/java/org/apache/lucene/index/CompoundFileWriter.java @@ -1,4 +1,59 @@ package org.apache.lucene.index; + +/* ==================================================================== + * The Apache Software License, Version 1.1 + * + * Copyright (c) 2001 The Apache Software Foundation. All rights + * reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. The end-user documentation included with the redistribution, + * if any, must include the following acknowledgment: + * "This product includes software developed by the + * Apache Software Foundation (http://www.apache.org/)." + * Alternately, this acknowledgment may appear in the software itself, + * if and wherever such third-party acknowledgments normally appear. + * + * 4. The names "Apache" and "Apache Software Foundation" and + * "Apache Lucene" must not be used to endorse or promote products + * derived from this software without prior written permission. For + * written permission, please contact apache@apache.org. + * + * 5. Products derived from this software may not be called "Apache", + * "Apache Lucene", nor may "Apache" appear in their name, without + * prior written permission of the Apache Software Foundation. + * + * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED + * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF + * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT + * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * . + */ + import org.apache.lucene.store.Directory; import org.apache.lucene.store.OutputStream; import org.apache.lucene.store.InputStream; @@ -8,36 +63,40 @@ import java.util.Iterator; import java.io.IOException; -/** Combines multiple files into a single compound file. - * The file format:
- *

    - *
  • VInt fileCount
    • - *
  • {Directory} - * fileCount entries with the following structure:
    • - *
      - *
    • long dataOffset
      • - *
    • UTFString extension
      • - *
    - *
  • {File Data} - * fileCount entries with the raw data of the corresponding file
    • - *
- * - * The fileCount integer indicates how many files are contained in this compound - * file. The {directory} that follows has that many entries. Each directory entry - * contains an encoding identifier, an long pointer to the start of this file's - * data section, and a UTF String with that file's extension. +/** + * Combines multiple files into a single compound file. + * The file format:
+ *
    + *
  • VInt fileCount
    • + *
  • {Directory} + * fileCount entries with the following structure:
    • + *
      + *
    • long dataOffset
      • + *
    • UTFString extension
      • + *
    + *
  • {File Data} + * fileCount entries with the raw data of the corresponding file
    • + *
+ * + * The fileCount integer indicates how many files are contained in this compound + * file. The {directory} that follows has that many entries. Each directory entry + * contains an encoding identifier, an long pointer to the start of this file's + * data section, and a UTF String with that file's extension. + * + * @author Dmitry Serebrennikov + * @version $Id$ */ final class CompoundFileWriter { - + private static final class FileEntry { /** source file */ - String file; - + String file; + /** temporary holder for the start of directory entry for this file */ - long directoryOffset; - + long directoryOffset; + /** temporary holder for the start of this file's data section */ - long dataOffset; + long dataOffset; } @@ -46,7 +105,7 @@ final class CompoundFileWriter { private HashSet ids; private LinkedList entries; private boolean merged = false; - + /** Create the compound stream in the specified file. The file name is the * entire name (no extensions are added). @@ -56,24 +115,23 @@ final class CompoundFileWriter { throw new IllegalArgumentException("Missing directory"); if (name == null) throw new IllegalArgumentException("Missing name"); - + directory = dir; fileName = name; ids = new HashSet(); entries = new LinkedList(); } - + /** Returns the directory of the compound file. */ public Directory getDirectory() { return directory; } - + /** Returns the name of the compound file. */ public String getName() { return fileName; } - - + /** Add a source stream. If sourceDir is null, it is set to the * same value as the directory where this compound stream exists. * The id is the string by which the sub-stream will be know in the @@ -84,44 +142,44 @@ final class CompoundFileWriter { if (merged) throw new IllegalStateException( "Can't add extensions after merge has been called"); - + if (file == null) throw new IllegalArgumentException( "Missing source file"); - - if (! ids.add(file)) + + if (! ids.add(file)) throw new IllegalArgumentException( "File " + file + " already added"); - + FileEntry entry = new FileEntry(); entry.file = file; entries.add(entry); } /** Merge files with the extensions added up to now. - * All files with these extensions are combined sequentially into the + * All files with these extensions are combined sequentially into the * compound stream. After successful merge, the source files * are deleted. - */ + */ public void close() throws IOException { if (merged) throw new IllegalStateException( "Merge already performed"); - + if (entries.isEmpty()) throw new IllegalStateException( "No entries to merge have been defined"); - + merged = true; - + // open the compound stream OutputStream os = null; try { os = directory.createFile(fileName); - + // Write the number of entries os.writeVInt(entries.size()); - + // Write the directory with all offsets at 0. // Remember the positions of directory entries so that we can // adjust the offsets later @@ -132,17 +190,17 @@ final class CompoundFileWriter { os.writeLong(0); // for now os.writeString(fe.file); } - + // Open the files and copy their data into the stream. // Remeber the locations of each file's data section. byte buffer[] = new byte[1024]; it = entries.iterator(); while(it.hasNext()) { FileEntry fe = (FileEntry) it.next(); - fe.dataOffset = os.getFilePointer(); + fe.dataOffset = os.getFilePointer(); copyFile(fe, os, buffer); } - + // Write the data offsets into the directory of the compound stream it = entries.iterator(); while(it.hasNext()) { @@ -150,61 +208,60 @@ final class CompoundFileWriter { os.seek(fe.directoryOffset); os.writeLong(fe.dataOffset); } - + // Close the output stream. Set the os to null before trying to - // close so that if an exception occurs during the close, the + // close so that if an exception occurs during the close, the // finally clause below will not attempt to close the stream // the second time. OutputStream tmp = os; os = null; tmp.close(); - + } finally { if (os != null) try { os.close(); } catch (IOException e) { } } } - - + /** Copy the contents of the file with specified extension into the * provided output stream. Use the provided buffer for moving data * to reduce memory allocation. */ - private void copyFile(FileEntry source, OutputStream os, byte buffer[]) + private void copyFile(FileEntry source, OutputStream os, byte buffer[]) throws IOException { InputStream is = null; try { long startPtr = os.getFilePointer(); - + is = directory.openFile(source.file); long length = is.length(); long remainder = length; int chunk = buffer.length; - + while(remainder > 0) { int len = (int) Math.min(chunk, remainder); is.readBytes(buffer, 0, len); os.writeBytes(buffer, len); remainder -= len; } - + // Verify that remainder is 0 - if (remainder != 0) + if (remainder != 0) throw new IOException( "Non-zero remainder length after copying: " + remainder - + " (id: " + source.file + ", length: " + length + + " (id: " + source.file + ", length: " + length + ", buffer size: " + chunk + ")"); - + // Verify that the output length diff is equal to original file long endPtr = os.getFilePointer(); long diff = endPtr - startPtr; - if (diff != length) + if (diff != length) throw new IOException( "Difference in the output file offsets " + diff + " does not match the original file length " + length); - - } finally { + + } finally { if (is != null) is.close(); } } -} \ No newline at end of file +}