websearch
Class SearchResultDoc

java.lang.Object
  websearch.SearchResultDoc

All Implemented Interfaces:

ClusterDoc, java.lang.Comparable<ClusterDoc>

public class SearchResultDoc
extends java.lang.Object
implements ClusterDoc

A document that implements the methods needed to be clustered
Also includes some functionality for cleaning up the results from the snippets of the search engines

Author:

davidc

Constructor Summary

SearchResultDoc(java.lang.String title, java.lang.String snippet, java.lang.String url, VectorManager vm)

Method Summary

void	addTermSetCount(Phrase termSet, int n) This document should record how frequently this termSet occured
void	checkSourceExists() Throw an exception if this file won't be cluster-able
static java.lang.String	clean(java.lang.String s)
int	compareTo(ClusterDoc arg0) Assuming that arg0 is a SearchResultDoc
void	destroyLocalDoc() After finding how often all the phrases are in this doc, this method should allow the supporting document to be released to free up memory.
java.lang.String	getDocId()
java.lang.String[][]	getFixedWordSentences() Each String should be fixed by VectorManager before being returned
int[][]	getIdxSentences(VectorManager vm) Each entry represents the integer.
int	getNumInstancesOfTermSet(Phrase s) Each document should get a unique id
java.lang.String[][]	getSentences()
java.lang.String	getSnippet()
java.lang.String	getSrc()
double	getTermSetsSupported()
java.lang.String	getTitle()
java.lang.String	getUrl()
boolean	isJunkPhrase(java.lang.String phrase) Added to allow differentiation between phrases of scientific articles and general search results
void	loadWindowedDoc() Initially, the idea was to support proximity windows (eg.
void	setUrl(java.lang.String url)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchResultDoc

public SearchResultDoc(java.lang.String title,
                       java.lang.String snippet,
                       java.lang.String url,
                       VectorManager vm)

Method Detail

addTermSetCount

public void addTermSetCount(Phrase termSet,
                            int n)

Description copied from interface: ClusterDoc

This document should record how frequently this termSet occured

Specified by:

addTermSetCount in interface ClusterDoc

getNumInstancesOfTermSet

public int getNumInstancesOfTermSet(Phrase s)

Description copied from interface: ClusterDoc

Each document should get a unique id

Specified by:

getNumInstancesOfTermSet in interface ClusterDoc

Returns:

getTermSetsSupported

public double getTermSetsSupported()

Specified by:

getTermSetsSupported in interface ClusterDoc

checkSourceExists

public void checkSourceExists()
                       throws java.io.FileNotFoundException

Description copied from interface: ClusterDoc

Throw an exception if this file won't be cluster-able

Specified by:

checkSourceExists in interface ClusterDoc

Throws:

java.io.FileNotFoundException

getFixedWordSentences

public java.lang.String[][] getFixedWordSentences()
                                           throws java.io.FileNotFoundException,
                                                  java.io.IOException

Description copied from interface: ClusterDoc

Each String should be fixed by VectorManager before being returned

Specified by:

getFixedWordSentences in interface ClusterDoc

Returns:

Throws:

java.io.FileNotFoundException

java.io.IOException

getIdxSentences

public int[][] getIdxSentences(VectorManager vm)

Description copied from interface: ClusterDoc

Each entry represents the integer. This method possibly allows PhraseFinder to save time while finding frequent phrases.
Notice that the dimensions returned here should be exactly the same as those returned in getFixedWordSentences()

Specified by:

getIdxSentences in interface ClusterDoc

Returns:

getSentences

public java.lang.String[][] getSentences()
                                  throws java.io.FileNotFoundException,
                                         java.io.IOException

Specified by:

getSentences in interface ClusterDoc

Throws:

java.io.FileNotFoundException

java.io.IOException

loadWindowedDoc

public void loadWindowedDoc()

Description copied from interface: ClusterDoc

Initially, the idea was to support proximity windows (eg. phrases of 5 words excluding stopwords) but just using each sentence as a window yields good results with much better performance.

Specified by:

loadWindowedDoc in interface ClusterDoc

destroyLocalDoc

public void destroyLocalDoc()

Description copied from interface: ClusterDoc

After finding how often all the phrases are in this doc, this method should allow the supporting document to be released to free up memory.

Specified by:

destroyLocalDoc in interface ClusterDoc

compareTo

public int compareTo(ClusterDoc arg0)

Assuming that arg0 is a SearchResultDoc

Specified by:

compareTo in interface java.lang.Comparable<ClusterDoc>

Parameters:

arg0 -

Returns:

clean

public static java.lang.String clean(java.lang.String s)

getDocId

public java.lang.String getDocId()

isJunkPhrase

public boolean isJunkPhrase(java.lang.String phrase)

Description copied from interface: ClusterDoc

Added to allow differentiation between phrases of scientific articles and general search results

Specified by:

isJunkPhrase in interface ClusterDoc

Parameters:

phrase - Space-separated words

Returns:

getSrc

public java.lang.String getSrc()

getUrl

public java.lang.String getUrl()

setUrl

public void setUrl(java.lang.String url)

getSnippet

public java.lang.String getSnippet()

getTitle

public java.lang.String getTitle()