Package org.ivoa.dm.proposal.management

Class ObservingMode

java.lang.Object
org.ivoa.dm.proposal.management.ObservingMode
All Implemented Interfaces:
org.ivoa.vodml.jaxb.XmlIdManagement, org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
@Entity @VoDml(id="proposalManagement:ObservingMode", role=objectType) public class ObservingMode extends Object implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>, org.ivoa.vodml.jaxb.XmlIdManagement
a configuration can be used to observe with. objectType: ObservingMode

  • Field Details

    • _id

      protected Long _id
      inserted database key

    • name

      @VoDml(id="proposalManagement:ObservingMode.name", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String name
      human readable name for the mode. : Attribute name : multiplicity 1

    • description

      @VoDml(id="proposalManagement:ObservingMode.description", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String description
      human readable description. : Attribute description : multiplicity 1

    • filter

      @VoDml(id="proposalManagement:ObservingMode.filter", role=composition, type="proposalManagement:Filter", typeRole=objectType) protected Filter filter
      The filter or frequency response that . composition filter : ( Multiplicity : 1 )

    • telescope

      @VoDml(id="proposalManagement:ObservingMode.telescope", role=reference, type="proposalManagement:ObservingPlatform", typeRole=objectType) protected ObservingPlatform telescope
      ReferenceObject telescope : . ( Multiplicity : 1 )

    • instrument

      @VoDml(id="proposalManagement:ObservingMode.instrument", role=reference, type="proposalManagement:Instrument", typeRole=objectType) protected Instrument instrument
      ReferenceObject instrument : . ( Multiplicity : 1 )

    • backend

      @VoDml(id="proposalManagement:ObservingMode.backend", role=reference, type="proposalManagement:Backend", typeRole=objectType) protected Backend backend
      ReferenceObject backend : . ( Multiplicity : 1 )

  • Constructor Details

    • ObservingMode

      public ObservingMode()
      Creates a new ObservingMode

    • ObservingMode

      public ObservingMode(String name, String description, ObservingPlatform telescope, Instrument instrument, Filter filter, Backend backend)
      full parameter constructor.
      Parameters:
      name - human readable name for the mode.
      description - human readable description.
      telescope - .
      instrument - .
      filter - The filter or frequency response that .
      backend - .

    • ObservingMode

      public ObservingMode(ObservingMode 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

    • getXmlId

      public String getXmlId()
      getter for XMLID
      Specified by:
      getXmlId in interface org.ivoa.vodml.jaxb.XmlIdManagement

    • setXmlId

      public void setXmlId(String id)
      Specified by:
      setXmlId in interface org.ivoa.vodml.jaxb.XmlIdManagement

    • hasNaturalKey

      public boolean hasNaturalKey()
      Specified by:
      hasNaturalKey in interface org.ivoa.vodml.jaxb.XmlIdManagement

    • updateClonedReferences

      public void updateClonedReferences()
      updates any cloned references that are contained within the hierarchy.

    • updateUsing

      public void updateUsing(ObservingMode 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 ObservingMode withName(String pName)
      fluent setter for name Attribute.
      Parameters:
      pName - value to set
      Returns:
      ObservingMode

    • getDescription

      public String getDescription()
      Returns description Attribute.
      Returns:
      description Attribute

    • setDescription

      public void setDescription(String pDescription)
      Set description Attribute.
      Parameters:
      pDescription - value to set

    • withDescription

      public ObservingMode withDescription(String pDescription)
      fluent setter for description Attribute.
      Parameters:
      pDescription - value to set
      Returns:
      ObservingMode

    • getTelescope

      public ObservingPlatform getTelescope()
      Returns telescope Reference
      Returns:
      telescope Reference

    • setTelescope

      public void setTelescope(ObservingPlatform pTelescope)
      Defines telescope Reference
      Parameters:
      pTelescope - reference to set

    • getInstrument

      public Instrument getInstrument()
      Returns instrument Reference
      Returns:
      instrument Reference

    • setInstrument

      public void setInstrument(Instrument pInstrument)
      Defines instrument Reference
      Parameters:
      pInstrument - reference to set

    • getFilter

      public Filter getFilter()
      Returns filter Attribute.
      Returns:
      filter Attribute

    • setFilter

      public void setFilter(Filter pFilter)
      Set filter Attribute.
      Parameters:
      pFilter - value to set

    • withFilter

      public ObservingMode withFilter(Filter pFilter)
      fluent setter for filter Attribute.
      Parameters:
      pFilter - value to set
      Returns:
      ObservingMode

    • getBackend

      public Backend getBackend()
      Returns backend Reference
      Returns:
      backend Reference

    • setBackend

      public void setBackend(Backend pBackend)
      Defines backend Reference
      Parameters:
      pBackend - reference to set

    • createObservingMode

      public static ObservingMode createObservingMode(Consumer<ObservingMode.ObservingModeBuilder> f)
      create a ObservingMode 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

    • persistRefs

      @Deprecated public void persistRefs(jakarta.persistence.EntityManager _em)
      Deprecated.
      generally better to use the model level reference persistence as only this can deal with "contained" references properly.
      Specified by:
      persistRefs in interface org.ivoa.vodml.jpa.JPAManipulations