Interface StardocsConnection

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods 
      Modifier and Type Method Description
      void clear()
      Deprecated.
      Delete ALL documents including contents and assertions in the current database's document store.
      void deleteDocument​(java.lang.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.
      java.io.InputStream getDocument​(java.lang.String theDocName)
      Deprecated.
      Return a documents contents.
      IRI putDocument​(java.lang.String theDocName, java.io.InputStream theDocContents)
      Deprecated.
      Add/update a document.
      default IRI putDocument​(java.lang.String theDocName, java.io.InputStream theDocContents, java.lang.Iterable<java.lang.String> theRDFExtractorNames, java.lang.Iterable<java.lang.String> theTextExtractorNames)
      Deprecated.
      Add/update a document.
      IRI putDocument​(java.lang.String theDocName, java.io.InputStream theDocContents, java.lang.Iterable<java.lang.String> theRDFExtractorNames, java.lang.Iterable<java.lang.String> theTextExtractorNames, boolean theKeepAssertions)
      Deprecated.
      Add/update a document.
      IRI putDocument​(java.nio.file.Path file)
      Deprecated.
      Add/update a document.
      default void reindex​(java.lang.Iterable<java.lang.String> theRDFExtractorNames, java.lang.Iterable<java.lang.String> theTextExtractorNames)
      Deprecated.
      Reindex all documents in the document store, replacing previous assertions.
      void reindex​(java.lang.Iterable<java.lang.String> theRDFExtractorNames, java.lang.Iterable<java.lang.String> theTextExtractorNames, boolean theKeepAssertions)
      Deprecated.
      Reindex all documents in the document store, optionally replacing previous assertions.
    • Method Detail

      • putDocument

        default IRI putDocument​(java.lang.String theDocName,
                                java.io.InputStream theDocContents,
                                java.lang.Iterable<java.lang.String> theRDFExtractorNames,
                                java.lang.Iterable<java.lang.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​(java.lang.String theDocName,
                        java.io.InputStream theDocContents,
                        java.lang.Iterable<java.lang.String> theRDFExtractorNames,
                        java.lang.Iterable<java.lang.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​(java.lang.String theDocName,
                        java.io.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​(java.nio.file.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

        java.io.InputStream getDocument​(java.lang.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​(java.lang.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​(java.lang.Iterable<java.lang.String> theRDFExtractorNames,
                             java.lang.Iterable<java.lang.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​(java.lang.Iterable<java.lang.String> theRDFExtractorNames,
                     java.lang.Iterable<java.lang.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.