prajna.data.query

Class ProximitySearch

java.lang.Object

prajna.data.DataFilter

prajna.data.query.DocFilter

prajna.data.query.ProximitySearch

All Implemented Interfaces:

java.io.Serializable

public class ProximitySearch
extends DocFilter

Represents a proximity search. This filter searches to determine if two words occur within some word count of each other.

Author:

Edward Swing

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ProximitySearch(java.lang.String term1, java.lang.String term2) Create a proximity search filter.
ProximitySearch(java.lang.String term1, java.lang.String term2, int distance) Create a proximity search filter.
ProximitySearch(java.lang.String term1, java.lang.String term2, int distance, boolean isOrdered) Create a proximity search filter

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accept(DataRecord rec) Return whether the DataRecord is accepted by this filter.
int	getDistance() Get the distance for this ProximitySearch
java.lang.String	getTerm1() Get the first term for this ProximitySearch
java.lang.String	getTerm2() Get the second term for this ProximitySearch
boolean	isOrdered() Return whether this ProximitySearch is ordered.
protected boolean	matchDoc(DocData doc) Return whether the represented document is accepted by this filter.
boolean	matchText(java.lang.String text) Match this filter against the body of text
void	setTerm1(java.lang.String term) Set the first term for this ProximitySearch
void	setTerm2(java.lang.String term) Set the second term for this ProximitySearch
java.lang.String	toString() Return a string representation of this search.

Methods inherited from class prajna.data.query.DocFilter

accept, filterDocuments, getTag, setTag

Methods inherited from class prajna.data.DataFilter

filterRecords

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ProximitySearch

public ProximitySearch(java.lang.String term1,
               java.lang.String term2)

Create a proximity search filter. By default, this creates an unordered search with a distance of 3.

Parameters:

term1 - the first word to search for

term2 - the second word to search for

ProximitySearch

public ProximitySearch(java.lang.String term1,
               java.lang.String term2,
               int distance)

Create a proximity search filter. By default, this creates an unordered search

Parameters:

term1 - the first word to search for

term2 - the second word to search for

distance - the number of words which can be between term1 and term2

ProximitySearch

public ProximitySearch(java.lang.String term1,
               java.lang.String term2,
               int distance,
               boolean isOrdered)

Create a proximity search filter

Parameters:

term1 - the first word to search for

term2 - the second word to search for

distance - the number of words which can be between term1 and term2

isOrdered - whether the order of term1 and term2 is important. If this flag is true, the filter only matches when term1 precedes term2 within the allowed distance.

Method Detail

accept

public boolean accept(DataRecord rec)

Return whether the DataRecord is accepted by this filter.

Specified by:

accept in class DataFilter

Parameters:

rec - the data record to match.

Returns:

true if the record matches the filter, false otherwise

getDistance

public int getDistance()

Get the distance for this ProximitySearch

Returns:

the distance

getTerm1

public java.lang.String getTerm1()

Get the first term for this ProximitySearch

Returns:

the first term

getTerm2

public java.lang.String getTerm2()

Get the second term for this ProximitySearch

Returns:

the second term

isOrdered

public boolean isOrdered()

Return whether this ProximitySearch is ordered. If the proximity search is ordered, then term1 must precede term2. Otherwise, term1 and term2 may occur in any order.

Returns:

true if the proximity search is ordered, false otherwise

matchDoc

protected boolean matchDoc(DocData doc)

Return whether the represented document is accepted by this filter.

Specified by:

matchDoc in class DocFilter

Parameters:

doc - the document record to match.

Returns:

true if the document matches the filter, false otherwise

matchText

public boolean matchText(java.lang.String text)

Match this filter against the body of text

Parameters:

text - the text to check against

Returns:

true if this filter matches the text body, false otherwise

setTerm1

public void setTerm1(java.lang.String term)

Set the first term for this ProximitySearch

Parameters:

term - the first term

setTerm2

public void setTerm2(java.lang.String term)

Set the second term for this ProximitySearch

Parameters:

term - the second term

toString

public java.lang.String toString()

Return a string representation of this search.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this search