Package org.javastro.ivoa.entities.stc.v1

Class RedshiftFrameType

java.lang.Object

org.javastro.ivoa.entities.stc.v1.StcBaseType

org.javastro.ivoa.entities.stc.v1.CoordFrameType

org.javastro.ivoa.entities.stc.v1.RedshiftFrameType

All Implemented Interfaces:

org.jvnet.jaxb.lang.MergeFrom, org.jvnet.jaxb.lang.ToString

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public class RedshiftFrameType
extends CoordFrameType
implements org.jvnet.jaxb.lang.MergeFrom, org.jvnet.jaxb.lang.ToString

Contains the Doppler definitions, including whether the values are velocity or redshift (value_type)

Java class for redshiftFrameType complex type

.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="redshiftFrameType">
   <complexContent>
     <extension base="{http://www.ivoa.net/xml/STC/stc-v1.30.xsd}coordFrameType">
       <sequence>
         <element name="DopplerDefinition" type="{http://www.ivoa.net/xml/STC/stc-v1.30.xsd}dopplerDefinitionType"/>
         <element ref="{http://www.ivoa.net/xml/STC/stc-v1.30.xsd}ReferencePosition"/>
       </sequence>
       <attribute name="value_type" default="VELOCITY">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <enumeration value="VELOCITY"/>
             <enumeration value="REDSHIFT"/>
           </restriction>
         </simpleType>
       </attribute>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected DopplerDefinitionType	dopplerDefinition	The Doppler definition used: optical, radio, or pseudo-relativistic (i.e., how is a redshift converted to a velocity); the most common is optical, except when the reference is LSR (usually radio)
protected jakarta.xml.bind.JAXBElement<? extends ReferencePositionType>	referencePosition	The reference frame for the Doppler velocities or redshfts; note presence of LSR
protected String	valueType

Fields inherited from class org.javastro.ivoa.entities.stc.v1.CoordFrameType

name

Fields inherited from class org.javastro.ivoa.entities.stc.v1.StcBaseType

href, id, idref, idrefType, idType, type, ucd

Constructor Summary

Constructors

Constructor	Description
RedshiftFrameType()	Default no-arg constructor
RedshiftFrameType(String id, Object idref, String ucd, String type, String href, String idType, String idrefType, String name, DopplerDefinitionType dopplerDefinition, jakarta.xml.bind.JAXBElement<? extends ReferencePositionType> referencePosition, String valueType)	Fully-initialising value constructor

Method Summary

Modifier and Type	Method	Description
StringBuilder	append(org.jvnet.jaxb.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb.lang.ToStringStrategy strategy)
StringBuilder	appendFields(org.jvnet.jaxb.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb.lang.ToStringStrategy strategy)
Object	createNewInstance()
boolean	equals(Object object)
DopplerDefinitionType	getDopplerDefinition()	The Doppler definition used: optical, radio, or pseudo-relativistic (i.e., how is a redshift converted to a velocity); the most common is optical, except when the reference is LSR (usually radio)
jakarta.xml.bind.JAXBElement<? extends ReferencePositionType>	getReferencePosition()	The reference frame for the Doppler velocities or redshfts; note presence of LSR
String	getValueType()	Gets the value of the valueType property.
int	hashCode()
void	mergeFrom(Object left, Object right)
void	mergeFrom(org.jvnet.jaxb.locator.ObjectLocator leftLocator, org.jvnet.jaxb.locator.ObjectLocator rightLocator, Object left, Object right, org.jvnet.jaxb.lang.MergeStrategy strategy)
void	setDopplerDefinition(DopplerDefinitionType value)	Sets the value of the dopplerDefinition property.
void	setReferencePosition(jakarta.xml.bind.JAXBElement<? extends ReferencePositionType> value)	Sets the value of the referencePosition property.
void	setValueType(String value)	Sets the value of the valueType property.
String	toString()
RedshiftFrameType	withDopplerDefinition(DopplerDefinitionType value)
RedshiftFrameType	withHref(String value)
RedshiftFrameType	withId(String value)
RedshiftFrameType	withIdref(Object value)
RedshiftFrameType	withIDREFType(String value)
RedshiftFrameType	withIDType(String value)
RedshiftFrameType	withName(String value)
RedshiftFrameType	withReferencePosition(jakarta.xml.bind.JAXBElement<? extends ReferencePositionType> value)
RedshiftFrameType	withType(String value)
RedshiftFrameType	withUcd(String value)
RedshiftFrameType	withValueType(String value)

Methods inherited from class org.javastro.ivoa.entities.stc.v1.CoordFrameType

getName, setName

Methods inherited from class org.javastro.ivoa.entities.stc.v1.StcBaseType

getHref, getId, getIdref, getIDREFType, getIDType, getType, getUcd, setHref, setId, setIdref, setIDREFType, setIDType, setType, setUcd

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

dopplerDefinition

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
protected DopplerDefinitionType dopplerDefinition

The Doppler definition used: optical, radio, or pseudo-relativistic (i.e., how is a redshift converted to a velocity); the most common is optical, except when the reference is LSR (usually radio)

referencePosition

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
protected jakarta.xml.bind.JAXBElement<? extends ReferencePositionType> referencePosition

The reference frame for the Doppler velocities or redshfts; note presence of LSR

valueType

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
protected String valueType

Constructor Details

RedshiftFrameType

public RedshiftFrameType()

Default no-arg constructor

RedshiftFrameType

public RedshiftFrameType(String id,
 Object idref,
 String ucd,
 String type,
 String href,
 String idType,
 String idrefType,
 String name,
 DopplerDefinitionType dopplerDefinition,
 jakarta.xml.bind.JAXBElement<? extends ReferencePositionType> referencePosition,
 String valueType)

Fully-initialising value constructor

Method Details

getDopplerDefinition

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public DopplerDefinitionType getDopplerDefinition()

The Doppler definition used: optical, radio, or pseudo-relativistic (i.e., how is a redshift converted to a velocity); the most common is optical, except when the reference is LSR (usually radio)

Returns:

possible object is DopplerDefinitionType

setDopplerDefinition

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public void setDopplerDefinition(DopplerDefinitionType value)

Sets the value of the dopplerDefinition property.

Parameters:

value - allowed object is DopplerDefinitionType

See Also:

• getDopplerDefinition()

getReferencePosition

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public jakarta.xml.bind.JAXBElement<? extends ReferencePositionType> getReferencePosition()

The reference frame for the Doppler velocities or redshfts; note presence of LSR

Returns:

possible object is JAXBElement<CustomRefPosType> JAXBElement<ReferencePositionType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType>

setReferencePosition

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public void setReferencePosition(jakarta.xml.bind.JAXBElement<? extends ReferencePositionType> value)

Sets the value of the referencePosition property.

Parameters:

value - allowed object is JAXBElement<CustomRefPosType> JAXBElement<ReferencePositionType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType> JAXBElement<StdRefPosType>

See Also:

• getReferencePosition()

getValueType

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public String getValueType()

Gets the value of the valueType property.

Returns:

possible object is String

setValueType

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public void setValueType(String value)

Sets the value of the valueType property.

Parameters:

value - allowed object is String

equals

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public boolean equals(Object object)

Overrides:

equals in class CoordFrameType

hashCode

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public int hashCode()

Overrides:

hashCode in class CoordFrameType

toString

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public String toString()

Overrides:

toString in class CoordFrameType

append

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public StringBuilder append(org.jvnet.jaxb.locator.ObjectLocator locator,
 StringBuilder buffer,
 org.jvnet.jaxb.lang.ToStringStrategy strategy)

Specified by:

append in interface org.jvnet.jaxb.lang.ToString

Overrides:

append in class CoordFrameType

appendFields

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public StringBuilder appendFields(org.jvnet.jaxb.locator.ObjectLocator locator,
 StringBuilder buffer,
 org.jvnet.jaxb.lang.ToStringStrategy strategy)

Specified by:

appendFields in interface org.jvnet.jaxb.lang.ToString

Overrides:

appendFields in class CoordFrameType

withDopplerDefinition

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public RedshiftFrameType withDopplerDefinition(DopplerDefinitionType value)

withReferencePosition

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public RedshiftFrameType withReferencePosition(jakarta.xml.bind.JAXBElement<? extends ReferencePositionType> value)

withValueType

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public RedshiftFrameType withValueType(String value)

withName

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public RedshiftFrameType withName(String value)

Overrides:

withName in class CoordFrameType

withId

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public RedshiftFrameType withId(String value)

Overrides:

withId in class CoordFrameType

withIdref

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public RedshiftFrameType withIdref(Object value)

Overrides:

withIdref in class CoordFrameType

withUcd

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public RedshiftFrameType withUcd(String value)

Overrides:

withUcd in class CoordFrameType

withType

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public RedshiftFrameType withType(String value)

Overrides:

withType in class CoordFrameType

withHref

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public RedshiftFrameType withHref(String value)

Overrides:

withHref in class CoordFrameType

withIDType

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public RedshiftFrameType withIDType(String value)

Overrides:

withIDType in class CoordFrameType

withIDREFType

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public RedshiftFrameType withIDREFType(String value)

Overrides:

withIDREFType in class CoordFrameType

mergeFrom

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public void mergeFrom(Object left,
 Object right)

Specified by:

mergeFrom in interface org.jvnet.jaxb.lang.MergeFrom

Overrides:

mergeFrom in class CoordFrameType

mergeFrom

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public void mergeFrom(org.jvnet.jaxb.locator.ObjectLocator leftLocator,
 org.jvnet.jaxb.locator.ObjectLocator rightLocator,
 Object left,
 Object right,
 org.jvnet.jaxb.lang.MergeStrategy strategy)

Specified by:

mergeFrom in interface org.jvnet.jaxb.lang.MergeFrom

Overrides:

mergeFrom in class CoordFrameType

createNewInstance

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public Object createNewInstance()

Specified by:

createNewInstance in interface org.jvnet.jaxb.lang.MergeFrom

Overrides:

createNewInstance in class CoordFrameType