summaryrefslogtreecommitdiffstats
path: root/container-search/src/main/java/com/yahoo/prelude/query/MarkerWordItem.java
blob: ae6fa4c81bd50b31043fd8ec43a68fb42c849bc1 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
// Copyright 2016 Yahoo Inc. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.prelude.query;

import com.yahoo.net.UrlTokenizer;
import com.yahoo.prelude.query.textualrepresentation.Discloser;


/**
 * Special words known by the index used for marking things.
 * The reserved word itself is not public, while a symbol representation is.
 *
 * @author  bratseth
 */
public class MarkerWordItem extends WordItem {

    /** Creates a special word item which marks the start of a host name */
    public static WordItem createStartOfHost() {
        return new MarkerWordItem("^", UrlTokenizer.TERM_STARTHOST);
    }

    /** Creates a special word item which marks the end of a host name */
    public static WordItem createEndOfHost() {
        return new MarkerWordItem("$", UrlTokenizer.TERM_ENDHOST);
    }

    private String markerWord;

    private MarkerWordItem(String publicSymbol, String markerWord) {
        super(publicSymbol);
        this.markerWord = markerWord;
    }

    /** Returns the marker word for encoding */
    protected String getEncodedWord() {
        return markerWord;
    }

    public boolean equals(Object o) {
        if (!super.equals(o)) {
            return false;
        }
        if (!(o instanceof MarkerWordItem)) {
            return false;
        }

        MarkerWordItem other = (MarkerWordItem) o;

        return markerWord.equals(other.markerWord);
    }

    public int hashCode() {
        return super.hashCode() + 499 * markerWord.hashCode();
    }

    @Override
    public void disclose(Discloser discloser) {
        super.disclose(discloser);
        discloser.addProperty("markerWord", markerWord);
    }
}