Class Target.TargetBuilder

java.lang.Object
org.ivoa.dm.caom2.Target.TargetBuilder
Enclosing class:
Target

public static class Target.TargetBuilder extends Object
A builder class for Target, mainly for use in the functional builder pattern.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    additional keywords that describe the target; keywords cannot contain the pipe (|) character - it is reserved for use in persistence systems (e.g.
    indicates that the target is a moving object; used for solar system objects but not high proper motion stars.
    proper name of the target.
    cosmological redshift of the target.
    indicates that the target is typically used as a standard (astrometric, photometric, etc).
    resolvable target identifier; the targetID URI should be of the form {scheme}:{id} so it can be resolved (for example: naif:170100) .
    type of target; typically used to figure out what the target name means and where to look for additional information about it.
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    create a Target from this builder.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • name

      public String name
      proper name of the target.
    • targetID

      public String targetID
      resolvable target identifier; the targetID URI should be of the form {scheme}:{id} so it can be resolved (for example: naif:170100) .
    • type

      public TargetType type
      type of target; typically used to figure out what the target name means and where to look for additional information about it.
    • redshift

      public Double redshift
      cosmological redshift of the target.
    • standard

      public Boolean standard
      indicates that the target is typically used as a standard (astrometric, photometric, etc).
    • moving

      public Boolean moving
      indicates that the target is a moving object; used for solar system objects but not high proper motion stars.
    • keywords

      public 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).
  • Constructor Details

    • TargetBuilder

      public TargetBuilder()
  • Method Details

    • create

      public Target create()
      create a Target from this builder.
      Returns:
      an object initialized from the builder.