lucene-java-3.5.0/lucene/contrib/facet/src/java/org/apache/lucene/facet/index/CategoryListPayloadStream.java

   1 package org.apache.lucene.facet.index;
   2
   3 import java.io.ByteArrayOutputStream;
   4 import java.io.IOException;
   5
   6 import org.apache.lucene.util.encoding.IntEncoder;
   7
   8 /**
   9  * Licensed to the Apache Software Foundation (ASF) under one or more
  10  * contributor license agreements.  See the NOTICE file distributed with
  11  * this work for additional information regarding copyright ownership.
  12  * The ASF licenses this file to You under the Apache License, Version 2.0
  13  * (the "License"); you may not use this file except in compliance with
  14  * the License.  You may obtain a copy of the License at
  15  *
  16  *     http://www.apache.org/licenses/LICENSE-2.0
  17  *
  18  * Unless required by applicable law or agreed to in writing, software
  19  * distributed under the License is distributed on an "AS IS" BASIS,
  20  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  21  * See the License for the specific language governing permissions and
  22  * limitations under the License.
  23  */
  24
  25 /**
  26  * Accumulates category IDs for a single document, for writing in byte array
  27  * form, for example, to a Lucene Payload.
  28  *
  29  * @lucene.experimental
  30  */
  31 public class CategoryListPayloadStream {
  32
  33   private ByteArrayOutputStream baos = new ByteArrayOutputStream(50);
  34   private IntEncoder encoder;
  35
  36   /** Creates a Payload stream using the specified encoder. */
  37   public CategoryListPayloadStream(IntEncoder encoder) {
  38     this.encoder = encoder;
  39     this.encoder.reInit(baos);
  40   }
  41
  42   /** Appends an integer to the stream. */
  43   public void appendIntToStream(int intValue) throws IOException {
  44     encoder.encode(intValue);
  45   }
  46
  47   /** Returns the streamed bytes so far accumulated, as an array of bytes. */
  48   public byte[] convertStreamToByteArray() {
  49     try {
  50       encoder.close();
  51       return baos.toByteArray();
  52     } catch (IOException e) {
  53       // This cannot happen, because of BAOS (no I/O).
  54       return new byte[0];
  55     }
  56   }
  57
  58   /** Resets this stream to begin building a new payload. */
  59   public void reset() throws IOException {
  60     encoder.close();
  61     baos.reset();
  62     encoder.reInit(baos);
  63   }
  64
  65 }