yacy_search_server/source/net/yacy/kelondro/rwi/Reference.java
reger 3b694b3935 add some javadoc to rwi wordreference distance, position
to remember facts for http://mantis.tokeek.de/view.php?id=683
Init missing word position to 0 like in other non text body words
2016-09-14 00:36:19 +02:00

89 lines
2.5 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);
/**
* Positions or 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 search query word
* which has been joined (by join() )
* @return list with word position
*/
public Collection<Integer> positions();
/**
* max position of search query words (for multi word queries)
* @return
*/
public int maxposition();
/**
* min word position of search query words (for multi word queries)
* @return
*/
public int minposition();
/**
* The average distance (in words) between search query terms for multi word searches.
* The distance is calculated from positions()
* @return word distance
*/
public int distance();
}