org.finra.herd.dao.impl

Class IndexFunctionsDaoImpl

java.lang.Object

org.finra.herd.dao.impl.BaseJpaDaoImpl

org.finra.herd.dao.impl.AbstractHerdDao

org.finra.herd.dao.impl.IndexFunctionsDaoImpl

All Implemented Interfaces:

BaseJpaDao, IndexFunctionsDao

@Repository
public class IndexFunctionsDaoImpl
extends AbstractHerdDao
implements IndexFunctionsDao

Nested Class Summary

Nested classes/interfaces inherited from class org.finra.herd.dao.impl.AbstractHerdDao

AbstractHerdDao.AggregateFunction

Field Summary

Fields

Modifier and Type	Field and Description
static int	ELASTIC_SEARCH_SCROLL_KEEP_ALIVE_TIME Scroll keep alive in milliseconds
static int	ELASTIC_SEARCH_SCROLL_PAGE_SIZE Page size

Fields inherited from class org.finra.herd.dao.impl.AbstractHerdDao

BUSINESS_OBJECT_DATA_PARTITIONS, BUSINESS_OBJECT_DATA_SUBPARTITIONS, configurationHelper, DEFAULT_SINGLE_DAY_DATE_MASK, MAX_PARTITION_FILTERS_PER_REQUEST

Fields inherited from class org.finra.herd.dao.impl.BaseJpaDaoImpl

entityManager

Constructor Summary

Constructors

Constructor and Description
IndexFunctionsDaoImpl()

Method Summary

Modifier and Type	Method and Description
void	createIndex(String indexName, String documentType, String mapping, String settings, String alias) The create index function will take as arguments the index name, document type, and mapping and will create a new index.
void	createIndexDocument(String indexName, String documentType, String id, String json) The index function will take as arguments indexName, documentType, id, json and add the document to the index.
void	createIndexDocuments(String indexName, String documentType, Map<String,String> documentMap) The create index documents function will take as arguments the index name, document type, and a map of new documents.
void	deleteDocumentById(String indexName, String documentType, 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, String documentType, List<Integer> 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, String documentType) The ids in index function will take as arguments the index name and the document type 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 docs stats
long	getNumberOfTypesInIndex(String indexName, String documentType) The number of types in index function will take as arguments the index name and the document type 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 documentType, String id, String json) The isValid function will take as arguments indexName, documentType, id, json and validate the document against the index and return true if the document is valid and false otherwise.
void	updateIndexDocuments(String indexName, String documentType, Map<String,String> documentMap) The update index documents function will take as arguments the index name, document type, and a map of documents to update.
void	validateDocumentIndex(String indexName, String documentType, String id, String json) The validate function will take as arguments indexName, documentType, id, json and validate the document against the index.

Methods inherited from class org.finra.herd.dao.impl.AbstractHerdDao

getMaximumBusinessObjectDataVersionSubQuery, getQueryRestriction, getQueryRestriction, getQueryRestriction, getQueryRestrictionOnBusinessObjectDataVersionAndStatus, getQueryRestrictionOnPartitionValues, getQueryRestrictionOnPartitionValues, getQueryRestrictionOnPartitionValues, getQueryRestrictionOnPartitionValues, getQueryRestrictionOnStorage, save

Methods inherited from class org.finra.herd.dao.impl.BaseJpaDaoImpl

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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

Field Detail

ELASTIC_SEARCH_SCROLL_PAGE_SIZE

public static final int ELASTIC_SEARCH_SCROLL_PAGE_SIZE

Page size

See Also:

Constant Field Values

ELASTIC_SEARCH_SCROLL_KEEP_ALIVE_TIME

public static final int ELASTIC_SEARCH_SCROLL_KEEP_ALIVE_TIME

Scroll keep alive in milliseconds

See Also:

Constant Field Values

Constructor Detail

IndexFunctionsDaoImpl

public IndexFunctionsDaoImpl()

Method Detail

createIndexDocument

public final void createIndexDocument(String indexName,
                                      String documentType,
                                      String id,
                                      String json)

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

Specified by:

createIndexDocument in interface IndexFunctionsDao

Parameters:

indexName - index name

documentType - document type

id - id

json - json

isValidDocumentIndex

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

Description copied from interface: IndexFunctionsDao

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

Specified by:

isValidDocumentIndex in interface IndexFunctionsDao

Parameters:

indexName - index name

documentType - doucment type

id - id

json - json

Returns:

is valid

isIndexExists

public final boolean isIndexExists(String indexName)

Description copied from interface: IndexFunctionsDao

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

Specified by:

isIndexExists in interface IndexFunctionsDao

Parameters:

indexName - index name

Returns:

is index exist

deleteIndex

public final void deleteIndex(String indexName)

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

Specified by:

deleteIndex in interface IndexFunctionsDao

Parameters:

indexName - indexName

validateDocumentIndex

public final void validateDocumentIndex(String indexName,
                                        String documentType,
                                        String id,
                                        String json)

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

Specified by:

validateDocumentIndex in interface IndexFunctionsDao

Parameters:

indexName - index name

documentType - document type

id - id

json - json

createIndexDocuments

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

Description copied from interface: IndexFunctionsDao

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

Specified by:

createIndexDocuments in interface IndexFunctionsDao

Parameters:

indexName - index name

documentType - document type

documentMap - document map

createIndex

public final void createIndex(String indexName,
                              String documentType,
                              String mapping,
                              String settings,
                              String alias)

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

Specified by:

createIndex in interface IndexFunctionsDao

Parameters:

indexName - index name

documentType - document type

mapping - mapping

settings - setting

alias - alias

deleteDocumentById

public final void deleteDocumentById(String indexName,
                                     String documentType,
                                     String id)

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

Specified by:

deleteDocumentById in interface IndexFunctionsDao

Parameters:

indexName - index name

documentType - document type

id - id

deleteIndexDocuments

public final void deleteIndexDocuments(String indexName,
                                       String documentType,
                                       List<Integer> ids)

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

Specified by:

deleteIndexDocuments in interface IndexFunctionsDao

getNumberOfTypesInIndex

public long getNumberOfTypesInIndex(String indexName,
                                    String documentType)

Description copied from interface: IndexFunctionsDao

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

Specified by:

getNumberOfTypesInIndex in interface IndexFunctionsDao

Parameters:

indexName - index name

documentType - document type

Returns:

number of types in index

getIdsInIndex

public final List<String> getIdsInIndex(String indexName,
                                        String documentType)

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

Specified by:

getIdsInIndex in interface IndexFunctionsDao

Parameters:

indexName - index name

documentType - document type

Returns:

list of ids

updateIndexDocuments

public final void updateIndexDocuments(String indexName,
                                       String documentType,
                                       Map<String,String> documentMap)

The update index documents function will take as arguments the index name, document type, 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.

Specified by:

updateIndexDocuments in interface IndexFunctionsDao

Parameters:

indexName - index name

documentType - document type

documentMap - document map

getIndexSettings

public Settings getIndexSettings(String indexName)

Description copied from interface: IndexFunctionsDao

get the index settings

Specified by:

getIndexSettings in interface IndexFunctionsDao

Parameters:

indexName - index name

Returns:

index settings

getIndexStats

public DocsStats getIndexStats(String indexName)

Description copied from interface: IndexFunctionsDao

get docs stats

Specified by:

getIndexStats in interface IndexFunctionsDao

Parameters:

indexName - index name

Returns:

docs stats