gov.nasa.pds.registry.common.meta.FieldNameCache Maven / Gradle / Ivy

Go to download
package gov.nasa.pds.registry.common.meta;

import java.util.HashSet;
import java.util.Set;

import gov.nasa.pds.registry.common.es.dao.dd.DataDictionaryDao;
import gov.nasa.pds.registry.common.es.dao.schema.SchemaDao;

/**
 * A cache of field names in Elasticsearch schema for the registry index.
 * @author karpenko
 */
public class FieldNameCache
{
    private Set schemaFieldNames;
    private Set boolFieldNames;
    private Set dateFieldNames;

    private SchemaDao schemaDao;
    private DataDictionaryDao ddDao;
    
    
    /**
     * Private constructor. Use getInstance() instead.
     */
    public FieldNameCache(DataDictionaryDao ddDao, SchemaDao schemaDao)
    {
        schemaFieldNames = new HashSet<>();
        boolFieldNames = new HashSet<>();
        dateFieldNames = new HashSet<>();
        
        this.ddDao = ddDao;
        this.schemaDao = schemaDao;
    }

    
    /**
     * Set field names present in "registry" Elasticsearch schema
     * @param fieldNames collection of field names
     */
    public void setSchemaFieldNames(Set fieldNames)
    {
        this.schemaFieldNames = fieldNames;
    }

    
    /**
     * Set boolean field names present in LDDs
     * @param fieldNames collection of field names
     */
    public void setBooleanFieldNames(Set fieldNames)
    {
        this.boolFieldNames = fieldNames;
    }

    
    /**
     * Set date field names present in LDDs
     * @param fieldNames collection of field names
     */
    public void setDateFieldNames(Set fieldNames)
    {
        this.dateFieldNames = fieldNames;
    }

    
    /**
     * Check if a field name is in the "registry" Elasticsearch schema.
     * @param name field name
     * @return true if field name is in "registry" schema.
     */
    public boolean schemaContainsField(String name)
    {
        return schemaFieldNames.contains(name);
    }

    
    /**
     * Check if a field is a boolean field.
     * @param name field name
     * @return true if this is a boolean field
     */
    public boolean isBooleanField(String name)
    {
        return boolFieldNames.contains(name);
    }


    /**
     * Check if a field is a date field.
     * @param name field name
     * @return true if this is a date field
     */
    public boolean isDateField(String name)
    {
        return dateFieldNames.contains(name);
    }

    
    /**
     * Update cache
     * @throws Exception an exception
     */
    public void update() throws Exception
    {
        setSchemaFieldNames(schemaDao.getFieldNames());
        setBooleanFieldNames(ddDao.getFieldNamesByEsType("boolean"));
        setDateFieldNames(ddDao.getFieldNamesByEsType("date"));
    }
}