org.cytosm.common.gtop.implementation.relational.Attribute Maven / Gradle / Ivy

Go to download
package org.cytosm.common.gtop.implementation.relational;

import com.fasterxml.jackson.annotation.JsonInclude;

/***
 * Attributes in the Property graph sense. They must be able to be extracted from the database data.
 *
 *
 */
@JsonInclude(JsonInclude.Include.NON_NULL)
public class Attribute {

    /***
     * Table column from where it is extracted. The Table name is always the same as the node.
     */
    protected String columnName;

    /***
     * How this attribute will be referenced on Graph Query Languages (e.g. cypher).
     */
    protected String abstractionLevelName;

    /***
     * Which datatype represents this information. Currently supported are: Integer, Timestamp,
     * Date, String.
     */
    protected String dataType;

    /***
     * Default constructor.
     */
    public Attribute() {}

    /***
     * Attribute generator.
     * @param columnName name of the relational column that it refers to
     * @param abstractionLevelName name used for this attribute on the abstraction level
     * @param dataType relational datatype of this attribute
     */
    public Attribute(final String columnName, final String abstractionLevelName, final String dataType) {
        this.columnName = columnName;
        this.abstractionLevelName = abstractionLevelName;
        this.dataType = dataType;
    }

    /**
     * @return the columnName
     */
    public String getColumnName() {
        return columnName;
    }

    /**
     * @param columnName the columnName to set, in the format table.column
     */
    public void setColumnName(final String columnName) {
        this.columnName = columnName;
    }

    /**
     * @return the abstractionLevelName
     */
    public String getAbstractionLevelName() {
        return abstractionLevelName;
    }

    /**
     * @param fieldName the abstractionLevelName to set
     */
    public void setAbstractionLevelName(final String fieldName) {
        abstractionLevelName = fieldName;
    }

    /**
     * @return the dataType
     */
    public String getDataType() {
        return dataType;
    }

    /**
     * @param dataType the dataType to set
     */
    public void setDataType(final String dataType) {
        this.dataType = dataType;
    }

}