Package org.icij.datashare.text.indexing

Interface Indexer

All Superinterfaces:

AutoCloseable, Closeable

public interface Indexer
extends Closeable

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Indexer.Searcher

Field Summary

Fields

Modifier and Type	Field	Description
static org.slf4j.Logger	LOGGER

Method Summary

Modifier and Type	Method	Description
<T extends Entity> void	add(String indexName, T obj)
<T extends Entity> boolean	bulkAdd(String indexName, List<T> entities)
boolean	bulkAdd(String indexName, Pipeline.Type nerType, List<NamedEntity> namedEntities, Document parent)
<T extends Entity> boolean	bulkUpdate(String indexName, List<T> entities)
void	close()
boolean	createIndex(String indexName)
boolean	deleteAll(String indexName)
String	executeRaw(String method, String url, String body)
<T extends Entity> T	get(String indexName, String id)
<T extends Entity> T	get(String indexName, String id, String root)
ExtractedText	getExtractedText(String indexName, String documentId, int offset, int limit)
ExtractedText	getExtractedText(String indexName, String documentId, int offset, int limit, String targetLanguage)
ExtractedText	getExtractedText(String indexName, String documentId, String rootDocument, int offset, int limit)
ExtractedText	getExtractedText(String indexName, String documentId, String rootDocument, int offset, int limit, String targetLanguage)
boolean	getHealth()
Indexer.Searcher	search(List<String> indexesNames, Class<? extends Entity> entityClass)
SearchedText	searchTextOccurrences(String indexName, String documentId, String query, String targetLanguage)
SearchedText	searchTextOccurrences(String indexName, String documentId, String rootDocument, String query, String targetLanguage)
boolean	tag(Project prj, String documentId, String rootDocument, Tag... tags)
boolean	tag(Project prj, List<String> documentIds, Tag... tags)
boolean	untag(Project prj, String documentId, String rootDocument, Tag... tags)
boolean	untag(Project prj, List<String> documentIds, Tag... tags)
<T extends Entity> void	update(String indexName, T obj)

Field Detail

LOGGER

static final org.slf4j.Logger LOGGER

Method Detail

search

Indexer.Searcher search(List<String> indexesNames,
                        Class<? extends Entity> entityClass)

createIndex

boolean createIndex(String indexName)
             throws IOException

Throws:

IOException

deleteAll

boolean deleteAll(String indexName)
           throws IOException

Throws:

IOException

getHealth

boolean getHealth()

close

void close()
    throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

bulkAdd

boolean bulkAdd(String indexName,
                Pipeline.Type nerType,
                List<NamedEntity> namedEntities,
                Document parent)
         throws IOException

Throws:

IOException

bulkAdd

<T extends Entity> boolean bulkAdd(String indexName,
                                   List<T> entities)
                            throws IOException

Throws:

IOException

bulkUpdate

<T extends Entity> boolean bulkUpdate(String indexName,
                                      List<T> entities)
                               throws IOException

Throws:

IOException

add

<T extends Entity> void add(String indexName,
                            T obj)
                     throws IOException

Throws:

IOException

update

<T extends Entity> void update(String indexName,
                               T obj)
                        throws IOException

Throws:

IOException

get

<T extends Entity> T get(String indexName,
                         String id)

get

<T extends Entity> T get(String indexName,
                         String id,
                         String root)

executeRaw

String executeRaw(String method,
                  String url,
                  String body)
           throws IOException

Throws:

IOException

tag

boolean tag(Project prj,
            String documentId,
            String rootDocument,
            Tag... tags)
     throws IOException

Throws:

IOException

untag

boolean untag(Project prj,
              String documentId,
              String rootDocument,
              Tag... tags)
       throws IOException

Throws:

IOException

tag

boolean tag(Project prj,
            List<String> documentIds,
            Tag... tags)
     throws IOException

Throws:

IOException

untag

boolean untag(Project prj,
              List<String> documentIds,
              Tag... tags)
       throws IOException

Throws:

IOException

getExtractedText

ExtractedText getExtractedText(String indexName,
                               String documentId,
                               int offset,
                               int limit)
                        throws IOException

Throws:

IOException

getExtractedText

ExtractedText getExtractedText(String indexName,
                               String documentId,
                               String rootDocument,
                               int offset,
                               int limit)
                        throws IOException

Throws:

IOException

getExtractedText

ExtractedText getExtractedText(String indexName,
                               String documentId,
                               int offset,
                               int limit,
                               String targetLanguage)
                        throws IOException

Throws:

IOException

getExtractedText

ExtractedText getExtractedText(String indexName,
                               String documentId,
                               String rootDocument,
                               int offset,
                               int limit,
                               String targetLanguage)
                        throws IOException

Throws:

IOException

searchTextOccurrences

SearchedText searchTextOccurrences(String indexName,
                                   String documentId,
                                   String query,
                                   String targetLanguage)
                            throws IOException

Throws:

IOException

searchTextOccurrences

SearchedText searchTextOccurrences(String indexName,
                                   String documentId,
                                   String rootDocument,
                                   String query,
                                   String targetLanguage)
                            throws IOException

Throws:

IOException