← Back to branch summary

~slub.team/goobi-indexserver/3.x

« back to all changes in this revision

Viewing changes to lucene/src/java/org/apache/lucene/analysis/tokenattributes/KeywordAttributeImpl.java

  • Committer: Sebastian Meyer
  • Date: 2012-08-03 09:12:40 UTC
  • Revision ID: sebastian.meyer@slub-dresden.de-20120803091240-x6861b0vabq1xror
https://launchpad.net/bugs/985487
Remove Lucene and Solr source code and add patches instead
Fix Bug #985487: Auto-suggestion for the search interface

Show diffs side-by-side

added added

removed removed

Lines of Context:
lucene/src/java/org/apache/lucene/analysis/tokenattributes/KeywordAttributeImpl.java
1
 
package org.apache.lucene.analysis.tokenattributes;
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 org.apache.lucene.analysis.TokenStream;
21
 
import org.apache.lucene.util.AttributeImpl;
22
 
 
23
 
/**
24
 
 *This attribute can be used to mark a token as a keyword. Keyword aware
25
 
 * {@link TokenStream}s can decide to modify a token based on the return value
26
 
 * of {@link #isKeyword()} if the token is modified. Stemming filters for
27
 
 * instance can use this attribute to conditionally skip a term if
28
 
 * {@link #isKeyword()} returns <code>true</code>.
29
 
 */
30
 
public final class KeywordAttributeImpl extends AttributeImpl implements
31
 
    KeywordAttribute {
32
 
  private boolean keyword;
33
 
 
34
 
  @Override
35
 
  public void clear() {
36
 
    keyword = false;
37
 
  }
38
 
 
39
 
  @Override
40
 
  public void copyTo(AttributeImpl target) {
41
 
    KeywordAttribute attr = (KeywordAttribute) target;
42
 
    attr.setKeyword(keyword);
43
 
  }
44
 
 
45
 
  @Override
46
 
  public int hashCode() {
47
 
    return keyword ? 31 : 37;
48
 
  }
49
 
 
50
 
  @Override
51
 
  public boolean equals(Object obj) {
52
 
    if (this == obj)
53
 
      return true;
54
 
    if (getClass() != obj.getClass())
55
 
      return false;
56
 
    final KeywordAttributeImpl other = (KeywordAttributeImpl) obj;
57
 
    return keyword == other.keyword;
58
 
  }
59
 
 
60
 
  /**
61
 
   * Returns <code>true</code> iff the current token is a keyword, otherwise
62
 
   * <code>false</code>/
63
 
   * 
64
 
   * @return <code>true</code> iff the current token is a keyword, otherwise
65
 
   *         <code>false</code>/
66
 
   */
67
 
  public boolean isKeyword() {
68
 
    return keyword;
69
 
  }
70
 
 
71
 
  /**
72
 
   * Marks the current token as keyword iff set to <code>true</code>.
73
 
   * 
74
 
   * @param isKeyword
75
 
   *          <code>true</code> iff the current token is a keyword, otherwise
76
 
   *          <code>false</code>.
77
 
   */
78
 
  public void setKeyword(boolean isKeyword) {
79
 
    keyword = isKeyword;
80
 
  }
81
 
 
82
 
}