yacy_search_server/source/net/yacy/kelondro/rwi/Reference.java
reger 3c7220bc7b Refacture rwi reference word position and word distance calculation
used for rwi ranking.
Main changes:  
- introduce a  posintext() to access the stored value. This reduces also mem alloc of position array for WordReferenceRow (index access)
- use the positions() array for joined references on multi-word queries if needed (otherwise allow positions() to be null
- adjust assignments and the min() max() and distance() calculation accordingly
2016-10-23 19:40:02 +02:00

84 lines
2.6 KiB
Java

// Reference.java
// (C) 2009 by Michael Peter Christen; mc@yacy.net, Frankfurt a. M., Germany
// first published 03.04.2009 on http://yacy.net
//
// This is a part of YaCy, a peer-to-peer based web search engine
//
// $LastChangedDate$
// $LastChangedRevision$
// $LastChangedBy$
//
// LICENSE
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
package net.yacy.kelondro.rwi;
import java.util.Collection;
import net.yacy.kelondro.index.Row.Entry;
public interface Reference {
public String toPropertyForm();
public Entry toKelondroEntry();
public byte[] urlhash();
public long lastModified();
@Override
public String toString();
public boolean isOlder(Reference other);
@Override
public int hashCode();
@Override
public boolean equals(Object other);
/**
* Joins a Reference into this one, setting the values appropriate for ranking
* @param joined reference
*/
public void join(final Reference oe);
/**
* First positon of word in text.
* Word position is not calculated for titles, for all title words it defaults to 0.
* @return min word position starting at 1 (0 if undefined)
*/
public int posintext();
/**
* Positions of search query words for the referenced result url
* This is only valid for multi word search queries.
* The positions contain the first word position for every joined search query word
* which has been joined (by join() )
* @return list with word position (excl. the posintext of this reference) or null
*/
public Collection<Integer> positions();
/**
* The average distance (in words) between search query terms for multi word searches.
* The distance is calculated from posintext() and positions()
* @return word distance
*/
public int distance();
}