pylucene 3.5.0-3
[pylucene.git] / lucene-java-3.5.0 / lucene / contrib / highlighter / src / java / org / apache / lucene / search / vectorhighlight / SingleFragListBuilder.java
1 package org.apache.lucene.search.vectorhighlight;
2
3 /**
4  * Licensed to the Apache Software Foundation (ASF) under one or more
5  * contributor license agreements.  See the NOTICE file distributed with
6  * this work for additional information regarding copyright ownership.
7  * The ASF licenses this file to You under the Apache License, Version 2.0
8  * (the "License"); you may not use this file except in compliance with
9  * the License.  You may obtain a copy of the License at
10  *
11  *     http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  */
19
20 import java.util.ArrayList;
21 import java.util.Iterator;
22 import java.util.List;
23
24 import org.apache.lucene.search.vectorhighlight.FieldFragList.WeightedFragInfo;
25 import org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo;
26
27 /**
28  * An implementation class of {@link FragListBuilder} that generates one {@link WeightedFragInfo} object.
29  * Typical use case of this class is that you can get an entire field contents
30  * by using both of this class and {@link SimpleFragmentsBuilder}.<br/>
31  * <pre>
32  * FastVectorHighlighter h = new FastVectorHighlighter( true, true,
33  *   new SingleFragListBuilder(), new SimpleFragmentsBuilder() );
34  * </pre>
35  */
36 public class SingleFragListBuilder implements FragListBuilder {
37
38   public FieldFragList createFieldFragList(FieldPhraseList fieldPhraseList,
39       int fragCharSize) {
40
41     FieldFragList ffl = new FieldFragList( fragCharSize );
42
43     List<WeightedPhraseInfo> wpil = new ArrayList<WeightedPhraseInfo>();
44     Iterator<WeightedPhraseInfo> ite = fieldPhraseList.phraseList.iterator();
45     WeightedPhraseInfo phraseInfo = null;
46     while( true ){
47       if( !ite.hasNext() ) break;
48       phraseInfo = ite.next();
49       if( phraseInfo == null ) break;
50
51       wpil.add( phraseInfo );
52     }
53     if( wpil.size() > 0 )
54       ffl.add( 0, Integer.MAX_VALUE, wpil );
55     return ffl;
56   }
57
58 }