Package org.ivoa.dm.caom2

Class Telescope

java.lang.Object
org.ivoa.dm.caom2.Telescope
All Implemented Interfaces:
org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
@Entity @VoDml(id="caom2:Telescope", role=objectType) public class Telescope extends Object implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
the telescope used to acquire the data for an observation. objectType: Telescope

  • Field Details

    • _id

      protected Long _id
      inserted database key

    • name

      @VoDml(id="caom2:Telescope.name", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String name
      common name of the telescope; TBD: reference to a standard list of names?. : Attribute name : multiplicity 1

    • geoLocationX

      @VoDml(id="caom2:Telescope.geoLocationX", role=attribute, type="ivoa:real", typeRole=primitiveType) protected Double geoLocationX
      x-coordinate of the geocentric location of the telescope at the time of observation (see FITS WCS Paper III). : Attribute geoLocationX : multiplicity 0..1

    • geoLocationY

      @VoDml(id="caom2:Telescope.geoLocationY", role=attribute, type="ivoa:real", typeRole=primitiveType) protected Double geoLocationY
      y-coordinate of the geocentric location of the telescope at the time of observation (see FITS WCS Paper III). : Attribute geoLocationY : multiplicity 0..1

    • geoLocationZ

      @VoDml(id="caom2:Telescope.geoLocationZ", role=attribute, type="ivoa:real", typeRole=primitiveType) protected Double geoLocationZ
      z-coordinate of the geocentric location of the telescope at the time of observation (see FITS WCS Paper III). : Attribute geoLocationZ : multiplicity 0..1

    • keywords

      @VoDml(id="caom2:Telescope.keywords", role=attribute, type="ivoa:string", typeRole=primitiveType) protected List<String> keywords
      additional keywords that describe the telescope or telscope configuration at the time of observation; keywords cannot contain the pipe (|) character - it is reserved for use in persistence systems (e.g. to store all keywords in a single column in a table) . : Attribute keywords : multiplicity 0..*

    • trackingMode

      @VoDml(id="caom2:Telescope.trackingMode", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String trackingMode
      term from the (currently non-existent) IVOA Tracking vocabulary used to indicate how the telescope moves during data acquisition. : Attribute trackingMode : multiplicity 0..1

  • Constructor Details

    • Telescope

      public Telescope()
      Creates a new Telescope

    • Telescope

      public Telescope(String name, Double geoLocationX, Double geoLocationY, Double geoLocationZ, List<String> keywords, String trackingMode)
      full parameter constructor.
      Parameters:
      name - common name of the telescope; TBD: reference to a standard list of names?.
      geoLocationX - x-coordinate of the geocentric location of the telescope at the time of observation (see FITS WCS Paper III).
      geoLocationY - y-coordinate of the geocentric location of the telescope at the time of observation (see FITS WCS Paper III).
      geoLocationZ - z-coordinate of the geocentric location of the telescope at the time of observation (see FITS WCS Paper III).
      keywords - additional keywords that describe the telescope or telscope configuration at the time of observation; keywords cannot contain the pipe (|) character - it is reserved for use in persistence systems (e.g. to store all keywords in a single column in a table) .
      trackingMode - term from the (currently non-existent) IVOA Tracking vocabulary used to indicate how the telescope moves during data acquisition.

    • Telescope

      public Telescope(Telescope other)
      Copy Constructor. Note that references will remain as is rather than be copied.
      Parameters:
      other - the object to be copied.

  • Method Details

    • getId

      public Long getId()
      Specified by:
      getId in interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
      Returns:
      the id

    • updateUsing

      public void updateUsing(Telescope other)
      Update this object with the content of the given object. Note that references will remain as is rather than be copied.
      Parameters:
      other - the object to be copied.

    • getName

      public String getName()
      Returns name Attribute.
      Returns:
      name Attribute

    • setName

      public void setName(String pName)
      Set name Attribute.
      Parameters:
      pName - value to set

    • withName

      public Telescope withName(String pName)
      fluent setter for name Attribute.
      Parameters:
      pName - value to set
      Returns:
      Telescope

    • getGeoLocationX

      public Double getGeoLocationX()
      Returns geoLocationX Attribute.
      Returns:
      geoLocationX Attribute

    • setGeoLocationX

      public void setGeoLocationX(Double pGeoLocationX)
      Set geoLocationX Attribute.
      Parameters:
      pGeoLocationX - value to set

    • withGeoLocationX

      public Telescope withGeoLocationX(Double pGeoLocationX)
      fluent setter for geoLocationX Attribute.
      Parameters:
      pGeoLocationX - value to set
      Returns:
      Telescope

    • getGeoLocationY

      public Double getGeoLocationY()
      Returns geoLocationY Attribute.
      Returns:
      geoLocationY Attribute

    • setGeoLocationY

      public void setGeoLocationY(Double pGeoLocationY)
      Set geoLocationY Attribute.
      Parameters:
      pGeoLocationY - value to set

    • withGeoLocationY

      public Telescope withGeoLocationY(Double pGeoLocationY)
      fluent setter for geoLocationY Attribute.
      Parameters:
      pGeoLocationY - value to set
      Returns:
      Telescope

    • getGeoLocationZ

      public Double getGeoLocationZ()
      Returns geoLocationZ Attribute.
      Returns:
      geoLocationZ Attribute

    • setGeoLocationZ

      public void setGeoLocationZ(Double pGeoLocationZ)
      Set geoLocationZ Attribute.
      Parameters:
      pGeoLocationZ - value to set

    • withGeoLocationZ

      public Telescope withGeoLocationZ(Double pGeoLocationZ)
      fluent setter for geoLocationZ Attribute.
      Parameters:
      pGeoLocationZ - value to set
      Returns:
      Telescope

    • getKeywords

      public List<String> getKeywords()
      Returns keywords Attribute.
      Returns:
      keywords Attribute

    • setKeywords

      public void setKeywords(List<String> pKeywords)
      Set keywords Attribute.
      Parameters:
      pKeywords - value to set

    • withKeywords

      public Telescope withKeywords(List<String> pKeywords)
      fluent setter for keywords Attribute.
      Parameters:
      pKeywords - value to set
      Returns:
      Telescope

    • getTrackingMode

      public String getTrackingMode()
      Returns trackingMode Attribute.
      Returns:
      trackingMode Attribute

    • setTrackingMode

      public void setTrackingMode(String pTrackingMode)
      Set trackingMode Attribute.
      Parameters:
      pTrackingMode - value to set

    • withTrackingMode

      public Telescope withTrackingMode(String pTrackingMode)
      fluent setter for trackingMode Attribute.
      Parameters:
      pTrackingMode - value to set
      Returns:
      Telescope

    • createTelescope

      public static Telescope createTelescope(Consumer<Telescope.TelescopeBuilder> f)
      create a Telescope in functional builder style.
      Parameters:
      f - the functional builder.
      Returns:
      an object initialized from the builder.

    • forceLoad

      public void forceLoad()
      Specified by:
      forceLoad in interface org.ivoa.vodml.jpa.JPAManipulations

    • delete

      public void delete(jakarta.persistence.EntityManager em)
      Specified by:
      delete in interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>