lucene-java-3.4.0/lucene/contrib/instantiated/src/java/org/apache/lucene/store/instantiated/InstantiatedDocument.java

   1 package org.apache.lucene.store.instantiated;
   2 /**
   3  * Licensed to the Apache Software Foundation (ASF) under one or more
   4  * contributor license agreements.  See the NOTICE file distributed with
   5  * this work for additional information regarding copyright ownership.
   6  * The ASF licenses this file to You under the Apache License, Version 2.0
   7  * (the "License"); you may not use this file except in compliance with
   8  * the License.  You may obtain a copy of the License at
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18
  19 import org.apache.lucene.document.Document;
  20
  21 import java.io.Serializable;
  22 import java.util.List;
  23 import java.util.Map;
  24
  25 /**
  26  * A document in the instantiated index object graph, optionally coupled to the vector space view.
  27  *
  28  * @see org.apache.lucene.document.Document
  29  */
  30 public class InstantiatedDocument
  31     implements Serializable {
  32
  33   private static final long serialVersionUID = 1l;
  34
  35   private Document document;
  36
  37   public InstantiatedDocument() {
  38     this.document = new Document();
  39   }
  40
  41
  42   public InstantiatedDocument(Document document) {
  43     this.document = document;
  44   }
  45
  46   /** this is the unsafe index order document number. */
  47   private Integer documentNumber;
  48
  49   /** this is the term vector space view */
  50   private Map<String /*field name*/, List<InstantiatedTermDocumentInformation>> vectorSpace;
  51
  52   /**
  53    * @return position of document in the index.
  54    */
  55   public Integer getDocumentNumber() {
  56     return documentNumber;
  57   }
  58
  59   void setDocumentNumber(Integer documentNumber) {
  60     this.documentNumber = documentNumber;
  61   }
  62
  63   public Map</*field name*/ String, List<InstantiatedTermDocumentInformation>> getVectorSpace() {
  64     return vectorSpace;
  65   }
  66
  67   public void setVectorSpace(Map</*field name*/ String, List<InstantiatedTermDocumentInformation>> vectorSpace) {
  68     this.vectorSpace = vectorSpace;
  69   }
  70
  71   public Document getDocument() {
  72     return document;
  73   }
  74
  75
  76   @Override
  77   public String toString() {
  78     return document.toString();
  79   }
  80 }