TestNodeTermScorer.java

/**
 * Copyright 2014 National University of Ireland, Galway.
 *
 * This file is part of the SIREn project. Project and contact information:
 *
 *  https://github.com/rdelbru/SIREn
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.sindice.siren.search.node;

import static org.sindice.siren.analysis.MockSirenToken.node;
import static org.sindice.siren.search.AbstractTestSirenScorer.NodeTermQueryBuilder.ntq;

import java.io.IOException;
import java.util.ArrayList;

import org.junit.Test;
import org.sindice.siren.analysis.AnyURIAnalyzer;
import org.sindice.siren.analysis.TupleAnalyzer;
import org.sindice.siren.analysis.AnyURIAnalyzer.URINormalisation;
import org.sindice.siren.index.DocsAndNodesIterator;
import org.sindice.siren.index.codecs.RandomSirenCodec.PostingsFormatType;
import org.sindice.siren.search.AbstractTestSirenScorer;
import org.sindice.siren.util.XSDDatatype;

public class TestNodeTermScorer extends AbstractTestSirenScorer {

  @Override
  protected void configure() throws IOException {
    this.setAnalyzer(AnalyzerType.TUPLE);
    // TODO: remove when TupleAnalyzer is no more used
    final AnyURIAnalyzer uriAnalyzer = new AnyURIAnalyzer(TEST_VERSION_CURRENT);
    uriAnalyzer.setUriNormalisation(URINormalisation.FULL);
    ((TupleAnalyzer) analyzer).registerDatatype(XSDDatatype.XSD_ANY_URI.toCharArray(), uriAnalyzer);
    this.setPostingsFormat(PostingsFormatType.RANDOM);
  }

  @Test
  public void testNextPositionFail() throws Exception {
    this.addDocument("<http://renaud.delbru.fr/> . ");
    final NodeTermScorer scorer = (NodeTermScorer) this.getScorer(ntq("renaud"));
    assertFalse(scorer.nextPosition());
  }

  @Test
  public void testNextNodeFail() throws Exception {
    this.addDocument("<http://renaud.delbru.fr/> . ");
    final NodeScorer scorer = this.getScorer(ntq("renaud"));
    assertFalse(scorer.nextNode());
  }

  @Test
  public void testLevelConstraint() throws Exception {
    this.addDocument("<http://renaud.delbru.fr/> . ");

    NodeScorer scorer = this.getScorer(ntq("renaud").level(1));
    assertTrue(scorer.nextCandidateDocument());
    assertEquals(0, scorer.doc());
    assertFalse(scorer.nextNode());

    scorer = this.getScorer(ntq("renaud").level(3));
    assertTrue(scorer.nextCandidateDocument());
    assertEquals(0, scorer.doc());
    assertFalse(scorer.nextNode());

    scorer = this.getScorer(ntq("renaud").level(2));
    assertTrue(scorer.nextCandidateDocument());
    assertEquals(0, scorer.doc());
    assertTrue(scorer.nextNode());
    assertEquals(node(0,0), scorer.node());
  }

  @Test
  public void testIntervalConstraint() throws Exception {
    this.addDocument("<http://renaud.delbru.fr/> . ");

    NodeScorer scorer = this.getScorer(ntq("renaud").bound(1,1));
    assertTrue(scorer.nextCandidateDocument());
    assertEquals(0, scorer.doc());
    assertFalse(scorer.nextNode());

    scorer = this.getScorer(ntq("renaud").bound(1,2));
    assertTrue(scorer.nextCandidateDocument());
    assertEquals(0, scorer.doc());
    assertFalse(scorer.nextNode());

    scorer = this.getScorer(ntq("renaud").bound(0,0));
    assertTrue(scorer.nextCandidateDocument());
    assertEquals(0, scorer.doc());
    assertTrue(scorer.nextNode());
    assertEquals(node(0,0), scorer.node());
  }

  @Test
  public void testNextPositionWithURI() throws Exception {
    this.addDocument("<http://renaud.delbru.fr/> <http://renaud.delbru.fr/> . ");
    NodeTermScorer scorer = (NodeTermScorer) this.getScorer(ntq("renaud"));
    assertTrue(scorer.nextCandidateDocument());
    assertEquals(0, scorer.doc());
    assertEquals(node(-1), scorer.node());
    assertEquals(-1, scorer.pos());

    assertTrue(scorer.nextNode());
    assertEquals(node(0,0), scorer.node());
    assertEquals(-1, scorer.pos());
    assertTrue(scorer.nextPosition());
    assertEquals(0, scorer.pos());

    assertTrue(scorer.nextNode());
    assertEquals(node(0,1), scorer.node());
    assertEquals(-1, scorer.pos());
    assertTrue(scorer.nextPosition());
    assertEquals(0, scorer.pos());

    assertEndOfStream(scorer);

    this.deleteAll();
    this.addDocument("<http://renaud.delbru.fr/> <http://test/name> \"Renaud Delbru\" . ");
    scorer = (NodeTermScorer) this.getScorer(ntq("renaud"));
    assertTrue(scorer.nextCandidateDocument());
    assertEquals(0, scorer.doc());
    assertEquals(node(-1), scorer.node());
    assertEquals(-1, scorer.pos());

    assertTrue(scorer.nextNode());
    assertEquals(node(0,0), scorer.node());
    assertEquals(-1, scorer.pos());
    assertTrue(scorer.nextPosition());
    assertEquals(0, scorer.pos());

    assertTrue(scorer.nextNode());
    assertEquals(node(0,2), scorer.node());
    assertEquals(-1, scorer.pos());
    assertTrue(scorer.nextPosition());
    assertEquals(0, scorer.pos());

    assertEndOfStream(scorer);
  }

  @Test
  public void testSkipToEntity() throws Exception {
    final ArrayList<String> docs = new ArrayList<String>();
    for (int i = 0; i < 32; i++) {
      docs.add("<http://renaud.delbru.fr/> . \"renaud delbru\" \"renaud delbru\" . ");
    }
    this.addDocuments(docs);

    final NodeTermScorer scorer = (NodeTermScorer) this.getScorer(ntq("renaud"));
    assertTrue(scorer.skipToCandidate(16));
    assertEquals(16, scorer.doc());
    assertEquals(node(-1), scorer.node());
    assertEquals(-1, scorer.pos());
  }

  @Test
  public void testSkipToNonExistingDocument() throws Exception {
    final ArrayList<String> docs = new ArrayList<String>();
    for (int i = 0; i < 32; i++) {
      docs.add("<http://renaud.delbru.fr/> . \"renaud delbru\" \"renaud delbru\" . ");
      docs.add("<aaa> . \"aaa\" \"aaa bbb\" . ");
    }
    this.deleteAll();
    this.addDocuments(docs);

    final NodeTermScorer scorer = (NodeTermScorer) this.getScorer(ntq("renaud"));
    // does not exist, should skip to entity 18
    assertTrue(scorer.skipToCandidate(17));
    assertEquals(18, scorer.doc());
    assertEquals(node(-1), scorer.node());
    assertTrue(scorer.nextNode());
    assertEquals(node(0, 0), scorer.node());
    assertEquals(-1, scorer.pos());
    assertTrue(scorer.nextPosition());
    assertEquals(0, scorer.pos());

    assertFalse(scorer.skipToCandidate(76));
    assertEndOfStream(scorer);
  }

  @Test
  public void testSkipToWithConstraint() throws Exception {
    final ArrayList<String> docs = new ArrayList<String>();
    for (int i = 0; i < 32; i++) {
      docs.add("<http://renaud.delbru.fr/> . \"renaud delbru\" \"renaud delbru\" . ");
      docs.add("<aaa> . \"aaa\" \"aaa bbb\" . ");
    }
    this.deleteAll();
    this.addDocuments(docs);

    NodeScorer scorer = this.getScorer(
      ntq("renaud").bound(1,1)
    );
    // does not exist, should skip to entity 18
    assertTrue(scorer.skipToCandidate(17));
    assertEquals(18, scorer.doc());
    assertEquals(node(-1), scorer.node());
    assertTrue(scorer.nextNode());
    assertEquals(node(1,1), scorer.node());

    assertFalse(scorer.skipToCandidate(76));
    assertEndOfStream(scorer);

    scorer = this.getScorer(
      ntq("renaud").bound(1,1).level(2)
    );

    // does not exist, should skip to entity 18
    assertTrue(scorer.skipToCandidate(17));
    assertEquals(18, scorer.doc());
    assertEquals(node(-1), scorer.node());
    assertTrue(scorer.nextNode());
    assertEquals(node(1,1), scorer.node());

    scorer = this.getScorer(
      ntq("renaud").bound(1,1).level(1)
    );

    // does not exist, should skip to entity 18
    assertTrue(scorer.skipToCandidate(17));
    assertEquals(18, scorer.doc());
    assertEquals(node(-1), scorer.node());
    assertFalse(scorer.nextNode());
    assertEquals(DocsAndNodesIterator.NO_MORE_NOD, scorer.node());

    scorer = this.getScorer(
      ntq("renaud").bound(4,7)
    );

    // does not exist, should skip to entity 18
    assertTrue(scorer.skipToCandidate(17));
    assertEquals(18, scorer.doc());
    assertEquals(node(-1), scorer.node());
    assertFalse(scorer.nextNode());
    assertEquals(DocsAndNodesIterator.NO_MORE_NOD, scorer.node());
  }

  @Test(expected=Exception.class)
  public void testInvalidScoreCall() throws IOException {
    this.addDocument("\"Renaud\" . ");
    final NodeScorer scorer = this.getScorer(ntq("renaud"));

    // Invalid call
    scorer.scoreInNode();
  }

  @Test
  public void testScore() throws IOException {
    this.addDocument("\"Renaud renaud\" \"renaud\" . ");
    final LuceneProxyNodeScorer scorer = new LuceneProxyNodeScorer(this.getScorer(ntq("renaud")));

    assertTrue(scorer.nextDoc() != DocsAndNodesIterator.NO_MORE_DOC);
    assertEquals(0, scorer.docID());
    assertEquals(3.0, scorer.freq(), 0.01);
    final float score = scorer.score();
    assertFalse(score + " != " + 0, score == 0);
  }

}