lux

Interface DocWriter

All Known Implementing Classes:

DirectDocWriter, SolrDocWriter

public interface DocWriter

DocWriter supports the insertion and deletion of documents via xquery. Writes and deletes are not visible until commit() is called, and never within the same query.

Method Summary

Methods

Modifier and Type	Method and Description
void	close(Evaluator eval) Perform any cleanup, including a commit.
void	commit(Evaluator eval) Registers a commit that will be performed after the completion of the query.
void	delete(String uri) Deletes the document having the given uri, if it exists.
void	deleteAll() Deletes all documents in the index.
void	write(net.sf.saxon.om.NodeInfo node, String uri) Writes a document to the index at the given uri, with the node as its root element.

Method Detail

write

void write(net.sf.saxon.om.NodeInfo node,
         String uri)

Writes a document to the index at the given uri, with the node as its root element. Any existing document with the same uri will be overwritten.

Parameters:

node - A node to write as a document

uri - The uri of the document

delete

void delete(String uri)

Deletes the document having the given uri, if it exists.

Parameters:

uri -

deleteAll

void deleteAll()

Deletes all documents in the index.

commit

void commit(Evaluator eval)

Registers a commit that will be performed after the completion of the query. Once complete, all pending changes are saved to the index and made visible to readers.

Parameters:

eval - the evaluator providing an operating context in which the commit is to be performed.

close

void close(Evaluator eval)

Perform any cleanup, including a commit.

Parameters:

eval - the evaluator providing an operating context in which the commit is to be performed.