Package org.ivoa.dm.proposal.prop
Class SpectralWindowSetup
java.lang.Object
org.ivoa.dm.proposal.prop.SpectralWindowSetup
- All Implemented Interfaces:
org.ivoa.vodml.jpa.JPAManipulations
,org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
@Entity
@VoDml(id="proposal:SpectralWindowSetup",
role=objectType)
public class SpectralWindowSetup
extends Object
implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
Science oriented definition of a spectral window.
objectType: SpectralWindowSetup
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
A builder class for SpectralWindowSetup, mainly for use in the functional builder pattern. -
Field Summary
Modifier and TypeFieldDescriptionprotected Long
inserted database keyprotected org.ivoa.dm.ivoa.RealQuantity
The end of the spectral window.protected Boolean
represents an observed frequency.protected org.ivoa.dm.stc.coords.PolStateEnum
desired polarization.protected org.ivoa.dm.ivoa.RealQuantity
channel width.protected org.ivoa.dm.ivoa.RealQuantity
The start of the spectral window. -
Constructor Summary
ConstructorDescriptionCreates a new SpectralWindowSetupSpectralWindowSetup
(org.ivoa.dm.ivoa.RealQuantity start, org.ivoa.dm.ivoa.RealQuantity end, org.ivoa.dm.ivoa.RealQuantity spectralResolution, Boolean isSkyFrequency, org.ivoa.dm.stc.coords.PolStateEnum polarization) full parameter constructor.Copy Constructor. -
Method Summary
Modifier and TypeMethodDescriptionstatic SpectralWindowSetup
create a SpectralWindowSetup in functional builder style.void
org.ivoa.dm.ivoa.RealQuantity
getEnd()
Returns end AttributegetId()
Returns isSkyFrequency Attributeorg.ivoa.dm.stc.coords.PolStateEnum
Returns polarization Attributeorg.ivoa.dm.ivoa.RealQuantity
Returns spectralResolution Attributeorg.ivoa.dm.ivoa.RealQuantity
getStart()
Returns start Attributevoid
jpaClone
(jakarta.persistence.EntityManager em) void
persistRefs
(jakarta.persistence.EntityManager _em) void
setEnd
(org.ivoa.dm.ivoa.RealQuantity pEnd) Defines end Attributevoid
setIsSkyFrequency
(Boolean pIsSkyFrequency) Defines isSkyFrequency Attributevoid
setPolarization
(org.ivoa.dm.stc.coords.PolStateEnum pPolarization) Defines polarization Attributevoid
setSpectralResolution
(org.ivoa.dm.ivoa.RealQuantity pSpectralResolution) Defines spectralResolution Attributevoid
setStart
(org.ivoa.dm.ivoa.RealQuantity pStart) Defines start Attributevoid
updateUsing
(SpectralWindowSetup other) Update this object with the content of the given object.withEnd
(org.ivoa.dm.ivoa.RealQuantity pEnd) withIsSkyFrequency
(Boolean pIsSkyFrequency) withPolarization
(org.ivoa.dm.stc.coords.PolStateEnum pPolarization) withSpectralResolution
(org.ivoa.dm.ivoa.RealQuantity pSpectralResolution) withStart
(org.ivoa.dm.ivoa.RealQuantity pStart)
-
Field Details
-
_id
inserted database key -
start
@VoDml(id="proposal:SpectralWindowSetup.start", role=attribute, type="ivoa:RealQuantity", typeRole=dataType) protected org.ivoa.dm.ivoa.RealQuantity startThe start of the spectral window. : Attribute start : multiplicity 1 -
end
@VoDml(id="proposal:SpectralWindowSetup.end", role=attribute, type="ivoa:RealQuantity", typeRole=dataType) protected org.ivoa.dm.ivoa.RealQuantity endThe end of the spectral window. : Attribute end : multiplicity 1 -
spectralResolution
@VoDml(id="proposal:SpectralWindowSetup.spectralResolution", role=attribute, type="ivoa:RealQuantity", typeRole=dataType) protected org.ivoa.dm.ivoa.RealQuantity spectralResolutionchannel width. : Attribute spectralResolution : multiplicity 0..1 -
isSkyFrequency
@VoDml(id="proposal:SpectralWindowSetup.isSkyFrequency", role=attribute, type="ivoa:boolean", typeRole=primitiveType) protected Boolean isSkyFrequencyrepresents an observed frequency. : Attribute isSkyFrequency : multiplicity 1 -
polarization
@VoDml(id="proposal:SpectralWindowSetup.polarization", role=attribute, type="coords:PolStateEnum", typeRole=enumeration) protected org.ivoa.dm.stc.coords.PolStateEnum polarizationdesired polarization. : Attribute polarization : multiplicity 1
-
-
Constructor Details
-
SpectralWindowSetup
public SpectralWindowSetup()Creates a new SpectralWindowSetup -
SpectralWindowSetup
public SpectralWindowSetup(org.ivoa.dm.ivoa.RealQuantity start, org.ivoa.dm.ivoa.RealQuantity end, org.ivoa.dm.ivoa.RealQuantity spectralResolution, Boolean isSkyFrequency, org.ivoa.dm.stc.coords.PolStateEnum polarization) full parameter constructor.- Parameters:
start
- The start of the spectral window.end
- The end of the spectral window.spectralResolution
- channel width.isSkyFrequency
- represents an observed frequency.polarization
- desired polarization.
-
SpectralWindowSetup
Copy Constructor. Note that references will remain as is rather than be copied.- Parameters:
other
- the object to be copied.
-
-
Method Details
-
getId
- Specified by:
getId
in interfaceorg.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
- Returns:
- the id
-
updateUsing
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.
-
getStart
public org.ivoa.dm.ivoa.RealQuantity getStart()Returns start Attribute- Returns:
- start Attribute
-
setStart
public void setStart(org.ivoa.dm.ivoa.RealQuantity pStart) Defines start Attribute- Parameters:
pStart
- value to set
-
withStart
-
getEnd
public org.ivoa.dm.ivoa.RealQuantity getEnd()Returns end Attribute- Returns:
- end Attribute
-
setEnd
public void setEnd(org.ivoa.dm.ivoa.RealQuantity pEnd) Defines end Attribute- Parameters:
pEnd
- value to set
-
withEnd
-
getSpectralResolution
public org.ivoa.dm.ivoa.RealQuantity getSpectralResolution()Returns spectralResolution Attribute- Returns:
- spectralResolution Attribute
-
setSpectralResolution
public void setSpectralResolution(org.ivoa.dm.ivoa.RealQuantity pSpectralResolution) Defines spectralResolution Attribute- Parameters:
pSpectralResolution
- value to set
-
withSpectralResolution
public SpectralWindowSetup withSpectralResolution(org.ivoa.dm.ivoa.RealQuantity pSpectralResolution) -
getIsSkyFrequency
Returns isSkyFrequency Attribute- Returns:
- isSkyFrequency Attribute
-
setIsSkyFrequency
Defines isSkyFrequency Attribute- Parameters:
pIsSkyFrequency
- value to set
-
withIsSkyFrequency
-
getPolarization
public org.ivoa.dm.stc.coords.PolStateEnum getPolarization()Returns polarization Attribute- Returns:
- polarization Attribute
-
setPolarization
public void setPolarization(org.ivoa.dm.stc.coords.PolStateEnum pPolarization) Defines polarization Attribute- Parameters:
pPolarization
- value to set
-
withPolarization
-
createSpectralWindowSetup
public static SpectralWindowSetup createSpectralWindowSetup(Consumer<SpectralWindowSetup.SpectralWindowSetupBuilder> f) create a SpectralWindowSetup in functional builder style.- Parameters:
f
- the functional builder.- Returns:
- an object initialized from the builder.
-
forceLoad
public void forceLoad()- Specified by:
forceLoad
in interfaceorg.ivoa.vodml.jpa.JPAManipulations
-
jpaClone
public void jpaClone(jakarta.persistence.EntityManager em) - Specified by:
jpaClone
in interfaceorg.ivoa.vodml.jpa.JPAManipulations
-
persistRefs
public void persistRefs(jakarta.persistence.EntityManager _em) - Specified by:
persistRefs
in interfaceorg.ivoa.vodml.jpa.JPAManipulations
-