org.finra.herd.dao

Interface IndexFunctionsDao

All Superinterfaces:

BaseJpaDao

All Known Implementing Classes:

IndexFunctionsDaoImpl

public interface IndexFunctionsDao
extends BaseJpaDao

Method Summary

Modifier and Type	Method and Description
void	createIndex(String indexName, String mapping, String settings, String alias) The create index function will take as arguments the index name, and mapping and will create a new index.
void	createIndexDocument(String indexName, String id, String json) The index function will take as arguments indexName, id, json and add the document to the index.
void	createIndexDocuments(String indexName, Map<String,String> documentMap) The create index documents function will take as arguments the index name, and a map of new documents.
void	deleteDocumentById(String indexName, String id) The delete document by id function will delete a document in the index by the document id.
void	deleteIndex(String indexName) The delete index function will take as an argument the index name and will delete the index.
void	deleteIndexDocuments(String indexName, List<Long> ids) The delete index documents function will delete a list of document in the index by a list of document ids.
List<String>	getIdsInIndex(String indexName) The ids in index function will take as arguments the index name and will return a list of all the ids in the index.
Settings	getIndexSettings(String indexName) Get the index settings
DocsStats	getIndexStats(String indexName) Get index statistics
long	getNumberOfTypesInIndex(String indexName) The number of types in index function will take as arguments the index name and will return the number of documents in the index.
boolean	isIndexExists(String indexName) The index exists predicate will take as an argument the index name and will return tree if the index exists and false otherwise.
boolean	isValidDocumentIndex(String indexName, String id, String json) The isValid function will take as arguments indexName, id, json and validate the document against the index and return true if the document is valid and false otherwise.
void	updateIndexDocuments(String indexName, Map<String,String> documentMap) The update index documents function will take as arguments the index name and a map of documents to update.
void	validateDocumentIndex(String indexName, String id, String json) The validate function will take as arguments indexName, id, json and validate the document against the index.

Methods inherited from interface org.finra.herd.dao.BaseJpaDao

delete, detach, findAll, findById, findByNamedProperties, findUniqueByNamedProperties, getCurrentTimestamp, getEntityManager, query, queryByNamedParams, save, saveAndRefresh

Method Detail

createIndexDocument

void createIndexDocument(String indexName,
                         String id,
                         String json)

The index function will take as arguments indexName, id, json and add the document to the index.

Parameters:

indexName - index name

id - id

json - json

getNumberOfTypesInIndex

long getNumberOfTypesInIndex(String indexName)

The number of types in index function will take as arguments the index name and will return the number of documents in the index.

Parameters:

indexName - index name

Returns:

number of types in index

isValidDocumentIndex

boolean isValidDocumentIndex(String indexName,
                             String id,
                             String json)

The isValid function will take as arguments indexName, id, json and validate the document against the index and return true if the document is valid and false otherwise.

Parameters:

indexName - index name

id - id

json - json

Returns:

is valid

createIndexDocuments

void createIndexDocuments(String indexName,
                          Map<String,String> documentMap)

The create index documents function will take as arguments the index name, and a map of new documents. The document map key is the document id, and the value is the document as a JSON string.

Parameters:

indexName - index name

documentMap - document map

isIndexExists

boolean isIndexExists(String indexName)

The index exists predicate will take as an argument the index name and will return tree if the index exists and false otherwise.

Parameters:

indexName - index name

Returns:

is index exist

deleteIndex

void deleteIndex(String indexName)

The delete index function will take as an argument the index name and will delete the index.

Parameters:

indexName - indexName

validateDocumentIndex

void validateDocumentIndex(String indexName,
                           String id,
                           String json)

The validate function will take as arguments indexName, id, json and validate the document against the index.

Parameters:

indexName - index name

id - id

json - json

createIndex

void createIndex(String indexName,
                 String mapping,
                 String settings,
                 String alias)

The create index function will take as arguments the index name, and mapping and will create a new index.

Parameters:

indexName - index name

mapping - mapping

settings - setting

alias - alias

deleteDocumentById

void deleteDocumentById(String indexName,
                        String id)

The delete document by id function will delete a document in the index by the document id.

Parameters:

indexName - index name

id - id

deleteIndexDocuments

void deleteIndexDocuments(String indexName,
                          List<Long> ids)

The delete index documents function will delete a list of document in the index by a list of document ids.

Parameters:

indexName - the name of the index where the document exists.

ids - the ids of the documents to delete.

getIdsInIndex

List<String> getIdsInIndex(String indexName)

The ids in index function will take as arguments the index name and will return a list of all the ids in the index.

Parameters:

indexName - index name

Returns:

list of ids

updateIndexDocuments

void updateIndexDocuments(String indexName,
                          Map<String,String> documentMap)

The update index documents function will take as arguments the index name and a map of documents to update. The document map key is the document id, and the value is the document as a JSON string.

Parameters:

indexName - index name

documentMap - document map

getIndexSettings

Settings getIndexSettings(String indexName)

Get the index settings

Parameters:

indexName - index name

Returns:

index settings

getIndexStats

DocsStats getIndexStats(String indexName)

Get index statistics

Parameters:

indexName - index name

Returns:

index stats