MXQuery 0.6.0 API Documentation - Copyright 2006-2009 ETH Zurich

ch.ethz.mxquery.sms.ftstore
Interface FullTextStore

All Superinterfaces:
Source
All Known Implementing Classes:
FTTokenBufferStore

public interface FullTextStore
extends Source

Interface for a FullTextStore


Method Summary
 double getInverseDocumentFrequency(java.lang.String word)
           
 LinguisticToken getLinguisticTokens(DeweyIdentifier did)
           
 PhraseIterator getLinguisticTokensExact(java.lang.String word)
           
 PhraseIterator getLinguisticTokensWithInfix(java.lang.String prefix, java.lang.String suffix, java.lang.String wildcard)
           
 PhraseIterator getLinguisticTokensWithPrefix(java.lang.String suffix, java.lang.String wildcard)
           
 PhraseIterator getLinguisticTokensWithSuffix(java.lang.String prefix, java.lang.String wildcard)
           
 PhraseIterator getPhraseExact(java.util.Vector phrase, DeweyIdentifier[] ignoreId)
           
 PhraseIterator getPhraseWithWildcard(java.lang.String phrase, DeweyIdentifier[] ignoreId)
           
 java.util.Vector getWordsForMultipleWildCard(java.lang.String word)
           
 java.util.Vector getWordsForStem(java.lang.String stem)
           
 java.util.Vector getWordsWithInfix(java.lang.String prefix, java.lang.String suffix, java.lang.String wildcard)
           
 java.util.Vector getWordsWithPrefix(java.lang.String suffix, java.lang.String wildcard)
           
 java.util.Vector getWordsWithSuffix(java.lang.String prefix, java.lang.String wildcard)
           
 
Methods inherited from interface ch.ethz.mxquery.datamodel.Source
compare, copySource, getIterator, getURI
 

Method Detail

getLinguisticTokens

LinguisticToken getLinguisticTokens(DeweyIdentifier did)
Parameters:
did -
Returns:
iterator over the Linguistic Tokens sequentially following the linguistic token with dewey id "did".

getLinguisticTokensExact

PhraseIterator getLinguisticTokensExact(java.lang.String word)
Parameters:
word -
Returns:
iterator over the corresponding Linguistic Token of word "word".

getLinguisticTokensWithSuffix

PhraseIterator getLinguisticTokensWithSuffix(java.lang.String prefix,
                                             java.lang.String wildcard)
Parameters:
prefix -
Returns:
iterator over the corresponding Linguistic Token of words that have "prefix" as prefix.

getLinguisticTokensWithPrefix

PhraseIterator getLinguisticTokensWithPrefix(java.lang.String suffix,
                                             java.lang.String wildcard)
Parameters:
suffix -
Returns:
iterator over the corresponding Linguistic Token of words that have "suffix" as suffix.

getLinguisticTokensWithInfix

PhraseIterator getLinguisticTokensWithInfix(java.lang.String prefix,
                                            java.lang.String suffix,
                                            java.lang.String wildcard)
Parameters:
prefix -
suffix -
Returns:
iterator over the corresponding Linguistic Token of words that have "prefix" as prefix and "suffix" as suffix

getWordsForMultipleWildCard

java.util.Vector getWordsForMultipleWildCard(java.lang.String word)
Parameters:
word -
Returns:
set of words that fulfill "word" with its wildcards.

getWordsWithSuffix

java.util.Vector getWordsWithSuffix(java.lang.String prefix,
                                    java.lang.String wildcard)
Parameters:
prefix -
Returns:
set of words that have "prefix" as prefix.

getWordsWithPrefix

java.util.Vector getWordsWithPrefix(java.lang.String suffix,
                                    java.lang.String wildcard)
Parameters:
suffix -
Returns:
set of words that have "suffix" as suffix.

getWordsWithInfix

java.util.Vector getWordsWithInfix(java.lang.String prefix,
                                   java.lang.String suffix,
                                   java.lang.String wildcard)
Parameters:
prefix -
suffix -
Returns:
set of words that have "prefix" as prefix and "suffix" as suffix

getWordsForStem

java.util.Vector getWordsForStem(java.lang.String stem)
Parameters:
stem -
Returns:
words that have stem "stem".

getPhraseExact

PhraseIterator getPhraseExact(java.util.Vector phrase,
                              DeweyIdentifier[] ignoreId)
                              throws MXQueryException
Parameters:
phrase -
Returns:
iterator over the sets of Linguistic Tokens that fulfill the phrase predicate "phrase".
Throws:
MXQueryException

getPhraseWithWildcard

PhraseIterator getPhraseWithWildcard(java.lang.String phrase,
                                     DeweyIdentifier[] ignoreId)
                                     throws MXQueryException
Parameters:
phrase -
Returns:
iterator over the sets of Linguistic Tokens that fulfill the phrase predicate "phrase" containing wildcards.
Throws:
MXQueryException

getInverseDocumentFrequency

double getInverseDocumentFrequency(java.lang.String word)
Parameters:
word -
Returns:
the precomputed idf for document collections

MXQuery 0.6.0 API Documentation - Copyright 2006-2009 ETH Zurich

MXQuery 0.6.0 API Documentation - Copyright 2006-2009 ETH Zurich