aboutsummaryrefslogtreecommitdiffstats
path: root/container-search/src/main/java/com/yahoo/search/federation/vespa/QueryMarshaller.java
blob: 3a0db9b76de74118f431667f4ac01c04726d5d39 (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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.search.federation.vespa;

import java.util.Iterator;

import com.yahoo.prelude.query.*;

/**
 * Marshal a query stack into an advanced query string suitable for
 * passing to another QRS.
 *
 * @author Steinar Knutsen
 * @author Rong-En Fan
 * @deprecated use YQL
 */
// TODO: Remove on Vespa 7
@Deprecated // OK
public class QueryMarshaller {

    private boolean atRoot = true;

    public String marshal(Item root) {
        if (root == null || root instanceof NullItem) {
            return null;
        }
        StringBuilder s = new StringBuilder();
        marshal(root, s);
        atRoot = true;
        return s.toString();
    }

    /**
     * We do not yet care about exact match indices
     */
    private void marshal(Item root, StringBuilder s) {
        switch (root.getItemType()) {
        case OR:
            marshalOr((OrItem) root, s);
            break;
        case AND:
            marshalAnd((CompositeItem) root, s);
            break;
        case NOT:
            marshalNot((NotItem) root, s);
            break;
        case RANK:
            marshalRank((RankItem) root, s);
            break;
        case WORD:
        case INT:
        case PREFIX:
        case SUBSTRING:
        case SUFFIX:
            marshalWord((TermItem) root, s);
            break;
        case PHRASE:
            // PhraseItem and PhraseSegmentItem don't add quotes for segmented
            // termse
            if (root instanceof PhraseSegmentItem) {
                marshalPhrase((PhraseSegmentItem) root, s);
            } else {
                marshalPhrase((PhraseItem) root, s);
            }
            break;
        case NEAR:
            marshalNear((NearItem) root, s);
            break;
        case ONEAR:
            marshalNear((ONearItem) root, s);
            break;
        case WEAK_AND:
            marshalWeakAnd((WeakAndItem)root, s);
            break;
        default:
            break;
        }
    }


    private void marshalWord(TermItem item, StringBuilder s) {
        String index = item.getIndexName();
        if (index.length() != 0) {
            s.append(item.getIndexName()).append(':');
        }
        s.append(item.stringValue());
        if (item.getWeight() != Item.DEFAULT_WEIGHT)
            s.append("!").append(item.getWeight());
    }

    private void marshalRank(RankItem root, StringBuilder s) {
        marshalComposite("RANK", root, s);
    }

    private void marshalNot(NotItem root, StringBuilder s) {
        marshalComposite("ANDNOT", root, s);
    }

    private void marshalOr(OrItem root, StringBuilder s) {
        marshalComposite("OR", root, s);
    }

    /**
     * Dump WORD items, and add space between each of them unless those
     * words came from segmentation.
     *
     * @param root CompositeItem
     * @param s current marshaled query
     */
    private void dumpWords(CompositeItem root, StringBuilder s) {
        for (Iterator<Item> i = root.getItemIterator(); i.hasNext();) {
            Item word = i.next();
            boolean useSeparator = true;
            if (word instanceof TermItem) {
                s.append(((TermItem) word).stringValue());
                if (word instanceof WordItem) {
                    useSeparator = !((WordItem) word).isFromSegmented();
                }
            } else {
                dumpWords((CompositeItem) word, s);
            }
            if (useSeparator && i.hasNext()) {
                s.append(' ');
            }
        }
    }

    private void marshalPhrase(PhraseItem root, StringBuilder s) {
        marshalPhrase(root, s, root.isExplicit(), false);
    }

    private void marshalPhrase(PhraseSegmentItem root, StringBuilder s) {
        marshalPhrase(root, s, root.isExplicit(), true);
    }

    private void marshalPhrase(IndexedItem root, StringBuilder s, boolean isExplicit, boolean isSegmented) {
        String index = root.getIndexName();
        if (index.length() != 0) {
            s.append(root.getIndexName()).append(':');
        }
        if (isExplicit || !isSegmented) s.append('"');
        dumpWords((CompositeItem) root, s);
        if (isExplicit || !isSegmented) s.append('"');
    }

    private void marshalNear(NearItem root, StringBuilder s) {
        marshalComposite(root.getName() + "(" + root.getDistance() + ")", root, s);
    }

    // Not only AndItem returns ItemType.AND
    private void marshalAnd(CompositeItem root, StringBuilder s) {
        marshalComposite("AND", root, s);
    }

    private void marshalWeakAnd(WeakAndItem root, StringBuilder s) {
        marshalComposite("WAND(" + root.getN() + ")", root, s);
    }

    private void marshalComposite(String operator, CompositeItem root, StringBuilder s) {
        boolean useParen = !atRoot;
        if (useParen) {
            s.append("( ");
        } else {
            atRoot = false;
        }
        for (Iterator<Item> i = root.getItemIterator(); i.hasNext();) {
            Item item = i.next();
            marshal(item, s);
            if (i.hasNext())
                s.append(' ').append(operator).append(' ');
        }
        if (useParen) {
            s.append(" )");
        }
    }

}