Package org.ivoa.dm.caom2

Class Target

java.lang.Object
org.ivoa.dm.caom2.Target
All Implemented Interfaces:
org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
@Entity @VoDml(id="caom2:Target", role=objectType) public class Target extends Object implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
the target of an observation. objectType: Target

  • Field Details

    • _id

      protected Long _id
      inserted database key

    • name

      @VoDml(id="caom2:Target.name", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String name
      proper name of the target. : Attribute name : multiplicity 1

    • targetID

      @VoDml(id="caom2:Target.targetID", role=attribute, type="ivoa:anyURI", typeRole=primitiveType) protected String targetID
      resolvable target identifier; the targetID URI should be of the form {scheme}:{id} so it can be resolved (for example: naif:170100) . : Attribute targetID : multiplicity 0..1

    • type

      @VoDml(id="caom2:Target.type", role=attribute, type="caom2:TargetType", typeRole=dataType) protected TargetType type
      type of target; typically used to figure out what the target name means and where to look for additional information about it. : Attribute type : multiplicity 0..1

    • redshift

      @VoDml(id="caom2:Target.redshift", role=attribute, type="ivoa:real", typeRole=primitiveType) protected Double redshift
      cosmological redshift of the target. : Attribute redshift : multiplicity 0..1

    • standard

      @VoDml(id="caom2:Target.standard", role=attribute, type="ivoa:boolean", typeRole=primitiveType) protected Boolean standard
      indicates that the target is typically used as a standard (astrometric, photometric, etc). : Attribute standard : multiplicity 0..1

    • moving

      @VoDml(id="caom2:Target.moving", role=attribute, type="ivoa:boolean", typeRole=primitiveType) protected Boolean moving
      indicates that the target is a moving object; used for solar system objects but not high proper motion stars. : Attribute moving : multiplicity 0..1

    • keywords

      @VoDml(id="caom2:Target.keywords", role=attribute, type="ivoa:string", typeRole=primitiveType) protected List<String> keywords
      additional keywords that describe the target; 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..*

  • Constructor Details

    • Target

      public Target()
      Creates a new Target

    • Target

      public Target(String name, String targetID, TargetType type, Double redshift, Boolean standard, Boolean moving, List<String> keywords)
      full parameter constructor.
      Parameters:
      name - proper name of the target.
      targetID - resolvable target identifier; the targetID URI should be of the form {scheme}:{id} so it can be resolved (for example: naif:170100) .
      type - type of target; typically used to figure out what the target name means and where to look for additional information about it.
      redshift - cosmological redshift of the target.
      standard - indicates that the target is typically used as a standard (astrometric, photometric, etc).
      moving - indicates that the target is a moving object; used for solar system objects but not high proper motion stars.
      keywords - additional keywords that describe the target; 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).

    • Target

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

    • getTargetID

      public String getTargetID()
      Returns targetID Attribute.
      Returns:
      targetID Attribute

    • setTargetID

      public void setTargetID(String pTargetID)
      Set targetID Attribute.
      Parameters:
      pTargetID - value to set

    • withTargetID

      public Target withTargetID(String pTargetID)
      fluent setter for targetID Attribute.
      Parameters:
      pTargetID - value to set
      Returns:
      Target

    • getType

      public TargetType getType()
      Returns type Attribute.
      Returns:
      type Attribute

    • setType

      public void setType(TargetType pType)
      Set type Attribute.
      Parameters:
      pType - value to set

    • withType

      public Target withType(TargetType pType)
      fluent setter for type Attribute.
      Parameters:
      pType - value to set
      Returns:
      Target

    • getRedshift

      public Double getRedshift()
      Returns redshift Attribute.
      Returns:
      redshift Attribute

    • setRedshift

      public void setRedshift(Double pRedshift)
      Set redshift Attribute.
      Parameters:
      pRedshift - value to set

    • withRedshift

      public Target withRedshift(Double pRedshift)
      fluent setter for redshift Attribute.
      Parameters:
      pRedshift - value to set
      Returns:
      Target

    • getStandard

      public Boolean getStandard()
      Returns standard Attribute.
      Returns:
      standard Attribute

    • setStandard

      public void setStandard(Boolean pStandard)
      Set standard Attribute.
      Parameters:
      pStandard - value to set

    • withStandard

      public Target withStandard(Boolean pStandard)
      fluent setter for standard Attribute.
      Parameters:
      pStandard - value to set
      Returns:
      Target

    • getMoving

      public Boolean getMoving()
      Returns moving Attribute.
      Returns:
      moving Attribute

    • setMoving

      public void setMoving(Boolean pMoving)
      Set moving Attribute.
      Parameters:
      pMoving - value to set

    • withMoving

      public Target withMoving(Boolean pMoving)
      fluent setter for moving Attribute.
      Parameters:
      pMoving - value to set
      Returns:
      Target

    • 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 Target withKeywords(List<String> pKeywords)
      fluent setter for keywords Attribute.
      Parameters:
      pKeywords - value to set
      Returns:
      Target

    • createTarget

      public static Target createTarget(Consumer<Target.TargetBuilder> f)
      create a Target 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>