1 package org.apache.lucene.store.instantiated;
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
10 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 import org.apache.lucene.document.Document;
21 import java.io.Serializable;
22 import java.util.List;
26 * A document in the instantiated index object graph, optionally coupled to the vector space view.
28 * @see org.apache.lucene.document.Document
30 public class InstantiatedDocument
31 implements Serializable {
33 private static final long serialVersionUID = 1l;
35 private Document document;
37 public InstantiatedDocument() {
38 this.document = new Document();
42 public InstantiatedDocument(Document document) {
43 this.document = document;
46 /** this is the unsafe index order document number. */
47 private Integer documentNumber;
49 /** this is the term vector space view */
50 private Map<String /*field name*/, List<InstantiatedTermDocumentInformation>> vectorSpace;
53 * @return position of document in the index.
55 public Integer getDocumentNumber() {
56 return documentNumber;
59 void setDocumentNumber(Integer documentNumber) {
60 this.documentNumber = documentNumber;
63 public Map</*field name*/ String, List<InstantiatedTermDocumentInformation>> getVectorSpace() {
67 public void setVectorSpace(Map</*field name*/ String, List<InstantiatedTermDocumentInformation>> vectorSpace) {
68 this.vectorSpace = vectorSpace;
71 public Document getDocument() {
77 public String toString() {
78 return document.toString();