org.protempa.backend.dsb.relationaldb.PropertySpec Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of protempa-dsb-relationaldb Show documentation
Implements support for retrieving data from relational databases.
The newest version!
/*
 * #%L
 * Protempa Commons Backend Provider
 * %%
 * Copyright (C) 2012 - 2013 Emory University
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package org.protempa.backend.dsb.relationaldb;

import java.io.Serializable;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.protempa.proposition.value.ValueType;

/**
 * For specifying properties of a relational database entity.
 * 
 * @author Andrew Post
 */
public final class PropertySpec implements Serializable {
    private static final long serialVersionUID = -1917547963157896382L;
    private final String name;
    private final Map codeToPropIdMap;
    private final ColumnSpec codeSpec;
    private final ColumnSpec constraintSpec;
    private final ValueType valueType;
    private final JDBCValueFormat jdbcValueFormat;

    /**
     * Instantiates a property specification with a name, path, value type,
     * and optional mappings from values in the database to values as
     * specified in a knowledge source. With this constructor, the default
     * mechanism of reading values of this property from the database will be
     * used, which is to read the property value using 
     * {@link java.sql.ResultSet#getString(int)} and parse the string using
     * {@link org.protempa.proposition.value.ValueFactory#parse(java.lang.String) }.
     * 
     * @param name the property's name. Cannot be null.
     * @param codeToPropIdMap an optional {@link Map()} map
     * from values in the database to values in a knowledge source.
     * @param codeSpec a {@link ColumnSpec} path through the database from
     * the corresponding entity's main table to the table and column where this
     * property is located.
     * @param valueType the {@link ValueType} type of values of this property.
     */
    public PropertySpec(String name,
            Map codeToPropIdMap,
            ColumnSpec codeSpec,
            ValueType valueType) {
        this(name, codeToPropIdMap, codeSpec, null, valueType, null);
    }
    
    public PropertySpec(String name,
            Map codeToPropIdMap,
            ColumnSpec codeSpec,
            ColumnSpec constraintSpec,
            ValueType valueType) {
        this(name, codeToPropIdMap, codeSpec, constraintSpec, valueType, null);
    }
    
    public PropertySpec(String name,
            Map codeToPropIdMap,
            ColumnSpec codeSpec,
            ValueType valueType, 
            JDBCValueFormat jdbcValueFormat) {
        this(name, codeToPropIdMap, codeSpec, null, valueType, jdbcValueFormat);
    }
    
    /**
     * Instantiates a property specification with a name, path, value type,
     * optional mappings from values in the database to values as
     * specified in a knowledge source, and a custom formatter for reading
     * values of this property from a result set.
     * 
     * @param name the property's name. Cannot be null.
     * @param codeToPropIdMap an optional {@link Map()} map
     * from values in the database to values in a knowledge source.
     * @param codeSpec a {@link ColumnSpec} path through the database from
     * the corresponding entity's main table to the table and column where this
     * property is located.
     * @param valueType the {@link ValueType} type of values of this property.
     * @param jdbcValueFormat a {@link JDBCValueFormat} for reading values of
     * this property from a result set (may be null).
     */
    public PropertySpec(String name,
            Map codeToPropIdMap,
            ColumnSpec codeSpec,
            ColumnSpec constraintSpec,
            ValueType valueType, 
            JDBCValueFormat jdbcValueFormat) {
        if (name == null)
            throw new IllegalArgumentException("name cannot be null");
        if (codeSpec == null)
            throw new IllegalArgumentException("codeSpec cannot be null");
        if (valueType == null)
            throw new IllegalArgumentException("valueType cannot be null");
        this.name = name.intern();
        if (codeToPropIdMap != null) {
            this.codeToPropIdMap = new HashMap<>(codeToPropIdMap);
        } else {
            this.codeToPropIdMap = Collections.emptyMap();
        }
        this.codeSpec = codeSpec;
        this.valueType = valueType;
        this.constraintSpec = constraintSpec;
        this.jdbcValueFormat = jdbcValueFormat;
    }
    
    /**
     * Returns the property's name. Guaranteed not null.
     *
     * @return a {@link String}.
     */
    public String getName() {
        return this.name;
    }

    public boolean codeToPropIdMapContainsKey(String key) {
        return this.codeToPropIdMap.containsKey(key);
    }

    public String propositionIdFor(String key) {
        return this.codeToPropIdMap.get(key);
    }

    /**
     * Gets the path through the database from this entity's main table to
     * the table and column where this property is located.
     *
     * @return a {@link ColumnSpec}.
     */
    public ColumnSpec getCodeSpec() {
        return this.codeSpec;
    }
    
    public ColumnSpec getConstraintSpec() {
        return this.constraintSpec;
    }

    /**
     * Returns the type of this property's values.
     *
     * @return a {@link ValueType}.
     */
    public ValueType getValueType() {
        return this.valueType;
    }
    
    /**
     * Returns a custom formatter that reads values of this property from a
     * {@link java.sql.ResultSet}. If not null, this formatter 
     * will override the default mechanism of reading property values, which is 
     * to read the property value using 
     * {@link java.sql.ResultSet#getString(int)} and parse the string using
     * {@link org.protempa.proposition.value.ValueFactory#parse(java.lang.String) }.
     * 
     * @return a {@link JDBCValueFormat}. Can be null.
     */
    public JDBCValueFormat getJDBCValueFormat() {
        return this.jdbcValueFormat;
    }

    @Override
    public String toString() {
        return ToStringBuilder.reflectionToString(this);
    }
}