org.javastro.ivoa.entities.regtap.Interface 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.XmlTransient;
import jakarta.xml.bind.annotation.XmlType;

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

/**
 *
 * @author Paul Harrison  04-Feb-2013
 */
@Entity
@Table(name="interface")
@XmlType
@XmlAccessorType(XmlAccessType.FIELD)
@NamedQueries({
    @NamedQuery(name = "Interface.findAll", query = "SELECT i FROM Interface i"),
    @NamedQuery(name = "Interface.findByIvoid", query = "SELECT i FROM Interface i WHERE i.interfacePK.ivoid = :ivoid"),
    @NamedQuery(name = "Interface.findByCapIndex", query = "SELECT i FROM Interface i WHERE i.capIndex = :capIndex"),
    @NamedQuery(name = "Interface.findByIntfIndex", query = "SELECT i FROM Interface i WHERE i.interfacePK.intfIndex = :intfIndex"),
    @NamedQuery(name = "Interface.findByIntfType", query = "SELECT i FROM Interface i WHERE i.intfType = :intfType"),
    @NamedQuery(name = "Interface.findByIntfRole", query = "SELECT i FROM Interface i WHERE i.intfRole = :intfRole"),
    @NamedQuery(name = "Interface.findByStdVersion", query = "SELECT i FROM Interface i WHERE i.stdVersion = :stdVersion"),
    @NamedQuery(name = "Interface.findByQueryType", query = "SELECT i FROM Interface i WHERE i.queryType = :queryType"),
    @NamedQuery(name = "Interface.findByResultType", query = "SELECT i FROM Interface i WHERE i.resultType = :resultType"),
    @NamedQuery(name = "Interface.findByWsdlUrl", query = "SELECT i FROM Interface i WHERE i.wsdlUrl = :wsdlUrl"),
    @NamedQuery(name = "Interface.findByUrlUse", query = "SELECT i FROM Interface i WHERE i.urlUse = :urlUse"),
    @NamedQuery(name = "Interface.findByAccessUrl", query = "SELECT i FROM Interface i WHERE i.accessUrl = :accessUrl")})
public class Interface implements Serializable,PKIndex, Identifier
{
    private static final long serialVersionUID = 1L;
    @EmbeddedId
    @XmlElement
    protected InterfacePK interfacePK;
    @Basic(optional = false)
    @Column(name = "cap_index", nullable = false)
    @XmlElement(name = "cap_index")
    private Short capIndex;     //TODO need to work out if the correct foreign key working into this and ivoid
    @Column(name = "intf_type")
    @XmlElement(name = "intf_type")
    private String intfType;
    @Column(name = "intf_role")
    @XmlElement(name = "intf_role")
    private String intfRole;
    @Column(name = "std_version")
    @XmlElement(name = "std_version")
    private String stdVersion;
    @Column(name = "query_type")
    @XmlElement(name = "query_type")
    private String queryType;
    @Column(name = "result_type")
    @XmlElement(name = "result_type")
    private String resultType;
    @Column(name = "wsdl_url")
    @XmlElement(name = "wsdlURL")
    private String wsdlUrl;
    @Basic(optional = false)
    @Column(name = "url_use", nullable = false)
    @XmlElement(name = "url_use")
    private String urlUse;
    @Basic(optional = false)
    @Column(name = "access_url", nullable = false)
    @XmlElement(name = "access_url")
    private String accessUrl;
 
    @Basic(optional = true)
    @Column(name = "mirror_url", nullable = true)
    @XmlElement(name = "mirror_url")
    private String mirrorUrl;
    
    @Basic(optional = false)
    @Column(name = "authenticated_only", nullable = false)
    @XmlElement(name = "authenticated_only")
    private int authenticatedOnly;

    
    @OneToMany(cascade = CascadeType.ALL, mappedBy = "iface", targetEntity=IntfParam.class, fetch= FetchType.LAZY, orphanRemoval=true)
    @XmlElement(name = "param")
    private List intfParamList;

    @XmlTransient
    @ManyToOne(optional = false)
    @JoinColumns({@JoinColumn(name = "ivoid", nullable = false, insertable = false, updatable = false, referencedColumnName = "ivoid"),@JoinColumn(name = "cap_index", referencedColumnName = "cap_index", insertable = false, updatable = false, nullable = false)})
    private Capability capability;

    public Interface() {
        this.interfacePK = new InterfacePK();
    }

    public Interface(InterfacePK interfacePK) {
        this.interfacePK = interfacePK;
    }

    public Interface(InterfacePK interfacePK, String urlUse, String accessUrl) {
        this.interfacePK = interfacePK;
        this.urlUse = urlUse;
        this.accessUrl = accessUrl;
    }

    public Interface(String ivoid, short capIndex, short intfIndex) {
        this.interfacePK = new InterfacePK(ivoid, intfIndex);
        this.capIndex = capIndex;
    }

    /**
     * @param vr
     * @param cap
     * @param s
     * @param string
     * @param string2
     */
    public Interface(Resource vr, Capability cap, short s, String urlUse, String accessUrl) {
        this(new InterfacePK(vr.getIvoid(),s),urlUse, accessUrl);
        this.capIndex =  cap.getCapabilityPK().getCapIndex();
    }

    public InterfacePK getInterfacePK() {
        return interfacePK;
    }

    public void setInterfacePK(InterfacePK interfacePK) {
        this.interfacePK = interfacePK;
    }

    public String getIntfType() {
        return intfType;
    }

    public void setIntfType(String intfType) {
        this.intfType = intfType;
    }

    public String getIntfRole() {
        return intfRole;
    }

    public void setIntfRole(String intfRole) {
        this.intfRole = intfRole;
    }

    public String getStdVersion() {
        return stdVersion;
    }

    public void setStdVersion(String stdVersion) {
        this.stdVersion = stdVersion;
    }

    public String getQueryType() {
        return queryType;
    }

    public void setQueryType(String queryType) {
        this.queryType = queryType;
    }

    public String getResultType() {
        return resultType;
    }

    public void setResultType(String resultType) {
        this.resultType = resultType;
    }

    public String getWsdlUrl() {
        return wsdlUrl;
    }

    public void setWsdlUrl(String wsdlUrl) {
        this.wsdlUrl = wsdlUrl;
    }

    public String getUrlUse() {
        return urlUse;
    }

    public void setUrlUse(String urlUse) {
        this.urlUse = urlUse;
    }

    public String getAccessUrl() {
        return accessUrl;
    }

    public void setAccessUrl(String accessUrl) {
        this.accessUrl = accessUrl;
    }

    public List getIntfParamList() {
        if(intfParamList == null) intfParamList = new ArrayList();
        return intfParamList;
    }

    public void setIntfParamList(List intfParamList) {
        this.intfParamList = intfParamList;
    }

    public Capability getCapability() {
        return capability;
    }

    public void addToCapability(Capability capability) {
        this.capability = capability;
        
        PKIndexUtils.addWithIndex(this, capability, capability.getInterfaceList());
    
        this.setCapIndex(capability.getIndex());
        
    }

    /**
     * @return the capIndex
     */
    public Short getCapIndex() {
        return capIndex;
    }

    /**
     * @param capIndex the capIndex to set
     */
    public void setCapIndex(short capIndex) {
        this.capIndex = capIndex;
    }

    @Override
    public int hashCode() {
        int hash = 0;
        hash += (interfacePK != null ? interfacePK.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 Interface)) {
            return false;
        }
        Interface other = (Interface) object;
        if ((this.interfacePK == null && other.interfacePK != null) || (this.interfacePK != null && !this.interfacePK.equals(other.interfacePK))) {
            return false;
        }
        return true;
    }

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

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

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

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

    /**
     * {@inheritDoc}
     * overrides @see org.javastro.ivoa.entities.regtap.Identifier#getIvoid()
     */
    @Override
    public String getIvoid() {
        
       return interfacePK.getIvoid();
    }

}