org.javastro.ivoa.entities.regtap.ResTable Maven / Gradle / Ivy

Go to download
/*
 * $$Id:$$
 *
 *
 *  Created on 04-Feb-2013 by Paul Harrison 
 * 
 * This software is published under the terms of the Academic
 * Free License, a copy of which has been included
 * with this distribution in the LICENSE.txt file.
 * 
 *  Copyright (c) The University of Manchester. All rights reserved.
 *
 */ 
package org.javastro.ivoa.entities.regtap;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;

import jakarta.persistence.Basic;
import jakarta.persistence.CascadeType;
import jakarta.persistence.Column;
import jakarta.persistence.EmbeddedId;
import jakarta.persistence.Entity;
import jakarta.persistence.FetchType;
import jakarta.persistence.JoinColumn;
import jakarta.persistence.JoinColumns;
import jakarta.persistence.ManyToOne;
import jakarta.persistence.NamedQueries;
import jakarta.persistence.NamedQuery;
import jakarta.persistence.OneToMany;
import jakarta.persistence.Table;
import jakarta.xml.bind.annotation.XmlAccessType;
import jakarta.xml.bind.annotation.XmlAccessorType;
import jakarta.xml.bind.annotation.XmlElement;
import jakarta.xml.bind.annotation.XmlRootElement;
import jakarta.xml.bind.annotation.XmlTransient;

//import org.eclipse.persistence.oxm.annotations.XmlPath;

/**
 *
 * @author Paul Harrison  04-Feb-2013
 */
@Entity
@Table(name = "res_table")
@XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
@NamedQueries({
    @NamedQuery(name = "ResTable.findAll", query = "SELECT r FROM ResTable r"),
    @NamedQuery(name = "ResTable.findByIvoid", query = "SELECT r FROM ResTable r WHERE r.resTablePK.ivoid = :ivoid"),
    @NamedQuery(name = "ResTable.findBySchemaIndex", query = "SELECT r FROM ResTable r WHERE r.schemaIndex = :schemaIndex"),
    @NamedQuery(name = "ResTable.findByTableIndex", query = "SELECT r FROM ResTable r WHERE r.resTablePK.tableIndex = :tableIndex"),
    @NamedQuery(name = "ResTable.findByTableName", query = "SELECT r FROM ResTable r WHERE r.name = :tableName"),
    @NamedQuery(name = "ResTable.findByTableTitle", query = "SELECT r FROM ResTable r WHERE r.title = :tableTitle"),
    @NamedQuery(name = "ResTable.findByTableType", query = "SELECT r FROM ResTable r WHERE r.type = :tableType"),
    @NamedQuery(name = "ResTable.findByTableUtype", query = "SELECT r FROM ResTable r WHERE r.utype = :tableUtype"),
    @NamedQuery(name = "ResTable.findByTableDescription", query = "SELECT r FROM ResTable r WHERE r.description = :tableDescription")})
public class ResTable implements Serializable, PKIndex {
    private static final long serialVersionUID = 1L;
    @EmbeddedId
    @XmlElement
    protected ResTablePK resTablePK;
 
    @Basic(optional = false)
    @Column(name = "schema_index", nullable = true)
    @XmlElement(name = "schema_index")
    private Short schemaIndex;

    @Basic(optional = false)
    @Column(name = "table_name", nullable = false)
    @XmlElement(name = "name")
    private String name;
    
    @Column(name = "table_title")
    @XmlElement(name = "title")
    private String title;
    
    @Column(name = "table_description",length=1024)
    @XmlElement(name = "description")
    private String description;
    
    @Column(name = "table_utype")
    @XmlElement(name = "utype")
    private String utype;

    @Basic(optional = true)
    @Column(name = "table_type", nullable = true)
    @XmlElement(name = "type")
    private String type;

    @OneToMany(cascade = CascadeType.ALL, targetEntity=TableColumn.class, fetch= FetchType.LAZY, orphanRemoval=true, mappedBy = "table")
    @XmlElement(name = "column")
    private List tableColumnList;
 
    @XmlTransient
    @ManyToOne(optional = false)
    @JoinColumns({@JoinColumn(name = "ivoid", nullable = false, insertable = false, updatable = false, referencedColumnName = "ivoid")})
    private Resource resource;

    public ResTable() {
        this.resTablePK = new ResTablePK();
    }
    
    public ResTable(String name, String type) {
        this.name = name;
        this.type = type;
        this.resTablePK = new ResTablePK();
    }
    

    public ResTable(ResTablePK resTablePK) {
        this.resTablePK = resTablePK;
    }

    public ResTable(ResTablePK resTablePK, String tableName, String tableType) {
        this.resTablePK = resTablePK;
        this.name = tableName;
        this.type = tableType;
    }

    public ResTable(String ivoid, Short schemaIndex, short tableIndex) {
        this.resTablePK = new ResTablePK(ivoid, tableIndex);
        this.schemaIndex = schemaIndex;
    }

    public ResTablePK getResTablePK() {
        return resTablePK;
    }
    public short getSchemaIndex() {
        return schemaIndex;
    }

    public void setSchemaIndex(short schemaIndex) {
        this.schemaIndex = schemaIndex;
    }

    public void setResTablePK(ResTablePK resTablePK) {
        this.resTablePK = resTablePK;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getTitle() {
        return title;
    }

    public void setTitle(String title) {
        this.title = title;
    }

    public String getType() {
        return type;
    }

    public void setType(String type) {
        this.type = type;
    }

    public String getUtype() {
        return utype;
    }

    public void setUtype(String utype) {
        this.utype = utype;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    public List getTableColumnList() {
        if (tableColumnList == null) tableColumnList = new ArrayList();
        return tableColumnList;
    }


    public Resource getResource() {
        return resource;
    }

    public void addToSchema(ResSchema schema) {
        this.resource = schema.getResource();
        if (resource.getResTableList().indexOf(this) == -1) {
            resource.getResTableList().add(this);
        }
        this.resTablePK.setIvoid(schema.getResSchemaPK().getIvoid());
        this.schemaIndex = schema.getIndex();
        
    }

    @Override
    public int hashCode() {
        int hash = 0;
        hash += (resTablePK != null ? resTablePK.hashCode() : 0);
        return hash;
    }

    @Override
    public boolean equals(Object object) {
        // TODO: Warning - this method won't work in the case the id fields are not set
        if (!(object instanceof ResTable)) {
            return false;
        }
        ResTable other = (ResTable) object;
        if ((this.resTablePK == null && other.resTablePK != null) || (this.resTablePK != null && !this.resTablePK.equals(other.resTablePK))) {
            return false;
        }
        return true;
    }

    @Override
    public String toString() {
        return "net.ivoa.regtap.ResTable[ resTablePK=" + resTablePK + " ]";
    }

    /* (non-Javadoc)
     * @see net.ivoa.regtap.PKIndex#getIndex()
     */
    @Override
    public short getIndex() {
        return this.resTablePK.getTableIndex();
    }

    /* (non-Javadoc)
     * @see net.ivoa.regtap.PKIndex#setPKIndex(short)
     */
    @Override
    public void setPKIndex(short idx) {
        this.resTablePK.setTableIndex(idx);
    }

    /**
     * {@inheritDoc}
     * overrides @see org.javastro.ivoa.entities.regtap.PKIndex#setIvoid(java.lang.String)
     */
    @Override
    public void setIvoid(String i) {
        this.resTablePK.setIvoid(i);
        
    }

}