Package org.ivoa.dm.adqlgeom

Class Circle

java.lang.Object
org.ivoa.dm.adqlgeom.Shape
org.ivoa.dm.adqlgeom.Circle
All Implemented Interfaces:
org.ivoa.vodml.jpa.JPAManipulations
@Embeddable @VoDml(id="adqlgeom:Circle", role=dataType) public class Circle extends Shape implements org.ivoa.vodml.jpa.JPAManipulations
a circular region on the sky. dataType: Circle

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    Circle.CircleBuilder
    A builder class for Circle, mainly for use in the functional builder pattern.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected org.javastro.ivoacore.pgsphere.types.Point
    center
    the centre of the circle.
    protected Double
    radius
    the radius of the circle.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Circle()
    Creates a new Circle
    Circle(Circle other)
    Copy Constructor.
    Circle(Shape superinstance, org.javastro.ivoacore.pgsphere.types.Point center, Double radius)
    Constructor from supertype instance.
    Circle(org.javastro.ivoacore.pgsphere.types.Point center, Double radius)
    full parameter constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    Shape
    copyMe()
    make a clone of the object taking into account current polymorhic type.
    static Circle
    createCircle(Consumer<Circle.CircleBuilder> f)
    create a Circle in functional builder style.
    boolean
    equals(Object o_)
     
    void
    forceLoad()
     
    org.javastro.ivoacore.pgsphere.types.Point
    getCenter()
    Returns center Attribute.
    Double
    getRadius()
    Returns radius Attribute.
    int
    hashCode()
     
    void
    setCenter(org.javastro.ivoacore.pgsphere.types.Point pCenter)
    Set center Attribute.
    void
    setRadius(Double pRadius)
    Set radius Attribute.
    void
    updateUsing(Circle other)
    Update this object with the content of the given object.
    Circle
    withCenter(org.javastro.ivoacore.pgsphere.types.Point pCenter)
    fluent setter for center Attribute.
    Circle
    withRadius(Double pRadius)
    fluent setter for radius Attribute.

    Methods inherited from class org.ivoa.dm.adqlgeom.Shape

    updateUsing

    Methods inherited from class java.lang.Object

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

  • Field Details

    • center

      @VoDml(id="adqlgeom:Circle.center", role=attribute, type="adqlgeom:Point", typeRole=dataType) protected org.javastro.ivoacore.pgsphere.types.Point center
      the centre of the circle. : Attribute center : multiplicity 1

    • radius

      @VoDml(id="adqlgeom:Circle.radius", role=attribute, type="ivoa:real", typeRole=primitiveType) protected Double radius
      the radius of the circle. : Attribute radius : multiplicity 1

  • Constructor Details

    • Circle

      public Circle()
      Creates a new Circle

    • Circle

      public Circle(org.javastro.ivoacore.pgsphere.types.Point center, Double radius)
      full parameter constructor.
      Parameters:
      center - the centre of the circle.
      radius - the radius of the circle.

    • Circle

      public Circle(Circle other)
      Copy Constructor. Note that references will remain as is rather than be copied.
      Parameters:
      other - the object to be copied.

    • Circle

      public Circle(Shape superinstance, org.javastro.ivoacore.pgsphere.types.Point center, Double radius)
      Constructor from supertype instance.
      Parameters:
      superinstance - The supertype.
      center - the centre of the circle.
      radius - the radius of the circle.

  • Method Details

    • copyMe

      public Shape copyMe()
      make a clone of the object taking into account current polymorhic type.
      Specified by:
      copyMe in class Shape
      Returns:
      the cloned object.

    • updateUsing

      public void updateUsing(Circle 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.

    • getCenter

      public org.javastro.ivoacore.pgsphere.types.Point getCenter()
      Returns center Attribute.
      Returns:
      center Attribute

    • setCenter

      public void setCenter(org.javastro.ivoacore.pgsphere.types.Point pCenter)
      Set center Attribute.
      Parameters:
      pCenter - value to set

    • withCenter

      public Circle withCenter(org.javastro.ivoacore.pgsphere.types.Point pCenter)
      fluent setter for center Attribute.
      Parameters:
      pCenter - value to set
      Returns:
      Circle

    • getRadius

      public Double getRadius()
      Returns radius Attribute.
      Returns:
      radius Attribute

    • setRadius

      public void setRadius(Double pRadius)
      Set radius Attribute.
      Parameters:
      pRadius - value to set

    • withRadius

      public Circle withRadius(Double pRadius)
      fluent setter for radius Attribute.
      Parameters:
      pRadius - value to set
      Returns:
      Circle

    • createCircle

      public static Circle createCircle(Consumer<Circle.CircleBuilder> f)
      create a Circle 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
      Overrides:
      forceLoad in class Shape

    • equals

      public boolean equals(Object o_)
      Overrides:
      equals in class Shape

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Shape