com.complexible.stardog.docs

Interface StardocsConnection

All Superinterfaces:

AutoCloseable, Connection

All Known Subinterfaces:

BitesConnection

Deprecated.

@Deprecated
public interface StardocsConnection
extends Connection

Backward compatibility API for BitesConnection

Method Summary

Modifier and Type	Method and Description
void	clear() Deprecated. Delete ALL documents including contents and assertions in the current database's document store.
void	deleteDocument(String theDocName) Deprecated. Delete a document from the document store.
long	documentCount() Deprecated. Return a count of all the documents in the current database's document store.
InputStream	getDocument(String theDocName) Deprecated. Return a documents contents.
IRI	putDocument(Path file) Deprecated. Add/update a document.
IRI	putDocument(String theDocName, InputStream theDocContents) Deprecated. Add/update a document.
default IRI	putDocument(String theDocName, InputStream theDocContents, Iterable<String> theRDFExtractorNames, Iterable<String> theTextExtractorNames) Deprecated. Add/update a document.
IRI	putDocument(String theDocName, InputStream theDocContents, Iterable<String> theRDFExtractorNames, Iterable<String> theTextExtractorNames, boolean theKeepAssertions) Deprecated. Add/update a document.
default void	reindex(Iterable<String> theRDFExtractorNames, Iterable<String> theTextExtractorNames) Deprecated. Reindex all documents in the document store, replacing previous assertions.
void	reindex(Iterable<String> theRDFExtractorNames, Iterable<String> theTextExtractorNames, boolean theKeepAssertions) Deprecated. Reindex all documents in the document store, optionally replacing previous assertions.

Methods inherited from interface com.complexible.stardog.api.Connection

add, admin, as, ask, ask, begin, close, commit, currentStatus, export, generateModel, get, getOption, getSchema, graph, graph, graphAliases, isOpen, isReasoningEnabled, name, namespaces, paths, paths, remove, rollback, select, select, selectPlan, selectPlan, size, transactions, update, update

Method Detail

putDocument

default IRI putDocument(String theDocName,
                        InputStream theDocContents,
                        Iterable<String> theRDFExtractorNames,
                        Iterable<String> theTextExtractorNames)

Deprecated.

Add/update a document. If the document with the given name does not exist in the document store, it will be created. If it does exist, the assertions will be replaced by those extracted from the new contents.

Parameters:

theDocName - The name of the document in the document store.

theDocContents - The contents of the document to be added/updated.

theRDFExtractorNames - A sequence of RDF extractor names to be used when processing this document. If null, use the default extractor(s) for the current database.

theTextExtractorNames - A sequence of text extractor names to be used when processing this document. If null, use the default extractor(s) for the current database.

Returns:

The IRI of the document in the document store.

putDocument

IRI putDocument(String theDocName,
                InputStream theDocContents,
                Iterable<String> theRDFExtractorNames,
                Iterable<String> theTextExtractorNames,
                boolean theKeepAssertions)

Deprecated.

Add/update a document. If the document with the given name does not exist in the document store, it will be created. If it does exist, the assertions can be optionally replaced by those extracted from the new contents.

Parameters:

theDocName - The name of the document in the document store.

theDocContents - The contents of the document to be added/updated.

theRDFExtractorNames - A sequence of RDF extractor names to be used when processing this document. If null, use the default extractor(s) for the current database.

theTextExtractorNames - A sequence of text extractor names to be used when processing this document. If null, use the default extractor(s) for the current database.

theKeepAssertions - Whether existent assertions should be kept or replaced by those extracted from the new contents.

Returns:

The IRI of the document in the document store.

putDocument

IRI putDocument(String theDocName,
                InputStream theDocContents)

Deprecated.

Add/update a document. If the document with the given name does not exist in the document store, it will be created. If it does exist, the assertions will be replaced by those extracted from the new contents.

Parameters:

theDocName - The name of the document in the document store.

theDocContents - The contents of the document to be added/updated.

Returns:

The IRI of the document in the document store.

putDocument

IRI putDocument(Path file)

Deprecated.

Add/update a document. If the document with the given name does not exist in the document store, it will be created. If it does exist, the assertions will be replaced by those extracts from the new contents.

Parameters:

file - The file to be added to the document store. The file's name will be used as the document name.

Returns:

The IRI of the document in the document store.

getDocument

InputStream getDocument(String theDocName)

Deprecated.

Return a documents contents.

Parameters:

theDocName - Name of the document for which to retrieve contents.

Returns:

an InputStream to read contents

deleteDocument

void deleteDocument(String theDocName)

Deprecated.

Delete a document from the document store. This will delete the document's contents as well as any RDF assertions and text index contents.

Parameters:

theDocName - Name of the document which to delete.

documentCount

long documentCount()

Deprecated.

Return a count of all the documents in the current database's document store.

reindex

default void reindex(Iterable<String> theRDFExtractorNames,
                     Iterable<String> theTextExtractorNames)

Deprecated.

Reindex all documents in the document store, replacing previous assertions.

Parameters:

theRDFExtractorNames - A sequence of RDF extractor names to be used when processing this document. If null, use the default extractor(s) for the current database.

theTextExtractorNames - A sequence of text extractor names to be used when processing this document. If null, use the default extractor(s) for the current database.

reindex

void reindex(Iterable<String> theRDFExtractorNames,
             Iterable<String> theTextExtractorNames,
             boolean theKeepAssertions)

Deprecated.

Reindex all documents in the document store, optionally replacing previous assertions.

Parameters:

theRDFExtractorNames - A sequence of RDF extractor names to be used when processing this document. If null, use the default extractor(s) for the current database.

theTextExtractorNames - A sequence of text extractor names to be used when processing this document. If null, use the default extractor(s) for the current database.

theKeepAssertions - Whether existent assertions should be kept or replaced by those extracted from the new contents.

clear

void clear()

Deprecated.

Delete ALL documents including contents and assertions in the current database's document store.