|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.Observable
org.exist.storage.TextSearchEngine
public abstract class TextSearchEngine
This is the base class for all classes providing access to the fulltext index. The class has methods to add text and attribute nodes to the fulltext index, or to search for nodes matching selected search terms.
Field Summary | |
---|---|
static String |
CONFIGURATION_STOPWORDS_ELEMENT_NAME
|
static String |
INDEX_NUMBERS_ATTRIBUTE
|
static String |
PROPERTY_INDEX_NUMBERS
|
static String |
PROPERTY_STEM
|
static String |
PROPERTY_STOPWORD_FILE
|
static String |
PROPERTY_STORE_TERM_FREQUENCY
|
static String |
PROPERTY_TOKENIZER
|
static String |
STEM_ATTRIBUTE
|
static String |
STOPWORD_FILE_ATTRIBUTE
|
static String |
STORE_TERM_FREQUENCY_ATTRIBUTE
|
static String |
TOKENIZER_ATTRIBUTE
|
Constructor Summary | |
---|---|
TextSearchEngine(DBBroker broker,
Configuration conf)
Construct a new instance and configure it. |
Method Summary | |
---|---|
abstract boolean |
close()
|
abstract void |
dropIndex(Collection collection)
Remove index entries for an entire collection. |
abstract void |
dropIndex(DocumentImpl doc)
Remove all index entries for the given document. |
abstract void |
flush()
|
abstract String[] |
getIndexTerms(DocumentSet docs,
TermMatcher matcher)
|
abstract NodeSet |
getNodes(XQueryContext context,
DocumentSet docs,
NodeSet contextSet,
int axis,
QName qname,
TermMatcher matcher,
CharSequence startTerm)
|
NodeSet |
getNodesContaining(XQueryContext context,
DocumentSet docs,
NodeSet contextSet,
int axis,
QName qname,
String expr,
int type)
|
abstract NodeSet |
getNodesContaining(XQueryContext context,
DocumentSet docs,
NodeSet contextSet,
int axis,
QName qname,
String expr,
int type,
boolean matchAll)
For each of the given search terms and each of the documents in the document set, return a node-set of matching nodes. |
Tokenizer |
getTokenizer()
Returns the Tokenizer used for tokenizing strings into words. |
int |
getTrackMatches()
|
abstract Occurrences[] |
scanIndexTerms(DocumentSet docs,
NodeSet contextSet,
QName[] qnames,
String start,
String end)
|
abstract Occurrences[] |
scanIndexTerms(DocumentSet docs,
NodeSet contextSet,
String start,
String end)
Queries the fulltext index to retrieve information on indexed words contained in the index for the current collection. |
void |
setTrackMatches(int flags)
|
abstract void |
storeText(StoredNode parent,
ElementContent text,
int indexingHint,
FulltextIndexSpec indexSpec,
boolean remove)
|
abstract void |
storeText(TextImpl node,
int indexingHint,
FulltextIndexSpec indexSpec,
boolean remove)
Tokenize and index the given text node. |
Methods inherited from class java.util.Observable |
---|
addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String INDEX_NUMBERS_ATTRIBUTE
public static final String STEM_ATTRIBUTE
public static final String STORE_TERM_FREQUENCY_ATTRIBUTE
public static final String TOKENIZER_ATTRIBUTE
public static final String CONFIGURATION_STOPWORDS_ELEMENT_NAME
public static final String STOPWORD_FILE_ATTRIBUTE
public static final String PROPERTY_INDEX_NUMBERS
public static final String PROPERTY_STEM
public static final String PROPERTY_STORE_TERM_FREQUENCY
public static final String PROPERTY_TOKENIZER
public static final String PROPERTY_STOPWORD_FILE
Constructor Detail |
---|
public TextSearchEngine(DBBroker broker, Configuration conf)
broker
- conf
- Method Detail |
---|
public Tokenizer getTokenizer()
public abstract void storeText(TextImpl node, int indexingHint, FulltextIndexSpec indexSpec, boolean remove)
indexSpec
- node
- public abstract void storeText(StoredNode parent, ElementContent text, int indexingHint, FulltextIndexSpec indexSpec, boolean remove)
public abstract void flush()
public abstract boolean close() throws DBException
DBException
public int getTrackMatches()
public void setTrackMatches(int flags)
public NodeSet getNodesContaining(XQueryContext context, DocumentSet docs, NodeSet contextSet, int axis, QName qname, String expr, int type) throws TerminatedException
TerminatedException
public abstract NodeSet getNodesContaining(XQueryContext context, DocumentSet docs, NodeSet contextSet, int axis, QName qname, String expr, int type, boolean matchAll) throws TerminatedException
TerminatedException
public abstract NodeSet getNodes(XQueryContext context, DocumentSet docs, NodeSet contextSet, int axis, QName qname, TermMatcher matcher, CharSequence startTerm) throws TerminatedException
TerminatedException
public abstract Occurrences[] scanIndexTerms(DocumentSet docs, NodeSet contextSet, String start, String end) throws PermissionDeniedException
Occurrences
for all
words contained in the index. If param end is null, all words starting with
the string sequence param start are returned. Otherwise, the method
returns all words that come after start and before end in lexical order.
PermissionDeniedException
public abstract Occurrences[] scanIndexTerms(DocumentSet docs, NodeSet contextSet, QName[] qnames, String start, String end) throws PermissionDeniedException
PermissionDeniedException
public abstract String[] getIndexTerms(DocumentSet docs, TermMatcher matcher)
public abstract void dropIndex(Collection collection)
collection
- public abstract void dropIndex(DocumentImpl doc)
doc
-
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |