Package gov.nasa.pds.registry.common.es.dao.dd

Class DataDictionaryDao

java.lang.Object

gov.nasa.pds.registry.common.es.dao.dd.DataDictionaryDao

public class DataDictionaryDao
extends Object

Data dictionary DAO (Data Access Object). This class provides methods to read and update data dictionary.

Author:

karpenko

Constructor Summary

Constructors

Constructor	Description
DataDictionaryDao(RestClient client, String indexName)	Constructor

Method Summary

Modifier and Type	Method	Description
List<Tuple>	getDataTypes(Collection<String> ids)	Query Elasticsearch data dictionary to get data types for a list of field ids.
List<Tuple>	getDataTypesWithRefresh(Collection<String> ids)	Same as getDataTypes but forces a shard refresh before the mget.
Set<String>	getFieldNamesByEsType(String esType)	Get field names by Elasticsearch type, such as "boolean" or "date".
LddVersions	getLddInfo(String namespace)	Get LDD date from data dictionary index in Elasticsearch.
LddVersions	getLddInfoNoCache(String namespace)	Get LDD date from data dictionary index in Elasticsearch.
List<LddInfo>	listLdds(String namespace)	List registered LDDs

Methods inherited from class java.lang.Object

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

Constructor Details

DataDictionaryDao

public DataDictionaryDao(RestClient client,
 String indexName)

Constructor

Parameters:

client - Elasticsearch client

indexName - Elasticsearch index name

Method Details

getLddInfo

public LddVersions getLddInfo(String namespace)
                       throws UnsupportedOperationException,
IOException

Get LDD date from data dictionary index in Elasticsearch.

Parameters:

namespace - LDD namespace, e.g., "pds", "geom", etc.

Returns:

ISO instant class representing LDD date.

Throws:

IOException

ResponseException

UnsupportedOperationException

Exception - an exception

getLddInfoNoCache

public LddVersions getLddInfoNoCache(String namespace)
                              throws UnsupportedOperationException,
IOException

Get LDD date from data dictionary index in Elasticsearch. Force skip the OpenSearch cache.

Parameters:

namespace - LDD namespace, e.g., "pds", "geom", etc.

Returns:

ISO instant class representing LDD date.

Throws:

IOException

ResponseException

UnsupportedOperationException

Exception - an exception

listLdds

public List<LddInfo> listLdds(String namespace)
                       throws UnsupportedOperationException,
IOException

List registered LDDs

Parameters:

namespace - if this parameter is null list all LDDs

Returns:

a list of LDDs

Throws:

IOException

ResponseException

UnsupportedOperationException

Exception - an exception

getFieldNamesByEsType

public Set<String> getFieldNamesByEsType(String esType)
                                  throws UnsupportedOperationException,
IOException

Get field names by Elasticsearch type, such as "boolean" or "date".

Returns:

a set of field names

Throws:

IOException

ResponseException

UnsupportedOperationException

Exception - an exception

getDataTypes

public List<Tuple> getDataTypes(Collection<String> ids)
                         throws IOException,
DataTypeNotFoundException

Query Elasticsearch data dictionary to get data types for a list of field ids.

Parameters:

ids - A list of field IDs, e.g., "pds:Array_3D/pds:axes".

stringForMissing - If true, throw DataTypeNotFoundException on first field missing from Elasticsearch data dictionary. If false, process all missing fields in a batch to create a list of missing namespaces. Don't throw DataTypeNotFoundException.

Returns:

Data types information object

Throws:

DataTypeNotFoundException

IOException

ResponseException

Exception - DataTypeNotFoundException, IOException, etc.

getDataTypesWithRefresh

public List<Tuple> getDataTypesWithRefresh(Collection<String> ids)
                                    throws IOException,
DataTypeNotFoundException

Same as getDataTypes but forces a shard refresh before the mget. Use only in targeted wait loops after bulk loading an LDD — do not use in normal query paths.

Throws:

IOException

DataTypeNotFoundException